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=0,
        Error=1,
        Fatal=2,
        Info=3,
        Warn=4
    }
}

獨立配置文件如下：

<?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]&#13;&#10;"/>
      <param name="Footer" value="[Footer]&#13;&#10;"/>
      <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確實是一個應用廣泛且簡單好用的日志記錄框架，本文只是簡單的說明，后續工作中會繼續研究其他的功能