Log4net日志组件使用指南

log4net使用指南

摘要： 介绍了Log4net的框架结构和使用方法。使用一些实例讲解了Log4net在程序中的配置方

法。

关键字： log4net，日志组件 预期读者： 软件开发，实施维护 难度等级： 低 审阅人： 范金锋 当前版本： 1.0 最近修改人：范金锋

修改时间： 2009年3月12日

待完善内容：对log4net进一步封装，以适合本公司的要求。

应用情况： 在营销综合查询中使用了该组件，用于记录系统日志和业务数据日志。 相关附件： Word原文 本文导读： 1 引言

2 Log4net的结构 2.1 Logger

2.1.1 Logger接口 2.1.2 日志的级别 2.2 Repository 2.3 Appender

2.4 Appender Filters 2.5 Layout

3 在应用程序中使用log4net 3.1 定义配置文件 3.1.1 Root结点 3.1.2 Logger结点 3.1.3 Appender结点

3.1.4 log4net.Layout.PatternLayout中的转换模式 3.1.5 filter结点 3 总结

1 引言

几乎所有的大型应用系统都需要记录系统运行信息和业务操作信息。系统一旦部署到现场后，程序员就不能再利用专门的调试工具对系统进行跟踪和测试。这时的系统的维护和管理就交付给实施人员或系统管理员，对于运行期间的故障诊断就需要借助于系统日志。对于业务人员，他们还非常关注相关的日常业务操作和业务数据的变更状况等信息，同样可以借助日志进行跟踪和查看。

一套强大的日志系统已成为软件生命周期中的重要组成部分。日志系统具有以下几

个优点：可以提供应用程序运行时的精确环境，可供开发人员尽快找到应用程序中的Bug，一旦在程序中加入了Log 输出代码，程序运行过程中就能生成并输出日志信息而无需人工干预。另外，日志信息可以输出到不同的地方（控制台，文件等）以备以后研究之用。

Log4net就是基于这种目的进行设计的，用于.NET开发环境的日志记录包。 Log4net是开源代码，我们可以从http://logging.apache.org/log4net/下载log4net的源代码。解压软件包后，在解压的src目录下将log4net.sln载入Visual Studio .NET，编译后可以得到log4net.dll。如果只要在自己的程序里加入日志功能，只需将log4net.dll引入工程即可。 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(\通常来说，我们会以类（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可以是表1所示的几种值。

表1 Logger的日志级别

级别 OFF FATAL RROR WARN INFO DEBUG ALL 允许的方法 Boolean属性 优先级别 最高 最低 void Fatal(...); void Error(...); void Warn(...); void Info(...); void Debug(...); bool IsFatalEnabled; bool IsErrorEnabled; bool IsWarnEnabled; bool IsInfoEnabled; bool IsDebugEnabled; 在log4net框架里，通过设置配置文件，每个日志对象都被分配了一个日志优先级别。如果没有给一个日志对象显式地分配一个级别，那么该对象会试图从他的祖先继承一个级别值。

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

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

Logger.Info(\ Logger.Debug(\ Logger.Warn(\

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

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

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

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

if (logger.IsDebugEnabled) {

Logger.Debug(\ }

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接口。

百度搜索“77cn”或“免费范文网”即可找到本站免费阅读全部范文。收藏本站方便下次阅读，免费范文网，提供经典小说教育文库Log4net日志组件使用指南在线全文阅读。