Log4Net使用詳解（續）

標籤：log4net C# ASP.NET 休閒 WinForm

原創作品，允許轉載，轉載時請務必以超鏈接形式標明文章 原始出處 、作者信息和本聲明。否則將追究法律責任。http://zhoufoxcn.blog.51cto.com/792419/429988

說明自從上次在2008年在博客上發表過有關log4net的用法介紹文章之後（網址：http://blog.csdn.net/zhoufoxcn/archive/2008/03/26/2220533.aspx），有不少朋友在博文下留言詢問一些細節，現在就一些比較普遍的問題做一些稍微深入的解答，希望大家滿意。

首先說明一點的是，log4net解決的問題是提供一個記錄日誌的框架，它提供了向多種目標寫入的實現，比如利用log4net可以方便地將日誌信息記錄到文件、控制檯、Windows事件日誌和數據庫（包括MS SQL Server, Access, Oracle9i,Oracle8i,DB2,SQLite）中，一般來說我們只需要提供一個描述性的字符串，然後log4net就會自動提供有關運行時的一些信息。

Log4Net的版本仍是1.2.10（2008年我寫博文的時候也是這個版本），有.NET1.0和.NET1.1和.NET2.0版本，如果有正在使用高於.NET2.0開發的也不用擔心，可以直接引用這個類庫，像在.NET2.0中開發一樣，它的網址是：http://logging.apache.org/log4net/

關於在Web中支持的問題

在我們開發項目時都會使用到config文件，可以在config文件中配置log4net。這一點Web項目和WinForm項目都是一樣的。需要注意的是，因爲在Web項目中一般以較低權限的角色來運行Web項目的，所以在使用文件型日誌時要注意不要放在本項目根文件夾之外。

在config文件中的配置

要使用log4net，首先要在config文件的<configSections>節點中增加配置（如果沒有這個節點請手動增加），如下：

 

<configSections>
  <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
</configSections>

除此之外，還要在頂級節點<configuration>下增加<log4net>子節點。在<log4net>節點下就可以增加<appender>子節點，每個<appender>子節點代表一種記錄日誌的方式（僅在這裏配置了不代表啓用了）。

具體說來有如下Appender:

AdoNetAppender：利用ADO.NET記錄到數據庫的日誌。

AnsiColorTerminalAppender：在ANSI 窗口終端寫下高亮度的日誌事件。

AspNetTraceAppender：能用asp.net中Trace的方式查看記錄的日誌。

BufferingForwardingAppender：在輸出到子Appenders之前先緩存日誌事件。

ConsoleAppender：將日誌輸出到控制檯。

EventLogAppender：將日誌寫到Windows Event Log.

FileAppender：將日誌寫到文件中。

LocalSyslogAppender：將日誌寫到local syslog service (僅用於UNIX環境下).

MemoryAppender：將日誌存到內存緩衝區。

NetSendAppender：將日誌輸出到Windows Messenger service.這些日誌信息將在用戶終端的對話框中顯示。

RemoteSyslogAppender：通過UDP網絡協議將日誌寫到Remote syslog service。

RemotingAppender：通過.NET Remoting將日誌寫到遠程接收端。

RollingFileAppender：將日誌以回滾文件的形式寫到文件中。

SmtpAppender：將日誌寫到郵件中。

TraceAppender：將日誌寫到.NET trace 系統。

UdpAppender：將日誌connectionless UDP datagrams的形式送到遠程宿主或以UdpClient的形式廣播。

關於使用log4net中可能會使用到的一些參數

%m(message):輸出的日誌消息，如ILog.Debug(…)輸出的一條消息

%n(new line):換行

%d(datetime):輸出當前語句運行的時刻

%r(run time):輸出程序從運行到執行到當前語句時消耗的毫秒數

%t(thread id):當前語句所在的線程ID

%p(priority): 日誌的當前優先級別，即DEBUG、INFO、WARN…等

