Log4net 使用介绍

Log4net简介

•Log4net是一种能够帮助程序员将日志信息输出到不同的对象（txt文本，windows日志记录文件）中的工具；一旦应用程序出现了问题，它有助于查找问题所在。它可以在运行时记录日志，由于log4net包的设计，不会给程序带来高性能的成本损失，它的记录（或者说记录时间可忽略）速度是至关重要的。

•与此同时，输出的日志信息可能会越来越多，导致日志文件变得很大。Log4net的一个显著特征就是引进了分层记录器的概念，使用这些记录器，可以选择性的将日志信息最小粒度的输出；

•Log4net设计时始终贯穿两个宗旨：速度和伸缩性；

 

Log4net的优点

•几乎所有的大型应用都会有自己的用于跟踪调试的API。因为一旦程序被部署以后，就不太可能再利用专门的调试工具了。然而一个管理员可能需要有一套强大的日志系统来诊断和修复配置上的问题。

•经验表明，日志记录往往是软件开发周期中的重要组成部分。它具有以下几个优点：它可以提供应用程序运行时的精确环境，可供开发人员尽快找到应用程序中的Bug；一旦在程序中加入了Log 输出代码，程序运行过程中就能生成并输出日志信息而无需人工干预。另外，日志信息可以输出到不同的地方（控制台，文件等）以备以后研究之用。

•Log4.net 具有可靠，快速和可扩展性等功能；

•Log4net就是为这样一个目的设计的，用于.NET开发环境的日志记录包。

 

Log4的结构

•Log4net有三个主要的组件：loggers记录器，appenders附属器，layout布局(官网上没写Respository库)；

•Logger是应用程序需要交互的主要组件，它用来产生日志消息。产生的日志消息并不直接显示，还要预先经过Layout的格式化处理后才会输出(后面再配置文件中会讲到)；

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

•Log4net框架定义了一个叫做LogManager的类，用来管理所有的logger对象。它有一个GetLogger()静态方法，用我们提供的名字参数来检索已经存在的Logger对象。如果框架里不存在该Logger对象，它也会为我们创建一个Logger对象。代码如下所示：

public interface ILog
{  
    void Debug(object message);  
    void Info(object message);  
    void Warn(object message); 
     void Error(object message);  
    void Fatal(object message);
    //以上的每一个方法都有一个重载的方法，用来支持异常处理。
    //每一个重载方法都如下所示，有一个异常类型的附加参数。  
    void Debug(object message, Exception ex);
}

日志的级别

•正如你在ILog的接口中看到的一样，有五种不同的方法可以跟踪一个应用程序。事实上，这五种方法是运作在Logger对象设置的不同日志优先级别上。这几种不同的级别是作为常量定义在log4net.Core.Level类中。你可以在程序中使用任何一种方法。但是在最后的发布中你也许不想让所有的代码来浪费你的CPU周期，你可能就使用其中的一种或者两种。因此，框架提供了7种级别和相应的Boolean属性来控制日志记录的类型。

•在log4net框架里，通过设置配置文件，每个日志对象都被分配了一个日志优先级别。如果没有给一个日志对象显式地分配一个级别，那么该对象会试图从他的祖先继承一个级别值。

•ILog接口的每个方法都有一个预先定义好了的级别值。正如你在表1看到的，ILog的Inof()方法具有INFO级别。同样的，以此类推，Error()方法具有ERROR级别。当我们使用以上的任何一种方法时，log4net框架会检查日志对象logger的级别和方法的级别。只有当方法的级别高于日志级别时，日志请求才会被接受并执行。

•举例说明，当你创建了一个日志对象，并且把他的级别设置为INFO。于是框架会设置日志的每个Boolean属性。当你调用相应的日志方法时，框架会检查相应的Boolean属性，以决定该方法能不能执行。如下的代码：

Logger.Info("message");Logger.Debug("message");
Logger.Warn("message");

对于第一种方法，Info()的级别等与日志的级别（INFO），因此日志请求会被传递，我们可以得到输出结果”message”。

对于第二种方法，Debug()的级别低于日志对象logger的日志级别(INFO)，因此，日志请求被拒绝了，我们得不到任何输出。同样的针对第三行语句，我们可以很容易得出结论。

在表1中有两个特殊的级别：ALL和OFF。ALL表示允许所有的日志请求。OFF是拒绝所有的请求。

你也可以显式地检查Logger对象的Boolean属性，如下所示：

if (logger.IsDebugEnabled){  Logger.Debug("message");}

在程序中使用log4net

•要对自己的程序进行日志记录，则首先要启动long4net引擎，也就是要对先前提到的三种组件进行配置，一般有两种方法进行配置：在单独的文件中进行配置或者在代码中定义配置，这里我们选择前者，原因归结于以下几点：

–不需要重新编译源代码就能改变配置；

–可以在程序正在运行的时候就改变配置；

在程序中使用log4net 定义配置文件

