.NET开源日志框架Log4Net详解

Log4Net介绍

今天在公众号推送上看到了关于.NET开源日志框架Log4Net的一篇文章，恰巧现在做的项目中也有使用到Log4Net。由于本人对其的使用不是很熟练，于是想花点时间学习一下这个框架，了解其中的原理。

在一个大型的项目中，日志文件扮演着十分重要的角色。当系统足够大，代码量很多的时候，我们很难逐行去检查代码，找出错误。这时可以用查看日志的方式替代调试代码。通过查看日志文件，我们可以检查错误，检测程序运行的过程。

话不多说，开撸。

Log4Net简介

Log4Net是从Java中的Log4j迁移过来的一个.NET版的开源日志框架，它的功能很强大，可以将日志分为不同的等级，以不同的格式输出到不同的存储介质中。

比如：数据库、txt文件、内存缓存区、邮件、控制台、ANSI终端、远程接收端等等。

最常用的两种存储介质是：txt文件和数据库。

Log4Net日志的五个级别

FATAL（致命错误）
ERROR（一般错误）
WARN（警告）
INFO（一般信息）
DEBUG（调试信息）

注意：级别依次递减，每个级别都对应着一组重载方法进行调用。

基本使用步骤

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

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

在默认配置文件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>

详细代码如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <!--1.添加log4net的节点声明配置代码-->
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
  </configSections>
  <!--2.log4net的核心配置代码-->
  <log4net>
    <!--把日志信息输出到以日期命名的文件里-->
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
      <!--文件夹的位置-->
      <file value="D:MyLog1" />
      <appendToFile value="true" />
      <!--动态生成文件名-->
      <param name="StaticLogFileName" value="false" />
      <!--以日期命名-->
      <param name="DatePattern" value="yyyyMMdd&quot;.log&quot;" />
      <rollingStyle value="Date" />
      <!--日志在日志文件中的布局方式-->
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%newline %n记录时间：%date %n线程ID:[%thread] %n日志级别：%-5level %n出错类：%logger property:[%property{NDC}]-%n错误描述：%message%newline %n" />
      </layout>
      <!--使用最小锁定模型（minimal locking model），以允许多个进程可以写入同一个文件-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
    </appender>
    <root>
      <level value="ALL"></level>
      <appender-ref ref="RollingFileAppender"></appender-ref>
    </root>
  </log4net>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.1" />
  </startup>
</configuration>

代码调用

static void Main(string[] args)
{
    log4net.Config.XmlConfigurator.Configure();
    ILog log = LogManager.GetLogger("test");
    log.Debug("调试信息");
}

运行结果

查看D盘目录，发现文件MyLog120180918.log。打开文件，日志保存成功。

初始化配置文件

两种初始化配置的形式

通过代码来初始化配置，log4net.Config.XmlConfigurator.Configure();
通过反射形式进行初始化配置，[assembly: log4net.Config.XmlConfigurator()]

注意：[assembly: log4net.Config.XmlConfigurator()] 可以加在当前使用文件的namespace上作用于当前文件。

1537287004374

或者加在Properties/AssemblyInfo.cs中，则该项目全局都无须再初始化了。

1537287194974

在实际项目中，默认的配置文件里可能包含很多框架的信息，这个时候把log4net的配置代码再放入进去，就会显得有点杂乱，因此一般通过log4net.Config.XmlConfigurator.Configure(); 来关联配置文件。

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

代码配置：log4net.Config.XmlConfigurator.Configure();
反射配置：[assembly: log4net.Config.XmlConfigurator()]

情况二：修改默认配置文件的名称为App1.config

这里只是举例，很少有修改默认配置文件名称的情况。

代码配置：首先App1.config文件的属性中的“生成操作”改为“嵌入的资源”，然后通过以下代码进行配置。
Assembly assembly = Assembly.GetExecutingAssembly();
var xml = assembly.GetManifestResourceStream("_01_SimpleDemo.App1.config");
log4net.Config.XmlConfigurator.Configure(xml);
注意：代码中的“_01_SimpleDemo”为命名空间。
反射配置：[assembly: log4net.Config.XmlConfigurator(ConfigFile = “_01_SimpleDemo.App1.config”)]

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

情况三：新建单独xml文件，进行log4net的配置

推荐采用这种方式，和原配置文件区分开，单独配置方便，处理方式和情况二是一致的。

代码配置：首先将log4net.xml文件的属性中的“生成操作”改为“嵌入的资源”，然后通过以下代码进行配置。
Assembly assembly = Assembly.GetExecutingAssembly();
var xml = assembly.GetManifestResourceStream("_01_SimpleDemo.log4net.xml");
log4net.Config.XmlConfigurator.Configure(xml);
注意：代码中的“_01_SimpleDemo”为命名空间。
反射配置：[assembly: log4net.Config.XmlConfigurator(ConfigFile = “log4net.xml”)]。

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

