log4net

一：简介

        在公司的项目中很少有用到日志记录的功能，一旦有什么问题，但是调试代码，运气好的时候，错误是能被发现的。例如，实现的业务逻辑错误，数据错误，明显的兼容性错误，而有的时候，需要特定时间，特定环境才能出现的错误却不是那么容易的调试发现，于是我希望通过使用日志框架来监视我的代码报错的信息，用来分析修补bug。日志记录往往是软件开发周期中的重要组成部分，它具有以下几个优点：
       1.它可以为开发人员提供应用程序运行时的精确环境，便于发现程序BUG；
       2.程序中加入了日志记录，程序运行过程中就无需人工干预；
       3.日志信息文件可以输出到不同地方，为后来近一步研究扩展该程序提供详细资料。
而要达到这样的功能，在小型的程序中，我们可以自己开发日志记录追踪系统，只是简单实现txt之类的文件操作，便可把调用该方法的地方的日志记录下来。
       Log4net 是基于.net开发的一款非常著名的记录日志开源组件。它最早是2001年7月由NeoWorks Limited启动的项目，基本的框架源于另外的一个非常著名的姐妹组件－log4j。Log4net记录日志的功能非常强大。它可以将日志分不同的等级，比不同的样式，将日志输出到不同的媒介。

二：下载

我们可以到logging.apache.org/log4net/download_log4net.cgi网站上下载LOG4NET的源代码或者编译后的版本。可以在使用log4net的项目中添加log4net.dll引用便可使用，也可以将源代码添加到解决方案中以项目的形式存在，然后调用生成的dll文件。

三：Log4net组成

Log4net 有四种主要的组件，分别是Logger（记录器）, Repository（库）, Appender（附着器）以及 Layout（布局）

1.Logger(记录器)

1.1Logger接口

Logger是应用程序需要交互的主要组件，它用来产生日志消息。产生的日志消息并不直接显示，还要预先经过Layout的格式化处理后才会输出。

Logger提供了多种方式来记录一个日志消息，你可以在你的应用程序里创建多个Logger，每个实例化的Logger对象都被log4net框架作为命名实体(named entity)来维护。这意味着为了重用Logger对象，你不必将它在不同的类或对象间传递，只需要用它的名字为参数调用就可以了。log4net框架使用继承体系，继承体系类似于.NET中的名字空间。也就是说，如果有两个logger,分别被定义为a.b.c和a.b，那么我们说a.b是a.b.c的祖先,每一个logger都继承了祖先的属性。

Log4net框架定义了一个ILog接口，所有的logger类都必须实现这个接口。如果你想实现一个自定义的logger，你必须首先实现这个接口。

Log4net框架定义了一个叫做LogManager的类，用来管理所有的logger对象。它有一个GetLogger()静态方法，用我们提供的名字参数来检索已经存在的Logger对象。如果框架里不存在该Logger对象，它也会为我们创建一个Logger对象。代码如下所示：log4net.ILog log = log4net.LogManager.GetLogger("logger-name");通常来说，我们会以类（class）的类型（type）为参数来调用GetLogger()，以便跟踪我们正在进行日志记录的类。传递的类(class)的类型(type)可以用typeof(Classname)方法来获得，或者可以用如下的反射方法来获得：System.Reflection.MethodBase.GetCurrentMethod().DeclaringType

1.2日志级别

在ILog接口中定义了五种不同的方法可以跟踪一个应用程序，事实上，这五种方法是运作在Logger对象设置的不同日志优先级别上。这几种不同的级别是作为常量定义在log4net.spi.Level类中。你可以在程序中使用任何一种方法。但是在最后的发布中你也许不想让所有的代码来浪费你的CPU周期，因此，框架提供了7种级别和相应的Boolean属性来控制日志记录的类型。优先级从高到低依次排列如下:FATAL > ERROR > WARN > INFO > DEBUG

2.Repository(库)

Repository主要用于负责日志对象组织结构的维护。在log4net的以前版本中，框架仅支持分等级的组织结构(hierarchical organization)。这种等级结构本质上是库的一个实现，并且定义在log4net.Repository.Hierarchy 名字空间中。要实现一个Repository，需要实现log4net.Repository.ILoggerRepository 接口。但是通常并不是直接实现该接口，而是以log4net.Repository.LoggerRepositorySkeleton为基类继承。体系库 (hierarchical repository )则由log4net.Repository.Hierarchy.Hierarchy类实现。