Ø一般我们是直接对项目添加一个App.cofig配置文件，编译时，会自动生成一个AppName.config.exe.config。注意，在VS中新添App.config配置文件时，请不要更改App.config的文件名，比如改为NuGet.config，这样会导致在源程序中读取配置文件时，编译会失败。可能是微软的编译器会去自动找对应的App.config配置文件，没找到就编译通不过。大家可以自己动手去验证一下；

log4net框架会在相对于AppDomain.CurrentDomain.BaseDirectory 属性定义的目录路径下查找配置文件。框架在配置文件里要查找的唯一标识是<log4net>标签。

在程序中使用log4net <root>

<root>

  <level value="WARN" />

  <appender-ref ref="LogFileAppender" />

  <appender-ref ref="ConsoleAppender" />

</root>

  在框架的体系里，所有的日志对象都是根日志(root logger)的后代。 因此如果一个日志对象没有在配置文件里显式定义，则框架使用根日志中定义的属性。在<root>标签里，可以定义level级别值和Appender的列表。如果没有定义LEVEL的值，则缺省为DEBUG。可以通过<appender-ref>标签定义日志对象使用的Appender对象。<appender-ref>声明了在其他地方定义的Appender对象的一个引用。

在一个logger对象中的设置会覆盖根日志的设置。而对Appender属性来说，子日志对象则会继承父日志对象的Appender列表。这种缺省的行为方式也可以通过显式地设定<logger>标签的additivity属性为false而改变。

 <logger name="testApp.Logging" additivity="false">

</logger>

Additivity的值缺省是true.

在程序中使用log4net<logger>

<logger name="testApp.Logging">

    <level value="DEBUG"/>

</logger>

  <logger> 元素预定义了一个具体日志对象的设置。然后通过调用LogManager.GetLogger(“testAPP.Logging”)函数，你可以检索具有该名字的日志。如果LogManager.GetLogger(…)打开的不是预定义的日志对象，则该日志对象会继承根日志对象的属性。知道了这一点，我们可以说，其实<logger>标签并不是必须的。

在程序中使用log4net
 log4net.Layout.PatternLayout中的转换模式(ConversionPattern)

%m(message):输出的日志消息，如ILog.Debug(…)输出的一条消息

%n(new line):换行

%d(datetime):输出当前语句运行的时刻

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

%t(thread id):当前语句所在的线程ID

%p(priority): 日志的当前优先级别，即DEBUG、INFO、WARN…等

%c(class):当前日志对象的名称

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

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

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

•例如，转换模式为%r [%t]%-5p %c - %m%n 的 PatternLayout 将生成类似于以下内容的输出：

•176 [main] INFO  org.foo.Bar - Located nearest gas station.

在程序中使用log4net <filter>

最后，让我们看看在Appender元素里的<filter>标签。它定义了应用到Appender对象的过滤器。本例中，我们使用了LevelRangeFilter过滤器,它可以只记录LevelMin和LevelMax参数指定的日志级别之间的日志事件。可以在一个Appender上定义多个过滤器（Filter）,这些过滤器将会按照它们定义的顺序对日志事件进行过滤。其他过滤器的有关信息可以在log4net的SDK文档中找到。

使用配置文件

当我们创建了上面的配置文件后，我们接下来需要把它和我们的应用联系起来。缺省的，每个独立的可执行程序集都会定义它自己的配置。log4net框架使用log4net.Config. XmlConfiguratorAttribute

在程序集的级别上定义配置文件。

例如：可以在项目的AssemblyInfo.cs文件里添加以下的语句

[assembly:log4net.Config. XmlConfiguratorAttribute(ConfigFile="filename",  ConfigFileExtension="ext",Watch=true/false)]   

üConfigFile:指出了我们的配置文件的路径及文件名，包括扩展名。

ü ConfigFileExtension:如果我们对被编译程序的程序集使用了不同的文件扩展名，那么我们需要定义这个属性，缺省的，程序集的配置文件扩展名为”config”。

ü   Watch (Boolean属性): log4net框架用这个属性来确定是否需要在运行时监视文件的改变。如果这个属性为true,那么FileSystemWatcher将会被用来监视文件的改变，重命名，删除等事件。

其中：ConfigFile和ConfigFileExtension属性不能同时使用，ConfigFile指出了配置文件的名字，例如，ConfigFile=”Config.txt”

ConfigFileExtension则是指明了和可执行程序集同名的配置文件的扩展名，例如，应用程序的名称是”test.exe”,ConfigFileExtension=”txt”,则配置文件就应该是”test.exe.txt” 

ü 创建或获取日志对象：日志对象会使用在配置文件里定义的属性。如果某个日志对象没有事先在配置文件里定义，那么框架会根据继承结构获取祖先节点的属性，最终的，会从根日志获取属性，如下所示：

Log4net.ILog log = Log4net.LogManager.GetLogger("MyLogger");

ü输出日志信息

可以使用ILog的几种方法输出日志信息。你也可以在调用某方法前先检查IsXXXEnabled布尔变量，再决定是否调用输出日志信息的函数，这样可以提高程序的性能。因为框架在调用如ILog.Debug(…)这样的函数时，也会先判断是否满足Level日志级别条件。

if (log.IsDebugEnabled) log.Debug("message");

if (log.IsInfoEnabled) log.Info("message);