情况四：通过绝对路径的方式进行处理

无论是修改默认配置文件的名称，或者新建单独的xml作为配置文件，都可以通过绝对路径的方式进行处理（不推荐）。

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

log4net.Config.XmlConfigurator.Configure(new FileInfo(@"C:\Users\Administrator\source\repos\01-SimpleDemo\01-SimpleDemo\log4net.xml"));

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

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

注意：B/S程序下通过 log4net.Config.XmlConfigurator.Configure(new FileInfo(Server.MapPath(“~”) + @”/log4net.xml”));来配置。

代码调用详解

Log4Net允许多个ILog对象同时存在，通过代码：ILog log = LogManager.GetLogger(“xxx”);来创建。

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

OFF表示所有信息都不写入，ALL表示所有信息都写入
可以通过这样的xml配置，表示WARN级别以及高于WARN以上的级别才会被写入日志

<root>
  <level value="WARN">
  </level>
</root>

写入日志的方法有：Debug、Error、Fatal、Info、Warn五个方法，每个方法都有两个重载

1537453971541

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

//代码配置
Assembly assembly = Assembly.GetExecutingAssembly();
var xml = assembly.GetManifestResourceStream("_01_SimpleDemo.log4net.xml");
log4net.Config.XmlConfigurator.Configure(xml);

//调用代码写日志
ILog log = LogManager.GetLogger("test");
log.Debug("调试信息");
log.Info("一般信息");
log.Warn("警告");
try
{
    int.Parse("ddd");
}
catch (Exception ex)
{
    log.Error("错误信息", ex);
}
log.Fatal("致命错误");

配置文件详解

Log4Net的配置文件主要分为两大部分：分别是【自定义配置节点】和【核心代码配置】。

自定义配置节点代码固定

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

核心代码配置位于log4net节点中，里面包括appender节点和root节点，appender节点配置日志输出路径，root节点用于设置记录日志的级别和启用哪些输出途径。

1537464031423

几点说明

自定义节点<section name=”log4net” type=”log4net.Config.Log4NetConfigurationSectionHandler,log4net” />代码固定，直接复制即可。
<root></root>节点主要用来：配置日志的输出级别和加载日志的输出途径。

A：level中的value值表示该值及其以上的日志级别才会输出，日志级别包括：OFF > FATAL（致命错误） > ERROR（一般错误） > WARN（警告） > INFO（一般信息） > （调试信息） > ALL，比如，<level value=”INFO”></level>表示只有INFO及其以上的日志级别才会被保存。（OFF表示所有信息都不写入，ALL表示所有信息都写入）

B：<appender-ref></appender-ref>标签用于加载日志的输出途径代码，通过ref和appender标签中的name属性相关联，比如，<appender-ref ref=”RollingFileAppender”></appender-ref>表示开启txt文档保存日志的方式。
<appender></appender>节点，用来配置日志的输出途径的。一般输出到【txt文本文档】和【数据库】。

A：需要注意字段类型相匹配，并且要显式指定其长度。

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

注意：文件夹位置“D:MyLog/”后面的斜杠表示文件夹。

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

首先，配置RollingStyle节点为Size模式或者Composite模式，然后配置maximumFileSize节点设置每个文件的大小，最后配置MaxSizeRollBackups节点，设置日志文件的个数。超出大小后在所有文件名后自动增加正整数重新命名，数字最大的最早写入。
<param name="RollingStyle" value="Composite" />
<param name="maximumFileSize" value="10KB" />
<param name="MaxSizeRollBackups" value="5" />