%c(class):當前日誌對象的名稱，例如：

%f(file):輸出語句所在的文件名。

%l(line)：輸出語句所在的行號。

%數字：表示該項的最小長度，如果不夠，則用空格填充，如“%-5level”表示level的最小寬度是5個字符，如果實際長度不夠5個字符則以空格填充。

下面以一個實際的例子來說明問題，比如在配置中有“%date [%thread] (%file:%line) %-5level %logger [%property{NDC}] - %message%newline”，那麼實際的日誌中會是如下格式：

“記錄時間：2010-11-17 16:16:36,561 線程ID:[9] 日誌級別：文件：所在行ERROR 出錯類：Log4NetDemo.Program property:[(null)] - 錯誤描述：error

System.Exception: 在這裏發生了一個異常,Error Number:2036084948”

關於對數據庫的支持

前面已經說過，log4net是支持包括MS SQL Server, Access, Oracle9i,Oracle8i,DB2,SQLite在內的數據庫的，如果是文件型數據庫（如Access或SQLite）的話就需要指定數據庫文件的位置（在Web中最好指定在有讀寫權限的文件夾下，並且實現創建好表），如果是網絡數據庫就需要指定正確的數據庫連接字符串。

比如要記錄到Oracle數據庫中，在配置文件中可以增加一個< appender>節點，配置如下：

 

<appender name="AdoNetAppender_Oracle" type="log4net.Appender.AdoNetAppender">
      <connectionType value="System.Data.OracleClient.OracleConnection, System.Data.OracleClient" />
      <connectionString value="data source=[mydatabase];User ID=[user];Password=[password]" />
      <commandText value="INSERT INTO Log (Datetime,Thread,Log_Level,Logger,Message) VALUES (:log_date, :thread, :log_level, :logger, :message)" />
      <bufferSize value="128" />
      <parameter>
        <parameterName value=":log_date" />
        <dbType value="DateTime" />
        <layout type="log4net.Layout.RawTimeStampLayout" />
      </parameter>
      <parameter>
        <parameterName value=":thread" />
        <dbType value="String" />
        <size value="255" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%thread" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value=":log_level" />
        <dbType value="String" />
        <size value="50" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%level" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value=":logger" />
        <dbType value="String" />
        <size value="255" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%logger" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value=":message" />
        <dbType value="String" />
        <size value="4000" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%message" />
        </layout>
      </parameter>
    </appender>

當然從上面的配置中的SQL語句中可以看得出這個表的參數，日誌表的創建語句如下：

 

create table log (
   Datetime timestamp(3),
   Thread varchar2(255),
   Log_Level varchar2(255),
   Logger varchar2(255),
   Message varchar2(4000)
   );

 

在本例中周公採用了將日誌記錄到SQLite這個單機數據庫的方式，並且還將記錄記錄日誌時的文件名和行號，創建SQLite的SQL語句如下：

 

CREATE TABLE Log (
    LogId        INTEGER PRIMARY KEY,
    Date        DATETIME NOT NULL,
    Level        VARCHAR(50) NOT NULL,
    Logger        VARCHAR(255) NOT NULL,
    Source        VARCHAR(255) NOT NULL,
    Message        TEXT DEFAULT NULL
    );

增加的< appender>節點配置如下：

 

<appender name="AdoNetAppender_SQLite" type="log4net.Appender.AdoNetAppender">
  <bufferSize value="100" />
  <connectionType value="System.Data.SQLite.SQLiteConnection, System.Data.SQLite, Version=1.0.66.0, Culture=neutral" />
  <!--SQLite連接字符串-->
  <connectionString value="Data Source=c:\\log4net.db;Version=3;" />
  <commandText value="INSERT INTO Log (Date, Level, Logger,Source, Message) VALUES (@Date, @Level, @Logger, @Source, @Message)" />
  <parameter>
    <parameterName value="@Date" />
    <dbType value="DateTime" />
    <layout type="log4net.Layout.RawTimeStampLayout" />
  </parameter>
  <parameter>
    <parameterName value="@Level" />
    <dbType value="String" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%level" />
    </layout>
  </parameter>
  <parameter>
    <parameterName value="@Logger" />
    <dbType value="String" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%logger" />
    </layout>
  </parameter>
  <parameter>
    <parameterName value="@Source" />
    <dbType value="String" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%file:%line" />
    </layout>
  </parameter>
  <parameter>
    <parameterName value="@Message" />
    <dbType value="String" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%message" />
    </layout>
  </parameter>
