Log4net終結版

版權聲明：本文爲博主原創文章，未經博主允許不得轉載。

目錄(?)[+]

        繼上一篇Log4net的整理已經多時，最近閒時把log4net封裝了下，針對一些可能的需求進行了調查，例如多級別日誌和多文件日誌。

1.單文件日誌

        對於單文件的日誌，封裝代碼如下：

public enum LogMessageType
{
    Debug,
    Info,
    Warn,
    Error,
    Fatal
}
public sealed class LogProvider
{
    private static readonly ILog provider = GetLogger();
    static LogProvider() { }
    private LogProvider() { }

    public static void Write(string msg, LogMessageType msgType, Exception ex = null)
    {
        WriteLog(msg, msgType, ex);
    }
    public static void InitConfig()
    {
        XmlConfigurator.Configure();
    }
    public static void ShutDown()
    {
        LogManager.Shutdown();
    }

    private static ILog GetLogger()
    {
        InitConfig();
        return LogManager.GetLogger("DefaultLogger");
    }
    private static void WriteLog(string msg, LogMessageType msgType, Exception ex)
    {
        if (provider != null)
        {
            switch (msgType)
            {
                case LogMessageType.Debug:
                    provider.Debug(msg, ex);
                    break;
                case LogMessageType.Info:
                    provider.Info(msg, ex);
                    break;
                case LogMessageType.Warn:
                    provider.Warn(msg, ex);
                    break;
                case LogMessageType.Error:
                    provider.Error(msg, ex);
                    break;
                case LogMessageType.Fatal:
                    provider.Fatal(msg, ex);
                    break;
            }
        }
    }
}

        這樣所有要記日誌的地方只需要LogProvider.Write("this is Log", LogMessageType.Error);一行代碼即可，Log4net初始化工作封裝在初始化器中，在第一次調用Log4net時進行自動初始化。LogProvider類開放出三個靜態方法：Write、InitConfig、ShutDown，後兩者用於在程序中手動控制Log4net的開啓和關閉；Write方法採用默認參數，達到重載的效果。配置文件如下：

<?xml version="1.0"?>
<configuration>
  <configSections>
    <section name="log4net"
             type="log4net.Config.Log4NetConfigurationSectionHandler,log4net"/>
  </configSections>
  <log4net>
    <logger name="DefaultLogger">
      <level value="ALL"/>
      <appender-ref ref="txtLogger" />
    </logger>
    <appender name="txtLogger"
              type="log4net.Appender.RollingFileAppender,log4net" >
      <File value="Log\Log.txt" />
      <datePattern value="(yyyyMMdd)"/>
      <appendToFile value="true"/>
      <RollingStyle value="Composite"/>
      <MaxSizeRollBackups value="10"/>
      <maximumFileSize value="1MB"/>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]%-5p %c - %m%n"/>
      </layout>
    </appender>
  </log4net>
  <startup/>
</configuration>

        唯一要注意的就是<logger name="DefaultLogger">這個用來關聯，幫助類中要和配置文件中一致，其他的參數說明參照這以前寫的log4net的配置詳解。

2.分級別記錄日誌

        重構代碼時我想起我們原來的日誌框架有個功能是把不同級別的日誌分開記錄的，例如把奔潰和錯誤記在一起一個文件中，警告和信息記在一個文件中，查問題時就可以先看重大錯誤。針對這個需求調查了下，也可以在配置文件中配置的，配置文件如下：

<?xml version="1.0"?>
<configuration>
  <configSections>
    <section name="log4net"
             type="log4net.Config.Log4NetConfigurationSectionHandler,log4net"/>
  </configSections>
  <log4net>
    <logger name="DefaultLogger">
      <level value="ALL"/>
      <appender-ref ref="InfoLoging" />
      <appender-ref ref="ErrorLoging" />
    </logger>
    <!--DefaultLogger Info Log-->
    <appender name="InfoLoging"
              type="log4net.Appender.RollingFileAppender,log4net" >
      <File value="Log\LogTipMsg.txt" />
      <datePattern value="(yyyyMMdd)"/>
      <appendToFile value="true"/>
      <RollingStyle value="Composite"/>
      <MaxSizeRollBackups value="10"/>
      <maximumFileSize value="1MB"/>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]%-5p %c - %m%n"/>
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <LevelMin value="DEBUG"/>
        <LevelMax value="Warn"/>
      </filter>
    </appender>
    <!--DefaultLogger Error Log-->
    <appender name="ErrorLoging"
              type="log4net.Appender.RollingFileAppender,log4net" >
      <File value="Log\LogErrorMsg.txt" />
      <datePattern value="(yyyyMMdd)"/>
      <appendToFile value="true"/>
      <RollingStyle value="Composite"/>
      <MaxSizeRollBackups value="10"/>
      <maximumFileSize value="1MB"/>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]%-5p %c - %m%n"/>
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <LevelMin value="ERROR" />
      </filter>
    </appender>
  </log4net>
  <startup/>
</configuration>

3.按業務邏輯記錄日誌

        另一個情況就是按業務模塊記錄到不同的文件中，此時同樣可以通過配置來獲得，配置文件如下：

