NLog在Asp.Net MVC的实战应用

Asp.Net MVC FilterAttribute特性、读取xml反序列化、NLog实战系列文章

注：如果你理解了AOP,那么看这篇文章的第三部分可能更轻松点；

如果你理解了单例模式和反射原理, 那么看这篇文章的第二部分的第二小部分可能更轻松点；

首先新建一个MVC project。

一、NLog的配置。

作者：Jarosław Kowalski <[e-mail]>

翻译：CrazyCoder

原文：http://www.nlog-project.org/config.html

更多关于NLog的中文文章，请参考《NLog文章系列》。

（1）在当前project中引用NLog相关dll文件。

此时会发现project底下多了两个文件。可以自己新建一个Config文件夹，把这两个文件移进去。

(2)接下来就是根据自己个人需求配置NLog。

$1、到Web.Config添加以下配置。

 <configuration>
   <configSections>
     <section name="nlog" type="NLog.Config.ConfigSectionHandler, NLog" />
   </configSections>
   <nlog>
     <include file="${basedir}/Config/NLog.config" /><!--包含文件 此处配置为前面引用NLog时添加的NLog.config文件-->
   </nlog>
 </configuration>

$2、一个新添加的NLog.config是没有指定"输出目标“和"规则"的，所以我们自己添加targets和rules。

 <targets>
    <target name="toLogFile" xsi:type="File"
        archiveAboveSize="2097152"
        fileName="d:/LogFiles/NLogTest/${shortdate}.log"
        archiveFileName="d:/LogFiles/NLogTest/{#}.txt"
        archiveNumbering="DateAndSequence"
        archiveEvery="Day"
        maxArchiveFiles="90"
        archiveDateFormat="yyyy-MM-dd"
        layout="TimeStamp:${date} —${machinename} - ${message}"
                 />
     <wrapper-target xsi:type="AsyncWrapper" name="asyncFile">
       <target-ref name="toLogFile"/>
     </wrapper-target>
   </targets>

 <rules>
     <!-- add your logging rules here -->
     <logger name="*" minlevel ="Info" writeTo="asyncFile"></logger>
 </rules>

二、编写异常错误的处理代码。

$1、读取ErrorCode配置文件中数据。

 namespace NlogTest.Common
 {
     [XmlRoot("ErrorConfig")]
     public class ErrorCodeConfig
     {
         [XmlArray("ErrorCodes")]
         [XmlArrayItem("Error", typeof(ErrorCode))]
         public List<ErrorCode> ErrorCodes { get; set; }

         public static ErrorCodeConfig Config
         {
             get
             {
                 return XmlHelper.XmlToEntity<ErrorCodeConfig>("ErrorCode");
             }
         }

         public static ErrorCode GetError(string errorCode)
         {
             return Config.ErrorCodes.FirstOrDefault(e => e.Code == errorCode);
         }
     }

     public class ErrorCode
     {
         [XmlAttribute("code")]
         public string Code { get; set; }

         [XmlAttribute("msg")]
         public string Message { get; set; }

         [XmlAttribute("PartialPage")]
         public string PartialPage { get; set; }

         [XmlAttribute("level")]
         public string Level { get; set; }
     }
 }

xmlHelper类：

 namespace NlogTest.Common
 {
     public class XmlHelper
     {
         public static string GetXmlPath(string XmlName)
         {
             string filePath = string.Empty;
             filePath = System.Web.HttpContext.Current.Server.MapPath(string.Concat("", "~/Config/"+XmlName + ".Config"));

             return filePath;
         }

         public static List<T> XmlToEntityList<T>(string XmlName)
         {
             string xmlPath = GetXmlPath(XmlName);
             XmlSerializer serializer = new XmlSerializer(typeof(List<T>));
             Object obj = new Object();

             if (File.Exists(xmlPath))
             {
                 using (StreamReader reader = new StreamReader(xmlPath))
                 {
                     try
                     {
                         obj = serializer.Deserialize(reader);
                     }
                     catch (Exception ex)
                     {
                         //Here put your code witch dealing with exception
                     }
                 }
             }
             return (List<T>)obj;
         }

         public static T XmlToEntity<T>(string XmlName)
         {
             string xmlPath = GetXmlPath(XmlName);
             XmlSerializer serializer = new XmlSerializer(typeof(T));
             Object obj = new Object();

             if (File.Exists(xmlPath))
             {
                 using (StreamReader reader = new StreamReader(xmlPath))
                 {
                     try
                     {
                         obj = serializer.Deserialize(reader);
                     }
                     catch (Exception ex)
                     {
                         //Here put your code witch dealing with exception
                     }
                 }
             }
             return (T)obj;
         }
     }
 }

ErrorConfig文件：

 <?xml version="1.0" encoding="utf-8"?>
 <ErrorConfig>
   <ErrorCodes>

     <Error code="1000500" description="GeneralServiceError" msg="" PartialPage="ErrorPartial/GlobalError" level="Error"/>

   </ErrorCodes>
 </ErrorConfig>