</appender>

從上面的配置中可以看出插入數據的SQL語句及參數信息，下面的<parameter>節點就是指定插入的數據，比如我們指定SQL語句中的"@Source"參數來源於log4net中的"%file:%line"參數，也就是這兩個參數用“:”用連接起來。

控制日誌文件大小的問題

對於一個長時間使用並且有大量業務日誌的系統來說，如果使用FileAppender將日誌一直記錄到一個文件中會引起性能低下的問題，我曾見過有個系統的日誌文件達到了800多M，最後系統無法及時響應了，在這種情況下可考慮使用RollingFileAppender循環記錄日誌，一種是指定文件的最大長度，如果超過了就重新生成一個文件，如下面的配置：

 

<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
  <file value="RollingFileAppender_log.txt" />
  <appendToFile value="true" />
  <rollingStyle value="Size" />
  <maxSizeRollBackups value="10" />
  <maximumFileSize value="100KB" />
  <staticLogFileName value="true" />
  <layout type="log4net.Layout.PatternLayout">
    <conversionPattern value="%date [%thread] (%file:%line) %-5level %logger [%property{NDC}] - %message%newline" />
  </layout>
</appender>

在上面的配置中，每個日誌文件最大100KB，最大日誌文件個數是10生成的日誌文件名會是RollingFileAppender_log.txt.1, RollingFileAppender_log.txt.2 ... RollingFileAppender_log.txt.10，如果記錄的日誌超過10個，會從RollingFileAppender_log.txt.1開始覆蓋。

還有一種方式就是按照日期記錄日誌，它的配置如下：

 

<appender name="RollingLogFileAppender_DateFormat" type="log4net.Appender.RollingFileAppender">
  <file value="RollingLogFileAppender_DateFormat_log.txt" />
  <appendToFile value="true" />
  <rollingStyle value="Date" />
  <!--<datePattern value="yyyyMMdd-HHmm" />-->
  <datePattern value="yyyyMMdd" />
  <layout type="log4net.Layout.PatternLayout">
    <conversionPattern value="%date [%thread](%file:%line) %-5level %logger [%property{NDC}] - %message%newline" />
  </layout>
</appender>

這樣一來，每天的日誌都寫入到一個文件中，當天的日誌文件名爲“RollingLogFileAppender_DateFormat_log.txt”，非當天的日誌都會帶上當天的日期，如“RollingLogFileAppender_DateFormat_log.txt20101117”表示2010年11月17日的日誌，這樣就可以很方便地區分每天的日誌了，將來查找起來也相當方便。

在配置中啓用和關閉日誌

在config文件中可以很方便地關閉和啓用日誌，就是在<root>進行配置，如下就是一個例子：

 

<root>
  <!--文件形式記錄日誌-->
  <appender-ref ref="LogFileAppender" />
  <!--控制檯控制顯示日誌-->
  <appender-ref ref="ConsoleAppender" />
  <!--Windows事件日誌-->
  <!--<appender-ref ref="EventLogAppender" />-->
  <!--SQLite事件日誌-->
  <appender-ref ref="AdoNetAppender_SQLite" />
  <!--RollingFileAppender事件日誌-->
  <appender-ref ref="RollingFileAppender" />
  <!--RollingFileAppender事件日誌，每天一個日誌-->
  <appender-ref ref="RollingLogFileAppender_DateFormat" />
  <!-- 如果不啓用相應的日誌記錄，可以通過這種方式註釋掉
  <appender-ref ref="AdoNetAppender_Access" />
  -->
