你好,游客 登录 注册 搜索
背景:
阅读新闻

Log4Net详解(2)结构篇 -

[日期:2013-04-04] 来源:  作者: [字体: ]

Log4Net详解 (2) 结构篇

 

1、Logger

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,须首先实现这个接口。

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)方法来获得,或者可以用如下的反射方法来获得:

// 获取调用方法的类(class)的类型(type)

System.Reflection.MethodBase.GetCurrentMethod().DeclaringType

1.2、日志的级别

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

Level有以下几种取值:

级别

允许的方法

Boolean属性

优先级别

OFF

 

 

Highest

FATAL

void Fatal(...);

bool IsFatalEnabled;

 

ERROR

void Error(...);

bool IsErrorEnabled;

 

WARN

void Warn(...);

bool IsWarnEnabled;

 

INFO

void Info(...);

bool IsInfoEnabled;

 

DEBUG

void Debug(...);

bool IsDebugEnabled;

 

ALL

 

 

Lowest

表-1 Logger的日志级别

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

ILog接口的每个方法都有一个预先定义好了的级别值。ILog的Info()方法具有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、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

一个好的日志框架应该能够产生多目的地的输出。比如说输出到控制台或保存到一个日志文件。log4net使用一个叫做Appender的组件来定义输出介质。这些组件把它们附加到Logger日志组件上并将输出传递到输出流中。可以把多个Appender组件附加到一个日志对象上。

Log4net框架提供了几个Appender组件。关于log4net提供的Appender组件的完整列表可以在log4net框架的帮助手册中找到。有了这些现成的Appender组件,一般来说你没有必要再自己编写了。但是如果你愿意,可以从log4net.Appender.AppenderSkeleton类继承。

4、Appender Filters

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

5、Layout

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






收藏 推荐 打印 | 录入:admin | 阅读:
相关新闻