$2、 封装一个Log处理异常错误的类库—LogUtil.

  public class LogUtil
     {
         private static object mutex = new object();

         private static Logger logger = LogManager.GetCurrentClassLogger();

         private static LogUtil _instance = null;

         public static LogUtil Instance
         {
             get
             {
                 if (_instance == null)
                 {
                     lock (mutex)
                     {
                         if (_instance == null)
                         {
                             _instance = new LogUtil();
                         }
                     }
                 }
                 return _instance;
             }
         }

         public static void Log(int errorCode, string message = null, Exception ex = null)
         {
             ErrorCode errObj = ErrorCodeConfig.GetError(errorCode.ToString());
             if (errObj == null)
             {
                 Instance.LogWarn("Error code " + errorCode + " has no definition.");
                 return;
             }

             StringBuilder msgBuilder = GenerateMessage(errorCode.ToString(), message, ex);

             string methodName = "Log" + errObj.Level;
             MethodInfo method = typeof(LogUtil).GetMethod(methodName);
             if (method == null)
             {
                 Instance.LogWarn("log level wrong,please check ErrorCode.Config.level name is " + errObj.Level);
                 return;
             }
             method.Invoke(Instance, new object[] { msgBuilder.ToString() });

         }

         public static void LogDebug(string message)
         {
             logger.Log(LogLevel.Debug, message);
         }

         public static void LogError(string message)
         {
             logger.Log(LogLevel.Error, message);
         }

         public void LogErrorException(Exception ex)
         {
             LogException(LogLevel.Error, ex);
         }

         public void LogFatalException(Exception ex)
         {
             LogException(LogLevel.Fatal, ex);
         }

         public void LogFatal(string message)
         {
             logger.Log(LogLevel.Fatal, message);
         }

         public static void LogInfo(string message)
         {
             logger.Log(LogLevel.Info, message);
         }

         public void LogOff(string message)
         {
             logger.Log(LogLevel.Off, message);
         }

         public void LogTrace(string message)
         {
             logger.Log(LogLevel.Trace, message);
         }

         public void LogWarn(string message)
         {
             logger.Log(LogLevel.Warn, message);
         }

         private static void LogException(LogLevel level, Exception ex)
         {
             logger.Log(level, GetExceptionMessage(ex));
         }

         private static string GetExceptionMessage(Exception ex)
         {
             string message = ex.Message;
             string stackTrace = ex.StackTrace;
             if (string.IsNullOrEmpty(stackTrace) && ex.InnerException != null)
             {
                 stackTrace = ex.InnerException.StackTrace;
             }
             return message + "::" + stackTrace;
         }

         private static StringBuilder GenerateMessage(string errorCode, string message, Exception ex)
         {
             StringBuilder msgBuilder = new StringBuilder();
             msgBuilder.Append("ErrorCode is " + errorCode);
             msgBuilder.Append("\r\n");
             if (!string.IsNullOrEmpty(message))
             {
                 msgBuilder.Append(message);
                 msgBuilder.Append("\r\n");
             }
             if (ex != null)
             {
                 msgBuilder.Append(GetExceptionMessage(ex));
                 msgBuilder.Append("\r\n");
             }
             return msgBuilder;
         }
     }

三、将LogUtil与MVC衔接上，该MVC中的FilterAttribute、IExceptionFilter出场了。

$1、定义个ErrorFilterAttribute继承FilterAttribute、IExceptionFilter。

 namespace NlogTest.FrameWork
 {
     public class ErrorFilterAttribute:FilterAttribute,IExceptionFilter
     {
         private const int commonError = ;

         public void OnException(ExceptionContext filterContext)
         {
             int errorCode = commonError;
             Exception exception = filterContext.Exception;

             if (exception is ErrorCodeException)
             {
                 errorCode = ((ErrorCodeException)exception).ErrorCode;
             }
             string message = "Error";
             LogUtil.Log(errorCode,ex:exception,message:message);
         }
     }
 }

$2、将ErrorFilterAttribute注册到App_Start底下的FilterConfig中，这样做的目的是利用MVC中过滤器对全局的controller进行处理。简而言之，比如任意一个controller中action抛出异常错误，这里都会检测到并作为日志记录的接口开始对这些异常错误进行记录。

  public class FilterConfig
     {
         public static void RegisterGlobalFilters(GlobalFilterCollection filters)
         {
             //filters.Add(new HandleErrorAttribute());
             filters.Add(new ErrorFilterAttribute());
         }
     }

2016-12-26

测试效果：

在HomeController中写一段会发生错误的代码：

到在输出目标位置中找对应log文件：

激动的时刻到来了

PS:至此整个Demo算是完成了，快过年了，公司也没啥事，自己捣鼓点东西，基础比较差，就当练手。经过这次，我明白了一件事，平时多积累点小知识点，可以汇集起来再实现一个小功能，新旧知识结合，挺好。