</root>

在上面的例子中可以看出，如果想增加日誌輸出目的地，增加<appender-ref>節點就是了，注意後面的ref是在config中配置的appender name，如果想要取消，刪除或者註釋掉這行就可以了。

Log4Net的使用

首先要添加config文件，在類庫項目、命令行程序及WinForm中添加的是app.config，在WebForm中添加的是web.config。

下面是一個在WinForm項目中的使用Log4Net的例子：

 

using System;
using System.Collections.Generic;
using System.Text;
using log4net;
using System.Reflection;

//注意下面的語句一定要加上，指定log4net使用.config文件來讀取配置信息
//如果是WinForm（假定程序爲MyDemo.exe，則需要一個MyDemo.exe.config文件）
//如果是WebForm，則從web.config中讀取相關信息
[assembly: log4net.Config.XmlConfigurator(Watch = true)]
namespace Log4NetDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            Random random = new Random();
            for (int i = 0; i < 1; i++)
            {
                //創建日誌記錄組件實例
                //ILog log = log4net.LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

                ILog log=log4net.LogManager.GetLogger(typeof(Program));
                //記錄錯誤日誌
                //log.Error("error", new Exception("在這裏發生了一個異常,Error Number:"+random.Next()));
                //記錄嚴重錯誤
                //log.Fatal("fatal", new Exception("在發生了一個致命錯誤，Exception Id："+random.Next()));
                //記錄一般信息
                //log.Info("提示：系統正在運行");
                //記錄調試信息
                //log.Debug("調試信息：debug");
                //記錄警告信息
                //log.Warn("警告：warn");
            }
            Console.WriteLine("日誌記錄完畢。");
            Console.Read();

        }
    }
}

在WebForm中也可以使用Log4net，下面是一個在ASP.NET中使用Log4Net的例子：

 

using System;
using System.Collections.Generic;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using log4net;
using System.Reflection;

[assembly: log4net.Config.XmlConfigurator(Watch = true)]
public partial class _Default : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {
        if (!Page.IsPostBack)
        {
            Random random = new Random();
            for (int i = 0; i < 1; i++)
            {
                //創建日誌記錄組件實例
                ILog log = log4net.LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

                //ILog log = log4net.LogManager.GetLogger(typeof(Program));
                //記錄錯誤日誌
                //log.Error("error", new Exception("在這裏發生了一個異常,Error Number:"+random.Next()));
                //記錄嚴重錯誤
                //log.Fatal("fatal", new Exception("在發生了一個致命錯誤，Exception Id："+random.Next()));
                //記錄一般信息
                //log.Info("提示：系統正在運行");
                //記錄調試信息
                //log.Debug("調試信息：debug");
                //記錄警告信息
                log.Warn("警告：warn");
                Response.Write("日誌記錄完畢。");
            }
        }
    }
}

可以看出它們的代碼基本沒有區別。

下面是一個在WinForm下的config文件的完整配置，該配置文件所使用的代碼就是在上面所使用到的代碼，使用LogFileAppender、ConsoleAppender、EventLogAppender、AdoNetAppender_SQLite、RollingFileAppender、RollingLogFileAppender_DateFormat方式記錄日誌都在本地通過測試。完整的config請見附件。

總結：

本篇主要是補充在上一篇關於Log4Net中未盡之處，並集中詳盡回答了一些朋友在該篇博文下的提問，如有未盡之處，請在本篇下留言。如有初學者碰巧路過不知config文件爲何物，請看《asp.net夜話之十一：web.config詳解》，網址是：http://zhoufoxcn.blog.51cto.com/792419/166441。

周公
2010-11-23

本文出自 “周公（周金橋）的專欄” 博客，請務必保留此出處http://zhoufoxcn.blog.51cto.com/792419/429988