详细代码

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <!--一.添加log4net的自定义配置节点-->
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
  </configSections>
  <!--二.log4net的核心配置代码-->
  <log4net>
    <!--（一）配置日志的输出路径-->
    <!--1.输出路径（一）将日志以回滚文件的形式写到文件中-->
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
      <!--1.1 文件夹的位置（也可以写相对路径）-->
      <param name="File" value="D:MyLog1" />
      <!--相对路径 C/S程序生成在Debug目录下-->
      <!--<param name="File" value="/Logs/" />-->
      <!--1.2 是否追加到文件-->
      <param name="AppendToFile" value="true" />
      <!--1.3 使用最小锁定模型（minimal locking model），以允许多个进程可以写入同一个文件-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <!--1.4 配置Unicode编码-->
      <Encoding value="UTF-8" />
      <!--1.5 是否只写到一个文件里-->
      <param name="StaticLogFileName" value="false" />
      <!--1.6 配置按照何种方式产生多个日志文件（Date：日期、Size：文件大小、Composite：日期和文件大小的混合方式）-->
      <param name="RollingStyle" value="Composite" />
      <!--1.7 介绍多种日志的命名和存放在磁盘的形式-->
      <!--1.7.1 在根目录下直接以日期命名txt文件 注意&quot;的位置，去空格-->
      <!--<param name="DatePattern" value="yyyy-MM-dd&quot;.log&quot;" />-->
      <!--1.7.2 在根目录下按日期产生文件夹，文件名固定test.log-->
      <!--<param name="DatePattern" value="yyyy-MM-dd/yyyyMMdd&quot;test.log&quot;" />-->
      <!--1.7.3 在根目录下按日期产生文件夹，这是按日期产生文件夹，并在文件名前也加上日期-->
      <!--<param name="DataPattern" value="yyyyMMdd/yyyyMMdd&quot;-test.log&quot;" />-->
      <!--1.7.4 在根目录下按日期产生文件夹，这再形成下一级固定的文件夹-->
      <!--<param name="DatePattern" value="yyyyMMdd/yyyyMMdd&quot;OrderInfor/test.log&quot;" />-->
      <!--1.8 配置每个日志的大小。【只在1.6 RollingStyle选择混合方式与文件大小方式下才起作用】可用单位：KB|MB|GB。-->
      <!--不要使用小数，否则会一直写入当前日志，超出大小后在所有文件名后自动增加正整数重新命名，数字最大的最早写入-->
      <param name="maximumFileSize" value="10MB" />
      <!--1.9 最多产生的日志文件个数，超过则保留最新的n个，将value的值设置-1，则不限文件个数【只在1.6 RollingStyle选择混合方式与文件大小方式下才起作用】与1.8种maximumFileSize文件大小是配合使用的-->
      <!--1.10 配置文件的布局格式，使用PatternLayout，自定义布局-->
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="记录时间：%date %n线程ID：[%thread] %n日志级别：%-5level %n出错类：%logger property：[%property{NDC}]- %错误描述：%message%newline %n%newline" />
      </layout>
    </appender>

    <!--2.输出路径（二）记录日志到数据库-->
    <appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppedner">
      <!--2.1 设置缓冲区大小，只有日志记录超设定值才会一块写入到数据库-->
      <param name="BufferSize" value="1" />
      <!--2.2 引用-->
      <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
      <!--2.3 数据库连接字符串-->
      <connectionString value="data source=localhost; initial catalog=LogDB; integrated security=false; persist security info=True; User ID=sa; Password=123456" />
      <!--2.4 SQL语句插入到指定表-->
      <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)" />
      <!--2.5 数据库字段匹配-->
      <!--线程号-->
      <parameter>
        <parameterName value="@threadId" />
        <dbType value="String" />
        <size value="100" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%thread" />
        </layout>
      </parameter>
      <!--日志级别-->
      <parameter>
        <parameterName value="@log_level" />
        <dbType value="String" />
        <size value="100" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%level" />
        </layout>
      </parameter>
      <!--日志记录类名称-->
      <parameter>
        <parameterName type="@log_name" />
        <dbType value="String" />
        <size value="100" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%logger" />
        </layout>
      </parameter>
      <!--日志信息-->
      <parameter>
        <parameterName type="@log_msg" />
        <dbType value="String" />
        <size value="5000" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%message" />
        </layout>
      </parameter>
      <!--异常信息，指的是如Infor方法的第二个参数的值-->
      <parameter>
        <parameterName type="@log_exception" />
        <dbType value="String" />
        <size value="2000" />
        <layout type="log4net.Layout.ExceptionLayout" />
      </parameter>
      <!--日志记录时间-->
      <parameter>
        <parameterName type="@log_time" />
        <dbType value="DateTime" />
        <layout type="log4net.Layout.RawTimeStampLayout" />
      </parameter>
    </appender>
    <!--（二）配置日志的输出级别和加载日志的输出途径-->
    <root>
      <!--1.level中的value值表示该值及其以上的日志级别才会输出-->
      <!--OFF > FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息)> ALL-->
      <!--OFF表示所有有信息都不写入，ALL表示所有信息都写入-->
      <level value="ALL"></level>
      <!--2.appender-ref标签表示要加载前面的日志输出途径代码，通过ref和appender标签中的name属性相关联-->
      <appender-ref ref="RollingFileAppender"></appender-ref>
      <appender-ref ref="AdoNetAppender"></appender-ref>
    </root>
  </log4net>
</configuration>

简单的封装及完整代码

这里模拟在系统框架中队Log4Net进行简单的封装，然后在MVC框架中调用。

步骤一

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

1537769743107

LogUtils类代码如下

using log4net;
using System;
using System.Reflection;

namespace Ypf.Utils
{
    public class LogUtils
    {
        //可以声明多个日志对象
        public static ILog log = LogManager.GetLogger(typeof(LogUtils));

