C# 利用Log4Net进行日志记录

概述

本文主要简单说明如何使用Log4Net进行日志记录，在程序开发过程中记录日志的优点：

• 它可以提供应用程序运行时的精确环境，可供开发人员尽快找到应用程序中的Bug；
• 一旦在程序中加入了Log 输出代码，程序运行过程中就能生成并输出日志信息而无需人工干预。
• 日志信息可以输出到不同的地方（控制台，文件等）以备以后研究之用。

关于Log4Net的官方说明：

The Apache log4net library is a tool to help the programmer output log statements to a variety of output targets. log4net is a port of the excellent Apache log4j™ framework to the Microsoft® .NET runtime. We have kept the framework similar in spirit to the original log4j while taking advantage of new features in the.NET runtime。

【粗略翻译】Apache log4net 类库是一个帮助程序员输出日志状态到多种目标平台。log4net 是优秀的 Apache log4j^TM 框架在微软.Net平台的一个实现。在保持原有log4j的思想的前提下，同时利用.Net的新特性。

Log4Net 在程序中使用，可以通过配置文件，进行配置，也可以通过程序代码进行定义。本文主要讲解一下通过配置的方式实现

配置文件结构，如下图所示：

配置文件可以配置在App.config中【编译后会生成对应的[程序名].exe.config】，也可以配置在独立的xml文件中。

如果配置在独立的xml文件中，需要在Assembly.cs中增加一句说明，如下所示：

[assembly: log4net.Config.DOMConfigurator(ConfigFile = "Log4NetConfig.xml", ConfigFileExtension = "xml", Watch = true)]

如果配置在App.config中，除了配置log4net节点外，还要对节点进行声明，即要增加configSection节点【放在根节点的第一个元素】，如下所示

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

生成的日志文件内容，如下图所示：

核心代码

代码如下：

 using log4net;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
 
 [assembly: log4net.Config.XmlConfigurator(Watch = true)]
 namespace DemoLog4Net
 {
     /// <summary>
     /// 日志记录
     /// </summary>
     public class LogHelper
     {
         /// <summary>
         /// 日志实例
         /// </summary>
         private static ILog logInstance=LogManager.GetLogger("testApp");
 
         public static void WriteLog(string message ,LogLevel level) {
             switch (level) {
                 case LogLevel.Debug:
                     logInstance.Debug(message);
                     break;
                 case LogLevel.Error:
                     logInstance.Error(message);
                     break;
                 case LogLevel.Fatal:
                     logInstance.Fatal(message);
                     break;
                 case LogLevel.Info:
                     logInstance.Info(message);
                     break;
                 case LogLevel.Warn:
                     logInstance.Warn(message);
                     break;
                 default:
                     logInstance.Info(message);
                     break;
             }
         }
     }
 
     public enum LogLevel {
         Debug=,
         Error=,
         Fatal=,
         Info=,
         Warn=
     }
 }

独立配置文件如下：

 <?xml version="1.0" encoding="utf-8" ?>
 <log4net>
   <root>
     <level value="DEBUG" />
     <appender-ref ref="LogFileAppender" />
     <appender-ref ref="ConsoleAppender" />
   </root>
   <logger name="testApp">
     <level value="DEBUG" />
   </logger>
   <appender name="LogFileAppender" type="log4net.Appender.FileAppender" >
     <param name="File" value="${TMO}log-file.txt" />
     <StaticLogFileName value="false"/>
     <param name="AppendToFile" value="true" />
     <layout type="log4net.Layout.PatternLayout">
       <param name="Header" value="[Header]
"/>
       <param name="Footer" value="[Footer]
"/>
       <param name="ConversionPattern" value="%d [%t] %-5p %c [%x]  - %m%n"/>
     </layout>
     <filter type="log4net.Filter.LevelRangeFilter">
       <param name="LevelMin" value="DEBUG" />
       <param name="LevelMax" value="ERROR" />
     </filter>
   </appender>
   <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender" >
     <layout type="log4net.Layout.PatternLayout">
       <param name="ConversionPattern" value="%d [%t] %-5p %c [%x] - %m%n" />
     </layout>
   </appender>
 </log4net>

附加：

如何设置环境变量：

System.Environment.SetEnvironmentVariable("TMO", DateTime.Now.ToString("yyyyMMdd"));

日志记录优先级如下表所示：

级别	允许的方法	Boolean属性	优先级别
OFF			Highest
FATAL	void Fatal(...);	bool IsFatalEnabled;
RROR	void Error(...);	bool IsErrorEnabled;
WARN	void Warn(...);	bool IsWarnEnabled;
INFO	void Info(...);	bool IsInfoEnabled;
DEBUG	void Debug(...);	bool IsDebugEnabled;
ALL			Lowest

 

备注：

log4net确实是一个应用广泛且简单好用的日志记录框架，本文只是简单的说明，后续工作中会继续研究其他的功能