Log4Net日志详解

一. Log4Net简介

  Log4net是从Java中的Log4j迁移过来的一个.Net版的开源日志框架,它的功能很强大,可以将日志分为不同的等级,以不同的格式输出到不同的存储介质中,比如:数据库、txt文件、内存缓冲区、邮件、控制台、ANSI终端、远程接收端等等,我们这里主要介绍最常用的两种:txt文件和数据库。

(PS:其它的存储介质详见 http://logging.apache.org/log4net/release/config-examples.html)

  Log4net将日志分为五个级别,分别是: FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息),每个级别都对应着一组重载方法进行调用。

  官网地址:http://logging.apache.org/log4net/index.html

  Nuget地址:https://www.nuget.org/packages/log4net/

  Nuget安装:Install-Package log4net

  最新版本:2.0.8 (2018-08-09)

   本节主要围绕两个主要的存储介质:【txt文件】和【SQLServer数据库】展开,涵盖的知识点有:

    ①. 基本的使用步骤。

    ②. 初始化关联配置文件的几种形式。

    ③. 代码调用详解。

    ④. 配置文件详解。

    ⑤. 简单的封装和在MVC框架中的调用。 

二. 基本使用步骤

   我们先以控制台程序为例,简单介绍Log4net存储日志到txt文本文档中,后面在做代码的详解。

1. 新建01-SimpleDemo控制台程序,通过指令 【Install-Package log4net】安装相应程序集。

2.  在默认配置文件中App.config(B/S程序则为web.config)中进行配置,主要分两块:

  A. 在<configuration></configuration>节点下新增节点下新增(要在其最顶部):

    <configSections>
      <section name = "log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
    </configSections>
  B. 在<configuration></configuration>根节点下,配置log4net的核心配置代码, 主要节点如下:
    <log4net> <appender> </appender> <root></root> </log4net>

详细代码如下:

 1 <?xml version="1.0" encoding="utf-8" ?>
 2 <configuration>
 3   <!-- 1. 添加log4net的节点声明配置代码-->
 4   <configSections>
 5     <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
 6   </configSections>
 7   <!--2. log4net的核心配置代码-->
 8   <log4net>   
 9     <!--把日志信息输出到以日期命名的文件里-->
10     <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
11       <!--文件夹的位置-->
12       <file value="D:\MyLog1\" />
13       <appendToFile value="true" />
14       <!--动态生成文件名-->
15       <param name="StaticLogFileName" value="false" />
16       <!--以日期命名-->
17       <param name="DatePattern" value="yyyyMMdd&quot;.log&quot;" />
18       <rollingStyle value="Date" />
19       <!--日志在日志文件中的布局方式-->
20       <layout type="log4net.Layout.PatternLayout">
21         <conversionPattern value="%newline %n记录时间:%date %n线程ID:[%thread] %n日志级别:  %-5level %n出错类:%logger property: [%property{NDC}] - %n错误描述:%message%newline %n"/>
22       </layout>
23       <!--使用最小锁定模型(minimal locking model),以允许多个进程可以写入同一个文件 -->
24       <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
25     </appender> 
26     <root>
27       <level value="ALL"></level>
28       <appender-ref ref="RollingFileAppender"></appender-ref>
29     </root> 
30   </log4net>
31   <startup>
32     <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6" />
33   </startup>
34 </configuration>
View Code

3. 代码调用

1 log4net.Config.XmlConfigurator.Configure();
2 ILog log = LogManager.GetLogger("test");
3 log.Debug("调试信息");

4. 运行结果

截止此处,日志保存成功。

 

三. 初始化配置文件

  前面提到在默认配置文件中App.config(B/S程序则为web.config)中进行配置,可以通过代码  log4net.Config.XmlConfigurator.Configure(); 来初始化配置,或者还可以通过 [assembly: log4net.Config.XmlConfigurator()]  反射的形式进行初始化配置,二者可以达到同样的效果,代表了两种初始化配置文件的形式。

  PS: [assembly: log4net.Config.XmlConfigurator()]  可以加在 当前使用文件的 namespace上作用于当前文件,或者加在Properties/AssemblyInfo.cs中,则该项目全局都无须再初始化了。

 

  在实际项目中,默认的配置文件里可能包含很多框架的信息,这个时候把 log4net的配置代码再放入进去,就会显得有点杂乱,或者有些“奇葩”的人把默认配置文件改名了,这个时候使用上述默认的两种方式就不好用了,那么这种情况怎么处理呢?
  这里重点介绍 通过 log4net.Config.XmlConfigurator.Configure(); 来关联配置文件。

情况一: 使用默认配置文件的情况

  1. 代码配置:log4net.Config.XmlConfigurator.Configure();

  2. 反射配置:[assembly: log4net.Config.XmlConfigurator()] 

 

情况二:修改默认配置文件的名称为:App1.config (这里只是举例,很少有修改默认配置文件名称的)

  1. 代码配置: 首先将App1.config文件的属性中的“生成操作”改为“ 嵌入的资源”,然后通过以下代码进行配置。