        #region 01-初始化Log4Net的配置
        /// <summary>
        /// 初始化Log4Net的配置
        /// xml文件一定要改为嵌入的资源
        /// </summary>
        public static void InitLog4Net()
        {
            Assembly assembly = Assembly.GetExecutingAssembly();
            var xml = assembly.GetManifestResourceStream("Ypf.Utils.log4net.xml");
            log4net.Config.XmlConfigurator.Configure(xml);
        }
        #endregion


        /************************五种不同日志级别***************************/
        //FATAL(致命错误) > ERROR(一般错误) > WARN(警告) > INFO(一般信息) > DEBUG(调试信息)

        #region 01-DEBUG（调试信息）
        /// <summary>
        /// Debug
        /// </summary>
        /// <param name="msg">日志信息</param>
        public static void Debug(string msg)
        {
            log.Debug(msg);
        }

        /// <summary>
        /// Debug
        /// </summary>
        /// <param name="msg">日志信息</param>
        /// <param name="exception">错误信息</param>
        public static void Debug(string msg, Exception exception)
        {
            log.Debug(msg, exception);
        }
        #endregion

        #region 02-INFO（一般信息）
        /// <summary>
        /// Info
        /// </summary>
        /// <param name="msg">日志信息</param>
        public static void Info(string msg)
        {
            log.Info(msg);
        }

        /// <summary>
        /// Info
        /// </summary>
        /// <param name="msg">日志信息</param>
        /// <param name="exception">错误信息</param>
        public static void Info(string msg, Exception exception)
        {
            log.Info(msg, exception);
        }
        #endregion

        #region 03-WARN（警告）
        /// <summary>
        /// Warn
        /// </summary>
        /// <param name="msg">日志信息</param>
        public static void Warn(string msg)
        {
            log.Warn(msg);
        }

        /// <summary>
        /// Warn
        /// </summary>
        /// <param name="msg">日志信息</param>
        /// <param name="exception">错误信息</param>
        public static void Warn(string msg, Exception exception)
        {
            log.Warn(msg, exception);
        }
        #endregion

        #region 04-ERROR（一般错误）
        /// <summary>
        /// Error
        /// </summary>
        /// <param name="msg">日志信息</param>
        public static void Error(string msg)
        {
            log.Error(msg);
        }

        /// <summary>
        /// Error
        /// </summary>
        /// <param name="msg">日志信息</param>
        /// <param name="exception">错误信息</param>
        public static void Error(string msg, Exception exception)
        {
            log.Error(msg, exception);
        }
        #endregion

        #region 05-FATAL（致命错误）
        /// <summary>
        /// Fatal
        /// </summary>
        /// <param name="msg">日志信息</param>
        public static void Fatal(string msg)
        {
            log.Fatal(msg);
        }

        /// <summary>
        /// Fatal
        /// </summary>
        /// <param name="msg">日志信息</param>
        /// <param name="exception">错误信息</param>
        public static void Fatal(string msg, Exception exception)
        {
            log.Fatal(msg, exception);
        }
        #endregion
    }
}

步骤二

新建Ypf.MVC的MVC5框架，添加对Ypf.Utils类库的引用，在Global.asax全局文件中添加对Log4Net的初始化。

1537802739022

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

/// <summary>
/// 测试log4net
/// 首先需要再Global中初始化log4net
/// </summary>
/// <returns></returns>
public ActionResult Index()
{
    //FATAL(致命错误) > ERROR（一般错误） > WARN（警告） > INFO（一般信息） > DEBUG（调试信息）
    LogUtils.Debug("出错了");
    try
    {
        int.Parse("ddf");
    }
    catch (Exception ex)
    {
        LogUtils.Debug("出错了", ex);
    }

    LogUtils.Info("出错了");
    try
    {
        int.Parse("ddf");
    }
    catch (Exception ex)
    {
        LogUtils.Info("出错了", ex);
    }

    LogUtils.Warn("出错了");
    try
    {
        int.Parse("ddf");
    }
    catch (Exception ex)
    {
        LogUtils.Warn("出错了", ex);
    }

    LogUtils.Error("出错了");
    try
    {
        int.Parse("ddf");
    }
    catch (Exception ex)
    {
        LogUtils.Error("出错了", ex);
    }

    LogUtils.Fatal("出错了");
    try
    {
        int.Parse("ddf");
    }
    catch (Exception ex)
    {
        LogUtils.Fatal("出错了", ex);
    }
    return View();
}

Log4Net介绍
1. Log4Net简介
2. Log4Net日志的五个级别
基本使用步骤
初始化配置文件
代码调用详解
配置文件详解
1. 几点说明
2. 详细代码
简单的封装及完整代码
1. 步骤一
2. 步骤二