log4.net使用指南

1、简介

　　1.1 Log4net的优点：

　　⼏乎所有的⼤型应⽤都会有⾃⼰的⽤于跟踪调试的API。因为⼀旦程序被部署以后，就不太可能再利⽤专门的调试⼯具了。然⽽⼀个管理员可能需要有⼀套强⼤的⽇志系统来诊断和修复配置上的问题。经验表明，⽇志记录往往是软件开发周期中的重要组成部分。它具有以下⼏个优点：它可以提供应⽤程序运⾏时的精确环境，可供开发⼈员尽快找到应⽤程序中的Bug；⼀旦在程序中加⼊了Log 输出代码，程序运⾏过程中就能⽣成并输出⽇志信息⽽⽆需⼈⼯⼲预。另外，⽇志信息可以输出到不同的地⽅（控制台，⽂件等）以备以后研究之⽤。　　Log4net就是为这样⼀个⽬的设计的，⽤于.NET开发环境的⽇志记录包。　　1.2 Log4net的安装：2 、Log4net的结构

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

　　　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，你必须⾸先实现这个接⼝。你可以参考在/extension⽬录下的⼏个例⼦。ILog接⼝的定义如下：

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); // ...

//Boolean 属性⽤来检查Logger的⽇志级别 //（我们马上会在后⾯看到⽇志级别） bool isDebugEnabled;

bool isInfoEnabled;

//… 其他⽅法对应的Boolean属性}

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

尽管符号长了⼀些，但是后者可以⽤于⼀些场合，⽐如获取调⽤⽅法的类(class)的类型(type)。2.1.2 ⽇志的级别

正如你在ILog的接⼝中看到的⼀样，有五种不同的⽅法可以跟踪⼀个应⽤程序。事实上，这五种⽅法是运作在Logger对象设置的不同⽇志优先级别上。这⼏种不同的级别是作为常量定义在log4net.spi.Level类中。你可以在程序中使⽤任何⼀种⽅法。但是在最后的发布中你也许不想让所有的代码来浪费你的CPU周期，因此，框架提供了7种级别和相应的Boolean属性来控制⽇志记录的类型。Level有以下⼏种取值

级别OFFFATALRRORWARNINFO允许的⽅法 void Fatal(...);void Error(...);void Warn(...);void Info(...);Boolean属性

优先级别Highest

bool IsFatalEnabled; bool IsErrorEnabled; bool IsWarnEnabled; bool IsInfoEnabled;bool

IsDebugEnabled;

Lowest

表1 Logger的⽇志级别

DEBUGvoid Debug(...);ALL 在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\");}

2.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类来⾃动管理库和⽇志对象。2.3 Appender

⼀个好的⽇志框架应该能够产⽣多⽬的地的输出。⽐如说输出到控制台或保存到⼀个⽇志⽂件。log4net 能够很好的满⾜这些要求。它使⽤⼀个叫做Appender的组件来定义输出介质。正如名字所⽰，这些组件把它们附加到Logger⽇志组件上并将输出传递到输出流中。你可以把多个Appender组件附加到⼀个⽇志对象上。 Log4net框架提供了⼏个Appender组件。关于log4net提供的Appender组件的完整列表可以在log4net框架的帮助⼿册中找到。有了这些现成的Appender组件，⼀般来说你没有必要再⾃⼰编写了。但是如果你愿意，可以从log4net.Appender.AppenderSkeleton类继承。2.4 Appender Filters

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

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

3 、在程序中使⽤log4net

在开始对你的程序进⾏⽇志记录前，需要先启动log4net引擎。这意味着你需要先配置前⾯提到的三种组件。你可以⽤两种⽅法来设定配置：在单独的⽂件中设定配置或在代码中定义配置。因为下⾯⼏种原因，推荐在⼀个单独的⽂件中定义配置：l 你不需要重新编译源代码就能改变配置；

l 你可以在程序正运⾏的时候就改变配置。这⼀点在⼀些WEB程序和远程过程调⽤的程序中有时很重要；考虑到第⼀种⽅法的重要性，我们先看看怎样在⽂件中设定配置信息。3.1 定义配置⽂件

配置信息可以放在如下⼏种形式⽂件的⼀种中。

在程序的配置⽂件⾥，如AssemblyName.config 或web.config.

在你⾃⼰的⽂件⾥。⽂件名可以是任何你想要的名字，如AppName.exe.xyz等.

log4net框架会在相对于AppDomain.CurrentDomain.BaseDirectory 属性定义的⽬录路径下查找配置⽂件。框架在配置⽂件⾥要查找的唯⼀标识是标签。⼀个完整的配置⽂件的例⼦如下：