1 Assembly assembly = Assembly.GetExecutingAssembly();
2 var xml = assembly.GetManifestResourceStream("_01_SimpleDemo.App1.config");
3 log4net.Config.XmlConfigurator.Configure(xml);

  注:代码中的 _01_SimpleDemo 为命名空间名。

  2. 反射配置:[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.xml")]     

  注:用这种方式属性中的:复制到输出目录需要改为:始终复制,生成操作不需要配置,使用默认:无  即可

 

情况三:新建单独xml文件,进行log4net的配置 (推荐采用这种方式,和原配置文件区分开,单独配置方便,处理方式和情况二是一致的)

  1. 代码配置:首先将log4net.xml文件的属性中的“生成操作”改为“ 嵌入的资源”,然后通过以下代码进行配置。

1 Assembly assembly = Assembly.GetExecutingAssembly();
2 var xml = assembly.GetManifestResourceStream("_01_SimpleDemo.log4net.xml");
3 log4net.Config.XmlConfigurator.Configure(xml);

  注:代码中的 _01_SimpleDemo 为命名空间名。

 

情况四:无论是修改默认配置文件的名称为 或者 新建单独的xml作为配置文件 → 可以通过绝对路径的方式进行处理 【不推荐这种方式】

  1. 直接写绝对路径 (注意这种方式【不需要】配置文件属性为 “嵌入的资源”)

1 log4net.Config.XmlConfigurator.Configure(new FileInfo(@"D:\06-我的开发之路\DotNet体系\05-DotNet框架篇\03-Log4net详解\Code\01-SimpleDemo\log4net.xml"));

  2 通过代码获取绝对路径 (注意这种方式【不需要】配置文件属性的“生成操作”改为 “嵌入的资源”,但需要改为“始终复制”,确保输出到bin文件下)

1 string assemblyFilePath = Assembly.GetExecutingAssembly().Location;
2 string assemblyDirPath = Path.GetDirectoryName(assemblyFilePath);
3 string configFilePath = assemblyDirPath + " //log4net.xml";
4 log4net.Config.XmlConfigurator.Configure(new FileInfo(configFilePath));

PS:B/S程序下通过  log4net.Config.XmlConfigurator.Configure(new FileInfo(Server.MapPath("~") + @"/log4net.xml")); 来配置。

 

四. 代码调用详解

  Log4net允许多个ILog对象同时存在,通过代码:ILog log = LogManager.GetLogger("xxx"); 来创建。

  A: 日志级别由高到低分别为:FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息),另外还有 OFF和 ALL 。

  几点说明:OFF表示所有信息都不写入,ALL表示所有信息都写入,我们也可以通过:<root><level value = "WARN" ></ level ></root>这样配置,表示WARN级别以及高于WARN以上的级别才会被写入日志

  B: 写入日志的方法有:Debug、Error、Fatal、Info、Warn五个方法,每个方法都有两个重载,如下图:

分享在使用配置文件为log4net.xml的情况下的调用代码:

复制代码
 1   Assembly assembly = Assembly.GetExecutingAssembly();
 2   var xml = assembly.GetManifestResourceStream("_01_SimpleDemo.log4net.xml");
 3   log4net.Config.XmlConfigurator.Configure(xml);
 4   ILog log = LogManager.GetLogger("test");
 5   log.Debug("调试信息");
 6   log.Info("一般信息");
 7   log.Warn("警告");
 8   try
 9   {
10      int.Parse("ddd");
11   }
12   catch (Exception ex)
13   {
14       log.Error("一般错误", ex);
15   }
16   log.Fatal("致命错误");
复制代码

 

五. 配置文件详解

  Log4net的配置文件主要分为两大部分:分别是 【自定义配置节点】和 【核心代码配置】,自定义配置节点代码固定,如下图,核心代码配置主要位于:<log4net></log4net>节点中,里面包括<appender></appender>节点配置日日志输出途径 和 <root></root>节点,用于设置记录日志的级别和启用哪些输出途径。  

几点说明:

1.  自定义配置节点  <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" /> 代码固定,直接复制即可。

2.  <root></root> 节点主要用来: 配置日志的的输出级别和加载日志的输出途径。

  A: level中的value值表示该值及其以上的日志级别才会输出,日志级别包括:OFF > FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息) > ALL ,比如:

    <level value="INFO"></level> 表示只有INFO及其以上的日志级别才会被保存。

  PS:OFF表示所有信息都不写入,ALL表示所有信息都写入。

  B: <appender-ref></appender-ref>标签用于加载日志的输出途径代码,通过ref和appender标签的中name属性相关联,比如:

    <appender-ref ref="RollingFileAppender"></appender-ref>  表示开启txt文档保存日志的方式。

3. <appender></appender>节点,用来配置日志的输出途径的,本节主要介绍了输出到 【txt文本文档】中 和 【数据库】。

 A:分享一下数据库的表结构,详细配置见下面的代码分享,需要注意字段类型相匹配,并且要显式指定其长度。

 

  B:关于txt文本文档的命名,可以存放到一个文件夹里,也可以按照时间来区分文件夹,并且命名可以 动态+指定命名的方式。

  C:关于日志文件大小的说明和文件个数的说明,主要需要三个节点配合使用(实际开发中,如果一个txt特别大,打开的时候会非常的慢,卡顿,所以该步骤有必要配置一下)。

  PS:首先要配置 RollingStyle 节点为Size模式或者Composite模式,然后配置 maximumFileSize 节点设置每个文件的大小,最后配置 MaxSizeRollBackups 节点,设置日志文件的个数。超出大小后在所有文件名后自动增加正整数重新命名,数字最大的最早写入。

  用下面的代码简单测试一下:

1 <param name="RollingStyle" value="Composite" />
2 <param name="maximumFileSize" value="10KB" />
3 <param name="MaxSizeRollBackups" value="5" />
  
 
详细代码如下:
复制代码
  1 <?xml version="1.0" encoding="utf-8" ?>
  2 <configuration>
  3   <!-- 一. 添加log4net的自定义配置节点-->
  4   <configSections>
  5     <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
  6   </configSections>
  7   <!--二. log4net的核心配置代码-->
  8   <log4net>
  9     <!--(一) 配置日志的输出途径-->
 10     <!--1. 输出途径(一) 将日志以回滚文件的形式写到文件中-->
 11     <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
 12       <!--1.1 文件夹的位置(也可以写相对路径)-->
 13       <param name="File"  value="D:\MyLog1\" />
 14       <!--相对路径  C/S程序生成在Debug目录下-->
 15       <!--<param name="File"  value="/Logs/" />-->
 16       <!--1.2 是否追加到文件-->
 17       <param name="AppendToFile" value="true" />
 18       <!--1.3 使用最小锁定模型(minimal locking model),以允许多个进程可以写入同一个文件 -->
 19       <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
 20       <!--1.4 配置Unicode编码-->
 21       <Encoding value="UTF-8" />
 22       <!--1.5 是否只写到一个文件里-->
 23       <param name="StaticLogFileName" value="false" />
 24       <!--1.6 配置按照何种方式产生多个日志文件 (Date:日期、Size:文件大小、Composite:日期和文件大小的混合方式)-->
 25       <param name="RollingStyle" value="Composite" />
 26       <!--1.7 介绍多种日志的的命名和存放在磁盘的形式-->
 27       <!--1.7.1 在根目录下直接以日期命名txt文件 注意&quot;的位置,去空格 -->
 28       <param name="DatePattern" value="yyyy-MM-dd&quot;.log&quot;" />
 29       <!--1.7.2 在根目录下按日期产生文件夹,文件名固定 test.log  -->
 30       <!--<param name="DatePattern" value="yyyy-MM-dd/&quot;test.log&quot;"  />-->
 31       <!--1.7.3 在根目录下按日期产生文件夹,这是按日期产生文件夹,并在文件名前也加上日期  -->
 32       <!--<param name="DatePattern" value="yyyyMMdd/yyyyMMdd&quot;-test.log&quot;"  />-->
 33       <!--1.7.4 在根目录下按日期产生文件夹,这再形成下一级固定的文件夹  -->
 34       <!--<param name="DatePattern" value="yyyyMMdd/&quot;OrderInfor/test.log&quot;"  />-->
 35       <!--1.8 配置每个日志的大小。【只在1.6 RollingStyle 选择混合方式与文件大小方式下才起作用!!!】可用的单位:KB|MB|GB。不要使用小数,否则会一直写入当前日志,
 36       超出大小后在所有文件名后自动增加正整数重新命名,数字最大的最早写入。-->
 37       <param name="maximumFileSize" value="10MB" />
 38       <!--1.9 最多产生的日志文件个数,超过则保留最新的n个 将value的值设置-1,则不限文件个数 【只在1.6 RollingStyle 选择混合方式与文件大小方式下才起作用!!!】
 39         与1.8中maximumFileSize文件大小是配合使用的-->
 40       <param name="MaxSizeRollBackups" value="5" />
 41       <!--1.10 配置文件文件的布局格式,使用PatternLayout,自定义布局-->
 42       <layout type="log4net.Layout.PatternLayout">
 43         <conversionPattern value="记录时间:%date %n线程ID:[%thread] %n日志级别:%-5level %n出错类:%logger property: [%property{NDC}] - %n错误描述:%message%newline %n%newline"/>
 44       </layout>
 45     </appender>
 46 
 47     <!--2. 输出途径(二) 记录日志到数据库-->
 48     <appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppender">
 49       <!--2.1 设置缓冲区大小,只有日志记录超设定值才会一块写入到数据库-->
 50       <param name="BufferSize" value="1" />
 51       <!--2.2 引用-->
 52       <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
 53       <!--2.3 数据库连接字符串-->
 54       <connectionString value="data source=localhost;initial catalog=LogDB;integrated security=false;persist security info=True;User ID=sa;Password=123456" />
 55       <!--2.4 SQL语句插入到指定表-->
 56       <commandText value="INSERT INTO LogInfor ([threadId],[log_level],[log_name],[log_msg],[log_exception],[log_time]) VALUES (@threadId, @log_level, @log_name, @log_msg, @log_exception,@log_time)" />
 57       <!--2.5 数据库字段匹配-->
 58       <!-- 线程号-->
 59       <parameter>
 60         <parameterName value="@threadId" />
 61         <dbType value="String" />
 62         <size value="100" />
 63         <layout type="log4net.Layout.PatternLayout">
 64           <conversionPattern value="%thread" />
 65         </layout>
 66       </parameter>
 67       <!--日志级别-->
 68       <parameter>
 69         <parameterName value="@log_level" />
 70         <dbType value="String" />
 71         <size value="100" />
 72         <layout type="log4net.Layout.PatternLayout">
 73           <conversionPattern value="%level" />
 74         </layout>
 75       </parameter>
 76       <!--日志记录类名称-->
 77       <parameter>
 78         <parameterName value="@log_name" />
 79         <dbType value="String" />
 80         <size value="100" />
 81         <layout type="log4net.Layout.PatternLayout">
 82           <conversionPattern value="%logger" />
 83         </layout>
 84       </parameter>
 85       <!--日志信息-->
 86       <parameter>
 87         <parameterName value="@log_msg" />
 88         <dbType value="String" />
 89         <size value="5000" />
 90         <layout type="log4net.Layout.PatternLayout">
 91           <conversionPattern value="%message" />
 92         </layout>
 93       </parameter>
 94       <!--异常信息  指的是如Infor 方法的第二个参数的值-->
 95       <parameter>
 96         <parameterName value="@log_exception" />
 97         <dbType value="String" />
 98         <size value="2000" />
 99         <layout type="log4net.Layout.ExceptionLayout" />
