Log4Net使用详解（续）

说明自从上次在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