<?xml version="1.0"?>
<configuration>
  <configSections>
    <section name="log4net"
             type="log4net.Config.Log4NetConfigurationSectionHandler,log4net"/>
  </configSections>
  <log4net>
    <logger name="DefaultLogger">
      <level value="ALL"/>
      <appender-ref ref="InfoLoging" />
      <appender-ref ref="ErrorLoging" />
    </logger>
    <logger name="OtherCustomerLogger">
      <level value="Info"/>
      <appender-ref ref="OtherInfoLoging" />
    </logger>
    <!--DefaultLogger Info Log-->
    <appender name="InfoLoging"
              type="log4net.Appender.RollingFileAppender,log4net" >
      <File value="Log\LogTipMsg.txt" />
      <datePattern value="(yyyyMMdd)"/>
      <appendToFile value="true"/>
      <RollingStyle value="Composite"/>
      <MaxSizeRollBackups value="10"/>
      <maximumFileSize value="1MB"/>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]%-5p %c - %m%n"/>
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <LevelMin value="DEBUG"/>
        <LevelMax value="Warn"/>
      </filter>
    </appender>
    <!--DefaultLogger Error Log-->
    <appender name="ErrorLoging"
              type="log4net.Appender.RollingFileAppender,log4net" >
      <File value="Log\LogErrorMsg.txt" />
      <datePattern value="(yyyyMMdd)"/>
      <appendToFile value="true"/>
      <RollingStyle value="Composite"/>
      <MaxSizeRollBackups value="10"/>
      <maximumFileSize value="1MB"/>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]%-5p %c - %m%n"/>
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <LevelMin value="ERROR" />
      </filter>
    </appender>
    <!--OtherCustomerLogger OtherInfo Log-->
    <appender name="OtherInfoLoging"
              type="log4net.Appender.RollingFileAppender,log4net" >
      <File value="Log\LogOtherInfoLoging.txt" />
      <datePattern value="(yyyyMMdd)"/>
      <appendToFile value="true"/>
      <RollingStyle value="Composite"/>
      <MaxSizeRollBackups value="10"/>
      <maximumFileSize value="1MB"/>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]%-5p %c - %m%n"/>
      </layout>
    </appender>
  </log4net>
  <startup/>
</configuration>

        此時幫助類就要適當的調整了，代碼如下：

public enum LogicType
{
    DefaultLogger,
    OtherCustomerLogger
}
public enum LogMessageType
{
    Debug,
    Info,
    Warn,
    Error,
    Fatal
}
public sealed class LogProvider
{
    static LogProvider() { }
    private LogProvider() { }

    private static readonly Dictionary<string, ILog> dicLoggers = GetLoggers();

    public static void Write(string msg, LogMessageType msgType, Exception ex = null)
    {
        WriteLog(msg, msgType, ex);
    }
    public static void Write(string msg,
        LogMessageType msgType, LogicType logicType, Exception ex = null)
    {
        WriteLog(msg, msgType, ex, logicType.ToString());
    }
    public static void InitConfig()
    {
        XmlConfigurator.Configure();
    }
    public static void ShutDown()
    {
        LogManager.Shutdown();
    }

    static Dictionary<string, ILog> GetLoggers()
    {
        InitConfig();
        ILog[] allLoggers = LogManager.GetCurrentLoggers();
        Dictionary<string, ILog> dicLoggers = new Dictionary<string, ILog>();
        foreach (var logger in allLoggers)
        {
            dicLoggers.Add(logger.Logger.Name, logger);
        }
        return dicLoggers;
    }
    static void WriteLog(string msg,
        LogMessageType msgType, Exception ex, string logicType = "DefaultLogger")
    {
        if (dicLoggers != null && dicLoggers[logicType] != null)
        {
            switch (msgType)
            {
                case LogMessageType.Debug:
                    dicLoggers[logicType].Debug(msg, ex);
                    break;
                case LogMessageType.Info:
                    dicLoggers[logicType].Info(msg, ex);
                    break;
                case LogMessageType.Warn:
                    dicLoggers[logicType].Warn(msg, ex);
                    break;
                case LogMessageType.Error:
                    dicLoggers[logicType].Error(msg, ex);
                    break;
                case LogMessageType.Fatal:
                    dicLoggers[logicType].Fatal(msg, ex);
                    break;
            }
        }
    }
}

        增加了LogicType這個枚舉，記錄特定業務邏輯日誌時LogProvider.Write("this is Other Info", LogMessageType.Info, LogicType.OtherCustomerLogger)。實際操作時就是根據業務邏輯擴充這個枚舉。
        至此，這個版本已經能夠直接拿到項目中用了，只需配置即可，不需要額外改動代碼。

        後記：在封裝過程中也遇到了一些問題，例如readonly和靜態構造函數的問題，當時對其理解不夠徹底，疑惑了一陣，以後有空一併總結出來。雖然是終結版，能夠作爲項目的穩定版本，但也還有一些不足，例如只想滾動保存6個月的日誌，現在就不知道log4net能不能實現（或者說怎麼實現，如果讓我實現我就只能另外寫個線程每天遍歷一次，如果有6個月前的日誌就將其刪掉）。希望能對讀者有些幫助，如果有什麼錯誤或想法，還望不吝指教，轉載請保留原文鏈接。

        源代碼下載