100       </parameter>
101       <!-- 日志记录时间-->
102       <parameter>
103         <parameterName value="@log_time" />
104         <dbType value="DateTime" />
105         <layout type="log4net.Layout.RawTimeStampLayout" />
106       </parameter>
107     </appender>
108     <!--(二). 配置日志的的输出级别和加载日志的输出途径-->
109     <root>
110       <!--1. level中的value值表示该值及其以上的日志级别才会输出-->
111       <!--OFF > FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息)  > ALL  -->
112       <!--OFF表示所有信息都不写入,ALL表示所有信息都写入-->
113       <level value="ALL"></level>
114       <!--2. append-ref标签表示要加载前面的日志输出途径代码  通过ref和appender标签的中name属性相关联-->
115       <appender-ref ref="RollingFileAppender"></appender-ref>
116       <appender-ref ref="AdoNetAppender"></appender-ref>
117     </root>
118   </log4net>
119 
120 </configuration>
复制代码

 

六. 简单的封装及完整代码分享

   这里模拟在系统框架中对Log4net进行简单的封装,然后在MVC框架中调用,并分享全部代码。

  步骤一:新建Ypf.Utils类库,作为工具类库,引入log4net程序集,并将前面用到的log4net.xml 复制进来,改属性为嵌入资源,然后新建LogUtils类(不要起名为LogHelp),对Log4net的方法进行简单的封装,主要包括:初始化代码、ILog实例创建、五类日志级别的封装。

  特别注意:这种封装会带来一个问题,会导致输出的文件中出错类永远显示的为LogUtils这个封装类,这里采用StackTrace类进行迂回处理一下,就可以定位到具体的出错位置了,如下图:

 log4net.xml文件代码如下:

View Code

LogUtils类代码如下

  1 using log4net;
  2 using System;
  3 using System.Collections.Generic;
  4 using System.Diagnostics;
  5 using System.Linq;
  6 using System.Reflection;
  7 using System.Text;
  8 using System.Threading.Tasks;
  9 
 10 namespace Ypf.Utils
 11 {
 12     public class LogUtils
 13     {
 14         //可以声明多个日志对象
 15         public static ILog log = LogManager.GetLogger(typeof(LogUtils));
 16 
 17         #region 01-初始化Log4net的配置
 18         /// <summary>
 19         /// 初始化Log4net的配置
 20         /// xml文件一定要改为嵌入的资源
 21         /// </summary>
 22         public static void InitLog4Net()
 23         {
 24             Assembly assembly = Assembly.GetExecutingAssembly();
 25             var xml = assembly.GetManifestResourceStream("Ypf.Utils.log4net.xml");
 26             log4net.Config.XmlConfigurator.Configure(xml);
 27         }
 28         #endregion
 29 
 30 
 31 
 32 
 33         /************************* 五种不同日志级别 *******************************/
 34         //FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息)
 35 
 36         /// <summary>
 37         /// 将调试的信息输出,可以定位到具体的位置(解决高层封装带来的问题)
 38         /// </summary>
 39         /// <returns></returns>
 40         private static string getDebugInfo()
 41         {
 42             StackTrace trace = new StackTrace(true);
 43             return trace.ToString();
 44         }
 45 
 46         #region 01-DEBUG(调试信息)
 47         /// <summary>
 48         /// Debug
 49         /// </summary>
 50         /// <param name="msg">日志信息</param>
 51         public static void Debug(string msg)
 52         {
 53             log.Debug(getDebugInfo() + msg);
 54         }
 55         /// <summary>
 56         /// Debug
 57         /// </summary>
 58         /// <param name="msg">日志信息</param>
 59         /// <param name="exception">错误信息</param>
 60         public static void Debug(string msg, Exception exception)
 61         {
 62             log.Debug(getDebugInfo() + msg, exception);
 63         }
 64 
 65         #endregion
 66 
 67         #region 02-INFO(一般信息)
 68         /// <summary>
 69         /// Info
 70         /// </summary>
 71         /// <param name="msg">日志信息</param>
 72         public static void Info(string msg)
 73         {
 74             log.Info(getDebugInfo() + msg);
 75         }
 76         /// <summary>
 77         /// Info
 78         /// </summary>
 79         /// <param name="msg">日志信息</param>
 80         /// <param name="exception">错误信息</param>
 81         public static void Info(string msg, Exception exception)
 82         {
 83             log.Info(getDebugInfo() + msg, exception);
 84         }
 85         #endregion
 86 
 87         #region 03-WARN(警告)
 88         /// <summary>
 89         /// Warn
 90         /// </summary>
 91         /// <param name="msg">日志信息</param>
 92         public static void Warn(string msg)
 93         {
 94             log.Warn(getDebugInfo() + msg);
 95         }
 96         /// <summary>
 97         /// Warn
 98         /// </summary>
 99         /// <param name="msg">日志信息</param>
100         /// <param name="exception">错误信息</param>
101         public static void Warn(string msg, Exception exception)
102         {
103             log.Warn(getDebugInfo() + msg, exception);
104         }
105         #endregion
106 
107         #region 04-ERROR(一般错误)
108         /// <summary>
109         /// Error
110         /// </summary>
111         /// <param name="msg">日志信息</param>
112         public static void Error(string msg)
113         {
114             log.Error(getDebugInfo() + msg);
115         }
116         /// <summary>
117         /// Error
118         /// </summary>
119         /// <param name="msg">日志信息</param>
120         /// <param name="exception">错误信息</param>
121         public static void Error(string msg, Exception exception)
122         {
123             log.Error(getDebugInfo() + msg, exception);
124         }
125         #endregion
126 
127         #region 05-FATAL(致命错误)
128         /// <summary>
129         /// Fatal
130         /// </summary>
131         /// <param name="msg">日志信息</param>
132         public static void Fatal(string msg)
133         {
134             log.Fatal(getDebugInfo() + msg);
135         }
136         /// <summary>
137         /// Fatal
138         /// </summary>
139         /// <param name="msg">日志信息</param>
140         /// <param name="exception">错误信息</param>
141         public static void Fatal(string msg, Exception exception)
142         {
143             log.Fatal(getDebugInfo() + msg, exception);
144         }
145 
146         #endregion
147 
148 
149 
150     }
151 }
View Code

