Log4Net Logger日志记录器

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 : ILoggerWrapper
{
    void Debug(object message);
    void Debug(object message, Exception exception);
    void DebugFormat(string format, params object[] args); 
    void DebugFormat(string format, object arg0); 
    void DebugFormat(string format, object arg0, object arg1); 
    void DebugFormat(string format, object arg0, object arg1, object arg2); 
    void DebugFormat(IFormatProvider provider, string format, params object[] args);

    void Info(object message);
    void Info(object message, Exception exception);
    void InfoFormat(string format, params object[] args);
    void InfoFormat(string format, object arg0); 
    void InfoFormat(string format, object arg0, object arg1); 
    void InfoFormat(string format, object arg0, object arg1, object arg2); 
    void InfoFormat(IFormatProvider provider, string format, params object[] args);

    void Warn(object message);
    void Warn(object message, Exception exception);
    void WarnFormat(string format, params object[] args);
    void WarnFormat(string format, object arg0); 
    void WarnFormat(string format, object arg0, object arg1); 
    void WarnFormat(string format, object arg0, object arg1, object arg2); 
    void WarnFormat(IFormatProvider provider, string format, params object[] args);

    void Error(object message);
    void Error(object message, Exception exception);
    void ErrorFormat(string format, params object[] args);
    void ErrorFormat(string format, object arg0); 
    void ErrorFormat(string format, object arg0, object arg1); 
    void ErrorFormat(string format, object arg0, object arg1, object arg2); 
    void ErrorFormat(IFormatProvider provider, string format, params object[] args);

    void Fatal(object message);
    void Fatal(object message, Exception exception);
    void FatalFormat(string format, params object[] args);
    void FatalFormat(string format, object arg0); 
    void FatalFormat(string format, object arg0, object arg1); 
    void FatalFormat(string format, object arg0, object arg1, object arg2); 
    void FatalFormat(IFormatProvider provider, string format, params object[] args);

        
    bool IsDebugEnabled { get; }
    bool IsInfoEnabled { get; }
    bool IsWarnEnabled { get; }
    bool IsErrorEnabled { get; }
    bool IsFatalEnabled { get; }
}

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

ILog log = LogManager.GetLogger("application-log");
     
log.Info("Application Start");
log.Debug("This is a debug message");
     
if (log.IsDebugEnabled)
{
    log.Debug("This is another debug message");
}

通常来说，我们会以类（class）的类型（type）为参数来调用GetLogger()，以便跟踪我们正在进行日志记录的类。传递的类(class)的类型(type)可以用typeof(Classname)方法来获得，或者可以用如下的反射方法来获得：

System.Reflection.MethodBase.GetCurrentMethod().DeclaringType

尽管符号长了一些，但是后者可以用于一些场合，比如获取调用方法的类(class)的类型(type)。

2 日志的级别

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

Level有以下几种取值：

级别	允许的方法	Boolean属性	优先级别
OFF			Highest
FATAL	void Fatal(...);	bool IsFatalEnabled;
RROR	void Error(...);	bool IsErrorEnabled;
WARN	void Warn(...);	bool IsWarnEnabled;
INFO	void Info(...);	bool IsInfoEnabled;
DEBUG	void Debug(...);	bool IsDebugEnabled;
ALL			Lowest

在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)，因此，日志请求被拒绝了，我们得不到任何输出。同样的，针对第三行语句，我们可以很容易得出结论。

ALL和OFF。ALL表示允许所有的日志请求。OFF是拒绝所有的请求。

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

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