使用Common.Logging+log4net規范日志管理

Common.Logging+（log4net/NLog/）

common logging是一個通用日志接口，log4net是一個強大的具體實現，也可以用其它不同的實現，如EntLib的日志、NLog等。

Common.Logging可以通過修改配置，更換不同的日志實現類，而不需要修改任何代碼。

 

.net 項目使用CommonLogging：

1、添加必要的程序集：Common.Logging.dll、Common.Logging.Core.dll、Common.Logging.log4net1215.dll、log4net.dll

其中需要特別注意Common.Logging.log4net1215.dll、log4net.dll的版本必須匹配，建議使用VS的NuGet添加引用，添加時有詳細的說明。

2、寫配置文件

  <configSections>
    <sectionGroup name="common">
      <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" />
    </sectionGroup>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
  </configSections>
  <common>
    <!--[DEBUG < INFO < WARN < ERROR < FATAL]-->
    <logging>
      <!--<factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging">
        <arg key="level" value="WARN" />
        <arg key="showLogName" value="true" />
        <arg key="showDataTime" value="true" />
        <arg key="dateTimeFormat" value="yyyy/MM/dd HH:mm:ss:fff" />
      </factoryAdapter>-->
      <factoryAdapter type="Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter, Common.Logging.Log4Net1215">
        <!--FILE
              FILE-WATCH
              INLINE
              EXTERNAL-->
        <!--<arg key="configType" value="INLINE" />-->
              <arg key="configType" value="FILE-WATCH" />
              <arg key="configFile" value="~/log4net.config" />
        <!--log4net使用獨立的配置文件-->
      </factoryAdapter>
    </logging>
  </common>  

<arg key="configType" value="FILE-WATCH" />

<arg key="configFile" value="~/log4net.config" />

以上配置表示將log4net的配置放到單獨的文件中

 

<!--<arg key="configType" value="INLINE" />-->

這個表示log4net的配置直接寫在配置文件里

log4net.config文件的內容如下：

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
  <!--<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %-5level %logger %ndc - %message%newline" />
      </layout>
    </appender>-->
  <appender name="InfoRollingLogFileAppender" type="log4net.Appender.RollingFileAppender, log4net">
    <param name="LockingModel" type="log4net.Appender.FileAppender+MinimalLock" />
    <param name="File" value="logs/" />
    <param name="StaticLogFileName" value="false" />
    <param name="DatePattern" value="'Info-'yyyy-MM-dd.'log'" />
    <param name="AppendToFile" value="true" />
    <param name="MaxSizeRollBackups" value="10" />
    <param name="MaximumFileSize" value="5MB" />
    <param name="RollingStyle" value="Date" />
    <!--Size ==- Date-->
    <layout type="log4net.Layout.PatternLayout">
      <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter">
      <levelMin value="DEBUG"/>
      <levelMax value="WARN"/>
    </filter>
  </appender>
  <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender, log4net">
    <param name="LockingModel" type="log4net.Appender.FileAppender+MinimalLock" />
    <param name="File" value="logs/" />
    <param name="StaticLogFileName" value="false" />
    <param name="DatePattern" value="'Error-'yyyy-MM-dd.'log'" />
    <param name="AppendToFile" value="true" />
    <param name="MaxSizeRollBackups" value="10" />
    <param name="MaximumFileSize" value="5MB" />
    <param name="RollingStyle" value="Date" />
    <!--Size ==- Date-->
    <layout type="log4net.Layout.PatternLayout">
      <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter">
      <levelMin value="ERROR"/>
      <levelMax value="FATAL"/>
    </filter>
  </appender>
  <appender name="DefaultRollingLogFileAppender" type="log4net.Appender.RollingFileAppender, log4net">
    <param name="LockingModel" type="log4net.Appender.FileAppender+MinimalLock" />
    <param name="File" value="logs/" /><!--文件保存的路徑-->
    <param name="StaticLogFileName" value="false" /><!--文件名動態生成-->
    <param name="DatePattern" value="'Default-'yyyy-MM-dd.'log'" /><!--文件名命名規則-->
    <param name="AppendToFile" value="true" />
    <param name="MaxSizeRollBackups" value="10" />
    <param name="MaximumFileSize" value="5MB" /><!--文件超過5M將創建新文件-->
    <param name="RollingStyle" value="Date" />
    <!--Size ==- Date-->
    <layout type="log4net.Layout.PatternLayout">
      <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" /><!--日志內容格式-->
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter"><!--日志級別過濾器：此附加器只附加指定級別的日志-->
      <levelMin value="DEBUG"/>
      <levelMax value="FATAL"/>
    </filter>
  </appender>
  <root>
    <level value="ALL" />
    <appender-ref ref="RollingLogFileAppender" />
    <appender-ref ref="InfoRollingLogFileAppender" />
  </root>
  <logger name="MyApp.DataAccessLayer">
    <level value="DEBUG" />
  </logger>
  <!-- ALL DEBUG INFO WARN ERROR FATAL OFF [DEBUG < INFO < WARN < ERROR < FATAL] 大范圍 到 小范圍-->
  <logger name="LogDemoWeb._Default" debug="false">
    <level value="ALL" />
    <appender-ref ref="DefaultRollingLogFileAppender" />
  </logger>
</log4net>

這個文件建議從下往上讀，上文紅色部分是日志記錄器一共三個：

一個root日志記錄器,log4net只允許一個root日志記錄器，用於做全局日志輸出

<root>
<level value="ALL" />
<appender-ref ref="RollingLogFileAppender" />
<appender-ref ref="InfoRollingLogFileAppender" />
</root>