步骤二:新建名Ypf.MVC的MVC5框架,添加对Ypf.Utils类库的引用,在Global.asax全局文件中添加对 对Log4net进行初始化。

  然后就可以愉快的进行调用测试了哦。

 1  /// <summary>
 2         /// 测试log4net
 3         /// 首先需要再Global中初始化log4net
 4         /// </summary>
 5         /// <returns></returns>
 6         public ActionResult Index()
 7         {
 8             //FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息)
 9             LogUtils.Debug("出错了");
10             try
11             {
12                 int.Parse("ddf");
13             }
14             catch (Exception ex)
15             {
16                 LogUtils.Debug("出错了",ex);
17             }
18 
19             LogUtils.Info("出错了");
20             try
21             {
22                 int.Parse("ddf");
23             }
24             catch (Exception ex)
25             {
26                 LogUtils.Info("出错了", ex);
27             }
28 
29             LogUtils.Warn("出错了");
30             try
31             {
32                 int.Parse("ddf");
33             }
34             catch (Exception ex)
35             {
36                 LogUtils.Warn("出错了", ex);
37             }
38 
39             LogUtils.Error("出错了");
40             try
41             {
42                 int.Parse("ddf");
43             }
44             catch (Exception ex)
45             {
46                 LogUtils.Error("出错了", ex);
47             }
48 
49             LogUtils.Fatal("出错了");
50             try
51             {
52                 int.Parse("ddf");
53             }
54             catch (Exception ex)
55             {
56                 LogUtils.Fatal("出错了", ex);
57             }
58 
59             return View();
60         }
View Code

 

七. 补充:分文件存放

   在前面的介绍中,忽略了一种情况,各种类型的日志(操作日志也好,错误日志也好)都存放在一个txt文档里,在实际开发中很不方便,在这里介绍一种利用Log4net过滤器实现不同日志分文件夹存放的功能。

几种过滤器,可以用来过滤掉Appender中的内容:

  DenyAllFilter: 阻止所有的日志事件被记录

  LevelMatchFilter: 只有指定等级的日志事件才被记录

  LevelRangeFilter :日志等级在指定范围内的事件才被记录

  LoggerMatchFilter: 与Logger名称匹配,才记录

  PropertyFilter: 消息匹配指定的属性值时才被记录

  StringMathFilter: 消息匹配指定的字符串才被记录

 分文件夹存放的核心所在:

①. 配置文件的调整:利用LoggerMatchFilter和DenyAllFilter过滤器实现分文件存放。

 

②:声明ILog对象的时候,需要与LoggerMatchFilter过滤器中的Value值相对应,才能保证该ILog对象记录的日志存放到该Appender节点对应的路径下。

③. 高层调用:

 