如果你是个log4net框架的使用者，而非扩展者，那么你几乎不会在你的代码里用到Repository的类。相反的，你需要用到LogManager类来自动管理库和日志对象。

3.Appender(符着器)

一个Appender 对象缺省地将所有的日志事件传递到输出流。Appender的过滤器(Appender Filters) 可以按照不同的标准过滤日志事件。在log4net.Filter的名字空间下已经有几个预定义的过滤器。使用这些过滤器，你可以按照日志级别范围过滤日志事件，或者按照某个特殊的字符串进行过滤。你可以在API的帮助文件中发现更多关于过滤器的信息。

Log4net目前支持的输出方式包括：

1 AdoNetAppender
将日志记录到数据库中。可以采用SQL和存储过程两种方式。

2 AnsiColorTerminalAppender
在ANSI 窗口终端写下高亮度的日志事件。

3 AspNetTraceAppender
能用asp.net中Trace的方式查看记录的日志。

4 BufferingForwardingAppender
在输出到子Appenders之前先缓存日志事件。

5 ConsoleAppender
将日志输出到控制台。

6 EventLogAppender
将日志写到Windows Event Log.

7 FileAppender
将日志写到文件中。

8 LocalSyslogAppender
将日志写到local syslog service (仅用于UNIX环境下).
9 MemoryAppender
将日志存到内存缓冲区。

10 NetSendAppender
将日志输出到Windows Messenger service.这些日志信息将在用户终端的对话框中显示。

11 RemoteSyslogAppender
通过UDP网络协议将日志写到Remote syslog service。

12 RemotingAppender
通过.NET Remoting将日志写到远程接收端。

13 RollingFileAppender
将日志以回滚文件的形式写到文件中。

14 SmtpAppender
将日志写到邮件中。

15 TraceAppender
将日志写到.NET trace 系统。

16 UdpAppender
将日志connectionless UDP datagrams的形式送到远程宿主或以UdpClient的形式广播。

4.Layout(布局)

Layout 组件用于向用户显示最后经过格式化的输出信息。输出信息可以以多种格式显示，主要依赖于我们采用的Layout组件类型。可以是线性的或一个XML文件。Layout组件和一个Appender组件一起工作。API帮助手册中有关于不同Layout组件的列表。一个Appender对象，只能对应一个Layout对象。要实现你自己的Layout类，你需要从log4net.Layout.LayoutSkeleton类继承，它实现了ILayout接口。

log4net.Layout.LayoutSkeleton类继承，它实现了ILayout接口。

%m[%message] : 输出的日志消息

%n : 换行

%d[%datetime] :输出当前语句运行的时刻

%r : 输出程序从运行到执行到当前语句时消耗的毫秒数

%d ：当前语句所在的线程ID

%p : 日志的当前优先级别

%c ：当前日志对象的名称

%L : 输出语句所在的行号

%F ：输出语句所在的文件名

%-数字：表示该项的最小长度，如果不够，则用空格填充

在我们开发项目时都会使用到config文件，可以在config文件中配置log4net。这一点Web项目和WinForm项目都是一样的。需要注意的是，因为在Web项目中一般以较低权限的角色来运行Web项目的，所以在使用文件型日志时要注意不要放在本项目根文件夹之外。

还要在顶级节点<configuration>下增加<log4net>子节点。在<log4net>节点下就可以增加<appender>子节点，每个<appender>子节点代表一种记录日志的方式（仅在这里配置了不代表启用了）。
关于对数据库的支持
前面已经说过，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>

在本例中周公采用了将日志记录到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" />

<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" />
<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" />



<appender-ref ref="AdoNetAppender_SQLite" />

<appender-ref ref="RollingFileAppender" />

<appender-ref ref="RollingLogFileAppender_DateFormat" />

</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); 2
   //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方式记录日志都在本地通过测试

posted @ 2013-11-18 00:10 洽洽果阅读(374) 评论(0) 编辑收藏举报

刷新页面返回顶部

实战才是硬道理

log4net

公告