C# Log4Net学习笔记：记录日志到文件

当前位置:

首页 > c#编程 >

C# Log4Net学习笔记：记录日志到文件

一、基础知识

1.1、简介

Log4Net是一个开源日志框架，它的功能很强大，可以将日志分为不同的等级，以不同的格式输出到不同的存储介质中，比如：数据库、txt文件、内存缓冲区、邮件、控制台、ANSI终端、远程接收端等等。

Log4Net将日志分为五个级别，从高到低分别是：FATAL（致命错误）、ERROR（一般错误）、WARN（警告）、INFO（一般信息）、DEBUG（调试信息）。

Log4Net有4种主要的组件，分别是Logger（记录器）、Repository（库）、Appender（附着器）以及 Layout（布局）。

1.2、下载

官方地址

http://logging.apache.org/log4net/download_log4net.cgi

GitHub地址

https://github.com/apache/logging-log4net/

二、记录https://github.com/apache/logging-log4net/日志到文件

2.1、Log4Net安装

新建一个控制台应用程序，项目右键->管理 NuGet 程序包->log4net。

2.2、配置文件

添加一个ConfigFile文件夹，然后在其下面新建一个Log4NetToFile.config的配置文件，接着在其属性的复制到输出目录项下选择始终复制。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  </configSections>
  <log4net>
    <!--type：表示用哪种类型记录日志，log4net.Appender.RollingFileAppender表示用文本记录日志。-->
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
    
      <!--日志存储路径-->
      <file value="Log\" />
    
      <!--是否追加日志-->
      <appendToFile value="true" />
    
      <!--防止多线程时不能写Log，官方说线程非安全。-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
    
      <!--配置Unicode编码-->
      <encoding value="utf-8" />
    
      <!--是否只写到一个文件-->
      <staticLogFileName value="false" />
    
      <!--为文件名加后缀，可用作：以日期作为文件名生成log。-->
      <datePattern value="yyyyMMdd'.txt'" />
    
      <!--可以为：Once|Size|Date|Composite-->
      <!--Composite为Size和Date的组合-->
      <rollingStyle value="Composite" />
      
      <!--日志最大个数，仅保留最新的。-->
      <!--rollingStyle节点为Size时，只能有value个日志文件。-->
      <!--rollingStyle节点为Composite时，每天只能有value个日志文件。-->
      <maxSizeRollBackups value="2" />
      
      <!--可用单位：KB|MB|GB-->
      <maximumFileSize value="2MB" />
      
      <!--过滤器-->
      
      <!--拒绝所用的日志输出(日志记录开关)-->
      <!--<filter type="log4net.Filter.DenyAllFilter" />-->
      
      <!--只有指定等级的日志事件才被记录-->
      <!--<filter type="log4net.Filter.LevelMatchFilter">
        <AcceptOnMatch value="true" />
        <param name="levelToMatch" value="DEBUG" />
      </filter>
      <filter type="log4net.Filter.DenyAllFilter" />-->
      
      <!--只有指定范围等级的日志事件才被记录-->
      <filter type="log4net.Filter.LevelRangeFilter">    
        <param name="LevelMin" value="DEBUG" />    
        <param name="LevelMax" value="FATAL" />    
      </filter>
      
      <!--日志输出格式-->
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%时间：%date 线程ID：[%thread] 日志级别：%-5level 出错类：%logger 错误描述：%message %n" />
      </layout>
    </appender>

    <!--输出控制级别，从高到低分别是: OFF > FATAL > ERROR > WARN > INFO > DEBUG > ALL -->
    <root>
      <priority value="ALL" />
      <level value="ALL" />
      <appender-ref ref="RollingFileAppender" />
    </root>
  </log4net>
</configuration>

2.3、测试代码

    class Program
    {
        //1、通过NuGet安装log4net程序包
        //2、需要引入配置文件
        //3、通过代码读取配置文件
        //4、通过LogManager获取ILog接口
        //5、写不同等级的日志
        static void Main(string[] args)
        {
            #region 记录日志到文件
            XmlConfigurator.Configure(new FileInfo(Path.Combine(AppDomain.CurrentDomain.BaseDirectory + "ConfigFile\\Log4NetToFile.config")));
            ILog logger = LogManager.GetLogger(typeof(Program));
            logger.Fatal("This is fatal message.");
            logger.Error("This is error message.");
            logger.Warn("This is warn message.");
            logger.Info("This is info message.");
            logger.Debug("This is debug message.");

            #region 测试maxSizeRollBackups及maximumFileSize
            //for (int i = 0; i < 1000000; i++)
            //{
            //    logger.Fatal($"第{i + 1}次写日志");
            //}
            #endregion

            Console.Read();
            #endregion
        }
    }

2.4、运行结果

在bin\Debug\Log文件夹下，可以看到按日期生成的txt日志文件，内容如下：

时间：2020-05-11 23:25:11,602 线程ID：[1] 日志级别：FATAL 出错类：LinkTo.Test.ConsoleLog4Net.Program 错误描述：This is fatal message. 
时间：2020-05-11 23:25:11,616 线程ID：[1] 日志级别：ERROR 出错类：LinkTo.Test.ConsoleLog4Net.Program 错误描述：This is error message. 
时间：2020-05-11 23:25:11,617 线程ID：[1] 日志级别：WARN  出错类：LinkTo.Test.ConsoleLog4Net.Program 错误描述：This is warn message. 
时间：2020-05-11 23:25:11,618 线程ID：[1] 日志级别：INFO  出错类：LinkTo.Test.ConsoleLog4Net.Program 错误描述：This is info message. 
时间：2020-05-11 23:25:11,618 线程ID：[1] 日志级别：DEBUG 出错类：LinkTo.Test.ConsoleLog4Net.Program 错误描述：This is debug message.

栏目列表