分享一下log4net的配置文件和LogUtils的封装文件。

  1 <?xml version="1.0" encoding="utf-8" ?>
  2 <configuration>
  3   <!-- 一. 添加log4net的自定义配置节点-->
  4   <configSections>
  5     <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
  6   </configSections>
  7   <!--二. log4net的核心配置代码-->
  8   <log4net>
  9     <!--1. 输出途径(一) 将日志以回滚文件的形式写到文件中-->
 10     
 11     <!--模式一:全部存放到一个文件夹里-->
 12     <appender name="log0" type="log4net.Appender.RollingFileAppender">
 13       <!--1.1 文件夹的位置(也可以写相对路径)-->
 14       <param name="File"  value="D:\MyLog\" />
 15       <!--相对路径-->
 16       <!--<param name="File"  value="Logs/" />-->
 17       <!--1.2 是否追加到文件-->
 18       <param name="AppendToFile" value="true" />
 19       <!--1.3 使用最小锁定模型(minimal locking model),以允许多个进程可以写入同一个文件 -->
 20       <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
 21       <!--1.4 配置Unicode编码-->
 22       <Encoding value="UTF-8" />
 23       <!--1.5 是否只写到一个文件里-->
 24       <param name="StaticLogFileName" value="false" />
 25       <!--1.6 配置按照何种方式产生多个日志文件 (Date:日期、Size:文件大小、Composite:日期和文件大小的混合方式)-->
 26       <param name="RollingStyle" value="Composite" />
 27       <!--1.7 介绍多种日志的的命名和存放在磁盘的形式-->
 28       <!--1.7.1 在根目录下直接以日期命名txt文件 注意&quot;的位置,去空格 -->
 29       <param name="DatePattern" value="yyyy-MM-dd&quot;.log&quot;" />
 30       <!--1.7.2 在根目录下按日期产生文件夹,文件名固定 test.log  -->
 31       <!--<param name="DatePattern" value="yyyy-MM-dd/&quot;test.log&quot;"  />-->
 32       <!--1.7.3 在根目录下按日期产生文件夹,这是按日期产生文件夹,并在文件名前也加上日期  -->
 33       <!--<param name="DatePattern" value="yyyyMMdd/yyyyMMdd&quot;-test.log&quot;"  />-->
 34       <!--1.7.4 在根目录下按日期产生文件夹,这再形成下一级固定的文件夹  -->
 35       <!--<param name="DatePattern" value="yyyyMMdd/&quot;OrderInfor/test.log&quot;"  />-->
 36       <!--1.8 配置每个日志的大小。【只在1.6 RollingStyle 选择混合方式与文件大小方式下才起作用!!!】可用的单位:KB|MB|GB。不要使用小数,否则会一直写入当前日志,
 37       超出大小后在所有文件名后自动增加正整数重新命名,数字最大的最早写入。-->
 38       <param name="maximumFileSize" value="10MB" />
 39       <!--1.9 最多产生的日志文件个数,超过则保留最新的n个 将value的值设置-1,则不限文件个数 【只在1.6 RollingStyle 选择混合方式与文件大小方式下才起作用!!!】
 40         与1.8中maximumFileSize文件大小是配合使用的-->
 41       <param name="MaxSizeRollBackups" value="5" />
 42       <!--1.10 配置文件文件的布局格式,使用PatternLayout,自定义布局-->
 43       <layout type="log4net.Layout.PatternLayout">
 44         <conversionPattern value="记录时间:%date %n线程ID:[%thread] %n日志级别:%-5level %n出错类:%logger property: [%property{NDC}] - %n错误描述:%message%newline %n%newline"/>
 45       </layout>
 46     </appender>
 47 
 48     <!--模式二:分文件夹存放-->
 49     <!--文件夹1-->
 50     <appender name="log1" type="log4net.Appender.RollingFileAppender">
 51       <param name="File"  value="D:\MyLog\OneLog\" />
 52       <param name="AppendToFile" value="true" />
 53       <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
 54       <Encoding value="UTF-8" />
 55       <param name="StaticLogFileName" value="false" />
 56       <param name="RollingStyle" value="Composite" />
 57       <param name="DatePattern" value="yyyy-MM-dd&quot;.log&quot;" />
 58       <param name="maximumFileSize" value="10MB" />
 59       <param name="MaxSizeRollBackups" value="5" />
 60       <layout type="log4net.Layout.PatternLayout">
 61         <conversionPattern value="%message%newline" />
 62       </layout>
 63       <!--下面是利用过滤器进行分文件夹存放,两种过滤器进行配合-->
 64       <!--与Logger名称(OneLog)匹配,才记录,-->
 65       <filter type="log4net.Filter.LoggerMatchFilter">
 66         <loggerToMatch value="OneLog" />
 67       </filter>
 68       <!--阻止所有的日志事件被记录-->
 69       <filter type="log4net.Filter.DenyAllFilter" />
 70     </appender>
 71     <!--文件夹2-->
 72     <appender name="log2" type="log4net.Appender.RollingFileAppender">
 73       <param name="File"  value="D:\MyLog\TwoLog\" />
 74       <param name="AppendToFile" value="true" />
 75       <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
 76       <Encoding value="UTF-8" />
 77       <param name="StaticLogFileName" value="false" />
 78       <param name="RollingStyle" value="Composite" />
 79       <param name="DatePattern" value="yyyy-MM-dd&quot;.log&quot;" />
 80       <param name="maximumFileSize" value="10MB" />
 81       <param name="MaxSizeRollBackups" value="5" />
 82       <layout type="log4net.Layout.PatternLayout">
 83         <conversionPattern value="%message%newline" />
 84       </layout>
 85       <!--下面是利用过滤器进行分文件夹存放,两种过滤器进行配合-->
 86       <!--与Logger名称(TwoLog)匹配,才记录,-->
 87       <filter type="log4net.Filter.LoggerMatchFilter">
 88         <loggerToMatch value="TwoLog" />
 89       </filter>
 90       <!--阻止所有的日志事件被记录-->
 91       <filter type="log4net.Filter.DenyAllFilter" />
 92     </appender>
 93 
 94 
 95     <!--2. 输出途径(二) 记录日志到数据库-->
 96     <appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppender">
 97       <!--2.1 设置缓冲区大小,只有日志记录超设定值才会一块写入到数据库-->
 98       <param name="BufferSize" value="1" />
 99       <!--2.2 引用-->