其中： <level value="ALL" />表示記錄器會將所有級別的日志提交給這里配置的附加器

這里配置了兩個附加器：RollingLogFileAppender和InfoRollingLogFileAppender（配置文件中的appender節點）

兩個logger：
第一個：

<logger name="MyApp.DataAccessLayer">
<level value="DEBUG" />
</logger>

沒有配置appender（附加器）將不會輸出日志

第二個：

<logger name="LogDemoWeb._Default" debug="false">
<level value="ALL" />
<appender-ref ref="DefaultRollingLogFileAppender" />
</logger>

配置了DefaultRollingLogFileAppender附加器，將按上面對應的附加器輸出日志。

附加器（appender）可以定義多個，它只是一個聲明，是否使用還是要看日志記錄器是否引用了。

這個配置文件中DefaultRollingLogFileAppender 附加器（appender）的配置示例如下：

<appender name="DefaultRollingLogFileAppender" type="log4net.Appender.RollingFileAppender, log4net">
<param name="LockingModel" type="log4net.Appender.FileAppender+MinimalLock" />
<param name="File" value="logs/" /><!--文件保存的路徑-->
<param name="StaticLogFileName" value="false" /><!--文件名動態生成-->
<param name="DatePattern" value="'Default-'yyyy-MM-dd.'log'" /><!--文件名命名規則-->
<param name="AppendToFile" value="true" />
<param name="MaxSizeRollBackups" value="10" />
<param name="MaximumFileSize" value="5MB" /><!--文件超過5M將創建新文件-->
<param name="RollingStyle" value="Date" />
<!--Size ==- Date-->
<layout type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" /><!--日志內容格式-->
</layout>
<filter type="log4net.Filter.LevelRangeFilter"><!--日志級別過濾器：此附加器只附加指定級別的日志-->
<levelMin value="DEBUG"/>
<levelMax value="FATAL"/>
</filter>
</appender>

附加器的配置要點：

1、name="DefaultRollingLogFileAppender"
定義附加器的名稱，方便日志記錄器調用
2、type="log4net.Appender.RollingFileAppender, log4net"
附加器的類型，附加器的具體實現類，log4net提供多種日志存儲（附加）方式，在這里就是不同的附加器實現類。
詳細的附加器類型可以查看官方文檔中的appender章節：
http://logging.apache.org/log4net/release/manual/introduction.html

做好以上配置后代碼就相當簡單了
一般我是這樣寫的：

    /// <summary>
    /// Common.Logging日志示例
    /// </summary>
    public class LogDemoBLL1
    {
        //獲取ILog實例
        public static ILog logObj = Common.Logging.LogManager.GetLogger<LogDemoBLL1>();
        public LogDemoBLL1()
        {

        }
        public void Method1()
        {

            logObj.Trace("This is a Trace Log!");
            logObj.Debug("This is a Debug Log!");
            logObj.Info("This is a Info Log!");
            logObj.Warn("This is a Warn Log!");
            //將在Info-yyyy-MM-dd.log輸出以下內容(根據配置輸出有可能不一樣)：
            //2016-08-18 21:28:44,095 [10] DEBUG LogDemo.BLL.LogDemoBLL1 - This is a Debug Log!
            //2016-08-18 21:28:44,101 [10] INFO  LogDemo.BLL.LogDemoBLL1 - This is a Info Log!
            //2016-08-18 21:28:44,101 [10] WARN  LogDemo.BLL.LogDemoBLL1 - This is a Warn Log!

            logObj.Error("This is a Error Log!");
            logObj.Fatal("This is a Fatal Log!");
            //將在Error-yyyy-MM-dd.log輸出以下內容(根據配置輸出有可能不一樣)：
            //2016-08-18 21:28:44,101 [10] ERROR LogDemo.BLL.LogDemoBLL1 - This is a Error Log!
            //2016-08-18 21:28:44,102 [10] FATAL LogDemo.BLL.LogDemoBLL1 - This is a Fatal Log!
            try
            {
                throw new Exception("Throw an Exception For Test");
            }
            catch (Exception ex)
            {
                //異常日志
                logObj.Error(ex);
                //將在Error-yyyy-MM-dd.log輸出以下內容(根據配置輸出有可能不一樣)：
                //2016-08-18 21:28:44,106 [10] ERROR LogDemo.BLL.LogDemoBLL1 - System.Exception: Throw an Exception For Test
                //  在 LogDemo.BLL.LogDemoBLL1.Method1() 位置 E:\MyWork\CSharpProject\CSharp\LogDemo\LogDemo\LogDemo\BLL\LogDemoBLL1.cs:行號 34

            }

        }
    }

 

如果有需要log4net還可以通過log4net.Appender.MemoryAppender類將日志顯示在程序界面上。具體用法就不詳細介紹了。

關於log4net的詳細介紹可以看下面的文章：
http://www.cnblogs.com/dragon/archive/2005/03/24/124254.html
Common.Logging官方網站：
http://commons.apache.org/proper/commons-logging/
Common.Logging中文介紹：
http://www.cnblogs.com/chen-whutgis/p/4129271.html
log4net官方網站
http://logging.apache.org/log4net/release/manual/introduction.html
Log4net的配置學習與總結
http://blog.csdn.net/wziyx513225244/article/details/6628627

另外安利一些高級打開方式：
Log4net 寫文件日志與數據庫日志
http://blog.csdn.net/manbufenglin/article/details/7168472
程序的記事本--log4net：這里介紹了常有的日志管理框架，值得一看。
http://blog.csdn.net/zhang_xinxiu/article/details/40649791