Asp.net MVC企业级开发（02）---Log4net

Posted 2021-12-19 mrfang

    Log4Net 是用来记录日志的，可以将程序运行过程中的信息输出到一些地方（文件、数据库、EventLog等）。日志就是程序的“黑匣子”,可以通过日志查看系统的运行过程，从而发现系统的问题。

    日志的作用就是将运行过程的步骤、成功失败记录下来，将关键性的数据记录下来分析系统问题所在。

    对于Web应用来说，不能把异常信息显示给用户，异常信息只能记录到日志，出了问题把日志文件发给开发人员就能知道问题所在。

 

2.1 配置 Log4Net 环境

    Log4Net 的配置步骤如下：

1. 引用 log4net.dll

新建项目，通过NuGet在项目中添加对log4net的引用。

 2. 配置

在web.config （或app.config）中添加配置。

在<configSection>中添加如下配置节点

<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>

紧靠</configSections> 后，添加如下配置信息：

<log4net>     <root>       <level value="ALL"/>       <appender-ref ref="SysAppender"/>     </root>     <logger name="WebLogger">       <!--这里进一步限制了日志级别，只有在大于等于DEBUG情况下才会记录日志-->       <level value="DEBUG"/>     </logger>     <!--指定日志记录的方式：以滚动文件的方式-->     <appender name="SysAppender" type="log4net.Appender.RollingFileAppender, log4net">       <!--指定日志存放的路径，这里放置到App_Data目录是为了安全-->       <param name="File" value="App_Data/Log/"/>       <!--日志以追加的形式记录-->       <param name="AppendToFile" value="true"/>       <param name="RollingStyle" value="Date"/>       <!--设置日志文件名称的生成规则-->       <param name="DatePattern" value="&quot;Logs_&quot;yyyyMMdd&quot;.txt&quot;"/>       <!--日志名称是否静态：否-->       <param name="StaticLogFileName" value="false"/>       <!--日志内容格式和布局设置-->       <layout type="log4net.Layout.PatternLayout,log4net">         <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n"/>         <param name="Header" value="-----------------header------------"/>         <param name="Footer" value="-----------------footer------------"/>       </layout>     </appender>     <appender name="consoleApp" type="log4net.Appender.ConsoleAppender,log4net">       <layout type="log4net.Layout.PatternLayout,log4net">         <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n"/>       </layout>     </appender>   </log4net>

3.初始化

    在程序最开始加入 log4net.Config.XmlConfigurator.Configure();（在Global.asax文件的Application_Start()方法中。

 

4. 记录日志

    在要打印日志的地方LogManager.GetLogger(typeof(Program)).Debug(“信息”);。通过LogManager.GetLogger传递要记录的日志类类名获得这个类的ILog（这样在日志文件中就能看到这条日志是哪个类输出的了），然后调用Debug方法输出消息。因为一个类内部不止一个地方要打印日志，所以一般把ILog声明为一个static字段。

 

Private static ILog logger=LogManager.GetLogger(typeof(Test))

 

    输出错误信息用ILog.Error方法，第二个参数可以传递Exception对象。 如log.Error("***错误"+ex)、log.Error("***错误",ex)。

    考虑到记录日志会存在并发问题，这里通过队列的方式记录日志。

    思路：把所有产生的日志信息存放到一个队列里，然后通过新建一个线程不断的从这个队列里面读取异常信息，然后往日志里面写。这也算是所谓的生产者-消费者模式。

 

5. 自定义异常过滤器

    新建一个类 MyExceptionAttribute，继承自全局异常类HandleErrorAttribute。代码如下所示。

public class MyExceptionAttribute : HandleErrorAttribute     // 此处的队列对象必须是静态的（全局的）     public static Queue<Exception> ExecptionQueue = new Queue<Exception>();     /// <summary>     /// 可以捕获异常数据     /// </summary>     /// <param name="filterContext"></param>     public override void OnException(ExceptionContext filterContext)             base.OnException(filterContext);         Exception ex = filterContext.Exception;         //写到队列         ExecptionQueue.Enqueue(ex);         //跳转到错误页面.         filterContext.HttpContext.Response.Redirect("/Error.html");

 

6. 修改FileConfig

    修改醒目 App_Start文件夹中的FileConfig.cs文件，调用MyExceptionAttribute。

public class FilterConfig     public static void RegisterGlobalFilters(GlobalFilterCollection filters)             //filters.Add(new HandleErrorAttribute()); //注释掉系统默认         filters.Add(new MyExceptionAttribute());

 

7. 多线程记录日志

    在Global.asax 文件中的Application_Start()方法中添加如下代码。

protected void Application_Start()     log4net.Config.XmlConfigurator.Configure();//读取Log4Net配置信息       AreaRegistration.RegisterAllAreas();     RouteConfig.RegisterRoutes(RouteTable.Routes);     RecordLog(); //记录日志 void RecordLog()     ThreadPool.QueueUserWorkItem((a) =>             while (true)                     //如果异常队列中有数据             if (MyExceptionAttribute.ExecptionQueue.Count > 0)                         //从队列中读取异常信息                 Exception ex = MyExceptionAttribute.ExecptionQueue.Dequeue() ;                 ILog logger = LogManager.GetLogger("errorMsg");                 logger.Error(ex.ToString()); //将异常写入Log4Net                         else                             //如果队列中没有数据，休息避免造成CPU的占用.                 Thread.Sleep(3000);                         );

 

    至此，Log4Net的配置全部完成，当系统出现异常时，项目根目录下的App_Data文件夹中会出现一个txt的日志文件 Logs_********.txt ，这个日志文件的名称是根据我们在配置文件中的规则生成的。

 

2.2 Log4Net 相关概念

    Log4Net 有3个主要组件： loggers,appenders 和 layouts。这3个组件一起工作使得开发者能够根据信息类型和等级（Level）记录信息，以及在运行时控制信息的格式化和信息的写入位置（如控制台、文件、内存、数据库等）。过滤器帮助这些组件控制追加器（appender）的行为和把对象转换成字符串的对象渲染。

 

• Appender：可以将日志输出到不同的地方，不同的输出目标对应不同的Appender， 如RollingFileAppender（滚动文件）、AdoNetAppender（数据库）、SmtpAppender （邮件）等。

 

• level（级别）：标识这条日志信息的重要级别。None>Fatal>ERROR>WARN>DEBUG>INFO>ALL，设定一个Level，那么低于这个Level的日志是不会被写到Appender中的。

 

• Log4Net还可以设定多个Appender，可以实现同时将日志记录到文件、数据、发送邮件等；可以设定不同的Appender的不同的Level，可以实现普通级别都记录到文件，Error以上级别发送邮件；可以实现对不同的类设定不同的Appender；还可以自定义Appender，这样可以自己实现将Error信息发短信等。

 

    日志框架除了Log4Net，还有Enterprise Library中的Logging Application Block、Apache的CommonLog 以及NLog等，都差不多。