100       <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
101       <!--2.3 数据库连接字符串-->
102       <connectionString value="data source=localhost;initial catalog=LogDB;integrated security=false;persist security info=True;User ID=sa;Password=123456" />
103       <!--2.4 SQL语句插入到指定表-->
104       <commandText value="INSERT INTO LogInfor ([threadId],[log_level],[log_name],[log_msg],[log_exception],[log_time]) VALUES (@threadId, @log_level, @log_name, @log_msg, @log_exception,@log_time)" />
105       <!--2.5 数据库字段匹配-->
106       <!-- 线程号-->
107       <parameter>
108         <parameterName value="@threadId" />
109         <dbType value="String" />
110         <size value="100" />
111         <layout type="log4net.Layout.PatternLayout">
112           <conversionPattern value="%thread" />
113         </layout>
114       </parameter>
115       <!--日志级别-->
116       <parameter>
117         <parameterName value="@log_level" />
118         <dbType value="String" />
119         <size value="100" />
120         <layout type="log4net.Layout.PatternLayout">
121           <conversionPattern value="%level" />
122         </layout>
123       </parameter>
124       <!--日志记录类名称-->
125       <parameter>
126         <parameterName value="@log_name" />
127         <dbType value="String" />
128         <size value="100" />
129         <layout type="log4net.Layout.PatternLayout">
130           <conversionPattern value="%logger" />
131         </layout>
132       </parameter>
133       <!--日志信息-->
134       <parameter>
135         <parameterName value="@log_msg" />
136         <dbType value="String" />
137         <size value="5000" />
138         <layout type="log4net.Layout.PatternLayout">
139           <conversionPattern value="%message" />
140         </layout>
141       </parameter>
142       <!--异常信息  指的是如Infor 方法的第二个参数的值-->
143       <parameter>
144         <parameterName value="@log_exception" />
145         <dbType value="String" />
146         <size value="2000" />
147         <layout type="log4net.Layout.ExceptionLayout" />
148       </parameter>
149       <!-- 日志记录时间-->
150       <parameter>
151         <parameterName value="@log_time" />
152         <dbType value="DateTime" />
153         <layout type="log4net.Layout.RawTimeStampLayout" />
154       </parameter>
155     </appender>
156 
157 
158     <!--(二). 配置日志的的输出级别和加载日志的输出途径-->
159     <root>
160       <!--1. level中的value值表示该值及其以上的日志级别才会输出-->
161       <!--OFF > FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息)  > ALL  -->
162       <!--OFF表示所有信息都不写入,ALL表示所有信息都写入-->
163       <level value="ALL"></level>
164       <!--2. append-ref标签表示要加载前面的日志输出途径代码  通过ref和appender标签的中name属性相关联-->
165       
166       <!--<appender-ref ref="AdoNetAppender"></appender-ref>-->
167       <appender-ref ref="log0"></appender-ref>
168       <appender-ref ref="log1"></appender-ref>
169       <appender-ref ref="log2"></appender-ref>
170     </root>
171   </log4net>
172 
173 </configuration>
View Code
  1 using log4net;
  2 using System;
  3 using System.Collections.Generic;
  4 using System.Diagnostics;
  5 using System.Linq;
  6 using System.Reflection;
  7 using System.Text;
  8 using System.Threading.Tasks;
  9 
 10 namespace Ypf.Utils
 11 {
 12     public class LogUtils
 13     {
 14         //声明文件夹名称(这里分两个文件夹)
 15         static string log1Name = "OneLog";
 16         static string log2Name = "TwoLog";
 17 
 18         //可以声明多个日志对象
 19         //模式一:不分文件夹
 20         public static ILog log = LogManager.GetLogger(typeof(LogUtils));
 21 
 22         //模式二:分文件夹
 23         //如果是要分文件夹存储,这里的名称需要和配置文件中loggerToMatch节点中的value相配合
 24         //1. OneLog文件夹
 25         public static ILog log1 = LogManager.GetLogger(log1Name);
 26         //2. TwoLog文件夹
 27         public static ILog log2 = LogManager.GetLogger(log2Name);
 28 
 29         #region 01-初始化Log4net的配置
 30         /// <summary>
 31         /// 初始化Log4net的配置
 32         /// xml文件一定要改为嵌入的资源
 33         /// </summary>
 34         public static void InitLog4Net()
 35         {
 36             Assembly assembly = Assembly.GetExecutingAssembly();
 37             var xml = assembly.GetManifestResourceStream("Ypf.Utils.log4net.xml");
 38             log4net.Config.XmlConfigurator.Configure(xml);
 39         }
 40         #endregion
 41 
 42         /************************* 五种不同日志级别 *******************************/
 43         //FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息)
 44 
 45         #region 00-将调试的信息输出,可以定位到具体的位置(解决高层封装带来的问题)
 46         /// <summary>
 47         /// 将调试的信息输出,可以定位到具体的位置(解决高层封装带来的问题)
 48         /// </summary>
 49         /// <returns></returns>
 50         private static string getDebugInfo()
 51         {
 52             StackTrace trace = new StackTrace(true);
 53             return trace.ToString();
 54         }
 55         #endregion
 56 
 57         #region 01-DEBUG(调试信息)
 58         /// <summary>
 59         /// DEBUG(调试信息)
 60         /// </summary>
 61         /// <param name="msg">日志信息</param>
 62         ///  <param name="logName">文件夹名称</param>
 63         public static void Debug(string msg, string logName = "")
 64         {
 65             if (logName == "")
 66             {
 67                 log.Debug(getDebugInfo() + msg);
 68             }
 69             else if (logName == log1Name)
 70             {
 71                 log1.Debug(msg);
 72             }
 73             else if (logName == log2Name)
 74             {
 75                 log2.Debug(msg);
 76             }
 77         }
 78         /// <summary>
 79         /// Debug
 80         /// </summary>
 81         /// <param name="msg">日志信息</param>
 82         /// <param name="exception">错误信息</param>
 83         public static void Debug(string msg, Exception exception)
 84         {
 85             log.Debug(getDebugInfo() + msg, exception);
 86         }
 87 
 88         #endregion
 89 
 90         #region 02-INFO(一般信息)
 91         /// <summary>
 92         /// INFO(一般信息)
 93         /// </summary>
 94         /// <param name="msg">日志信息</param>
 95         /// <param name="logName">文件夹名称</param>
 96         public static void Info(string msg, string logName = "")
 97         {
 98             if (logName == "")
 99             {
100                 log.Info(getDebugInfo() + msg);
101             }
102             else if (logName == log1Name)
103             {
104                 log1.Info(msg);
105             }
106             else if (logName == log2Name)
107             {
108                 log2.Info(msg);
109             }
110         }
111         /// <summary>
112         /// Info
113         /// </summary>
114         /// <param name="msg">日志信息</param>
115         /// <param name="exception">错误信息</param>
116         public static void Info(string msg, Exception exception)
117         {
118             log.Info(getDebugInfo() + msg, exception);
119         }
120         #endregion
121 
122         #region 03-WARN(警告)
123         /// <summary>
124         ///WARN(警告)
125         /// </summary>
126         /// <param name="msg">日志信息</param>
127         /// <param name="logName">文件夹名称</param>
128         public static void Warn(string msg, string logName = "")
129         {
130             if (logName == "")
131             {
132                 log.Warn(getDebugInfo() + msg);
133             }
134             else if (logName == log1Name)
135             {
136                 log1.Warn(msg);
137             }
138             else if (logName == log2Name)
139             {
140                 log2.Warn(msg);
141             }
142         }
143         /// <summary>
144         /// Warn
145         /// </summary>
146         /// <param name="msg">日志信息</param>
147         /// <param name="exception">错误信息</param>
148         public static void Warn(string msg, Exception exception)
149         {
150             log.Warn(getDebugInfo() + msg, exception);
151         }
152         #endregion
153 
154         #region 04-ERROR(一般错误)
155         /// <summary>
156         /// ERROR(一般错误)
157         /// </summary>
158         /// <param name="msg">日志信息</param>
159         /// <param name="logName">文件夹名称</param>
160         public static void Error(string msg, string logName = "")
161         {
162             if (logName == "")
163             {
164                 log.Error(getDebugInfo() + msg);
165             }
166             else if (logName == log1Name)
167             {
168                 log1.Error(msg);
169             }
170             else if (logName == log2Name)
171             {
172                 log2.Error(msg);
173             }
174         }
175         /// <summary>
176         /// Error
177         /// </summary>
178         /// <param name="msg">日志信息</param>
179         /// <param name="exception">错误信息</param>
180         public static void Error(string msg, Exception exception)
181         {
182             log.Error(getDebugInfo() + msg, exception);
183         }
184         #endregion
185 
186         #region 05-FATAL(致命错误)
187         /// <summary>
188         /// FATAL(致命错误)
189         /// </summary>
190         /// <param name="msg">日志信息</param>
191         /// <param name="logName">文件夹名称</param>
192         public static void Fatal(string msg, string logName = "")
193         {
194             if (logName == "")
195             {
196                 log.Fatal(getDebugInfo() + msg);
197             }
198             else if (logName == log1Name)
199             {
200                 log1.Fatal(msg);
201             }
202             else if (logName == log2Name)
203             {
204                 log2.Fatal(msg);
205             }
206         }
207         /// <summary>
208         /// Fatal
209         /// </summary>
210         /// <param name="msg">日志信息</param>
211         /// <param name="exception">错误信息</param>
212         public static void Fatal(string msg, Exception exception)
213         {
214             log.Fatal(getDebugInfo() + msg, exception);
215         }
216 
217         #endregion
218 
219 
220 
221     }
222 }
View Code

 

*************转摘:https://www.cnblogs.com/yaopengfei/p/9428206.html

posted @ 2020-11-02 14:08  Linybo2008  阅读(1553)  评论(0编辑  收藏  举报