企业网站开发基本流程,济南网站优化排名推广,百姓网app官方最新下载,济南高新区 网站建设Log4Net使用指南 声明#xff1a;本文内容主要译自Nauman Leghari的Using log4net#xff0c;亦加入了个人的一点心得(节3.1.4)。请在这里下载示例代码 1 简介 1.1 Log4net的优点#xff1a; 几乎所有的大型应用都会有自己的用于跟踪调试的API。因为…Log4Net使用指南 声明本文内容主要译自Nauman Leghari的Using log4net亦加入了个人的一点心得(节3.1.4)。请在这里下载示例代码 1 简介 1.1 Log4net的优点 几乎所有的大型应用都会有自己的用于跟踪调试的API。因为一旦程序被部署以后就不太可能再利用专门的调试工具了。然而一个管理员可能需要有一套强大的日志系统来诊断和修复配置上的问题。 经验表明日志记录往往是软件开发周期中的重要组成部分。它具有以下几个优点它可以提供应用程序运行时的精确环境可供开发人员尽快找到应用程序中的Bug一旦在程序中加入了Log 输出代码程序运行过程中就能生成并输出日志信息而无需人工干预。另外日志信息可以输出到不同的地方控制台文件等以备以后研究之用。 Log4net就是为这样一个目的设计的用于.NET开发环境的日志记录包。 1.2 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(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有以下几种取值 级别 允许的方法 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 表1 Logger的日志级别 在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 属性定义的目录路径下查找配置文件。框架在配置文件里要查找的唯一标识是log4net标签。一个完整的配置文件的例子如下 ?xml version1.0 encodingutf-8 ? configuration configSections section namelog4net typelog4net.Config.Log4NetConfigurationSectionHandler, log4net-net-1.0 / /configSections log4net root level valueWARN / appender-ref refLogFileAppender / appender-ref refConsoleAppender / /root logger nametestApp.Logging level valueDEBUG/ /logger appender nameLogFileAppender typelog4net.Appender.FileAppender param nameFile valuelog-file.txt / param nameAppendToFile valuetrue / layout typelog4net.Layout.PatternLayout param nameHeader value[Header]\r\n/ param nameFooter value[Footer]\r\n/ param nameConversionPattern value%d [%t] %-5p %c [%x] - %m%n / /layout filter typelog4net.Filter.LevelRangeFilter param nameLevelMin valueDEBUG / param nameLevelMax valueWARN / /filter /appender appender nameConsoleAppender typelog4net.Appender.ConsoleAppender layout typelog4net.Layout.PatternLayout param nameConversionPattern value%d [%t] %-5p %c [%x] - %m%n / /layout /appender /log4net /configuration 你可以直接将上面的文本拷贝到任何程序中使用但是最好还是能够理解配置文件是怎样构成的。 只有当你需要在应用程序配置文件中使用log4net配置时才需要在configSection标签中加入section配置节点入口。对于其他的单独文件只有log4net标签内的文本才是必需的这些标签的顺序并不是固定的。下面我们依次讲解各个标签内文本的含义 3.1.1 root root level valueWARN / appender-ref refLogFileAppender / appender-ref refConsoleAppender / /root 在框架的体系里所有的日志对象都是根日志(root logger)的后代。 因此如果一个日志对象没有在配置文件里显式定义则框架使用根日志中定义的属性。在root标签里可以定义level级别值和Appender的列表。如果没有定义LEVEL的值则缺省为DEBUG。可以通过appender-ref标签定义日志对象使用的Appender对象。appender-ref声明了在其他地方定义的Appender对象的一个引用。在一个logger对象中的设置会覆盖根日志的设置。而对Appender属性来说子日志对象则会继承父日志对象的Appender列表。这种缺省的行为方式也可以通过显式地设定logger标签的additivity属性为false而改变。 logger nametestApp.Logging additivityfalse /logger Additivity的值缺省是true. 3.1.2 Logger logger nametestApp.Logging level valueDEBUG/ /logger logger 元素预定义了一个具体日志对象的设置。然后通过调用LogManager.GetLogger(“testAPP.Logging”)函数你可以检索具有该名字的日志。如果LogManager.GetLogger(…)打开的不是预定义的日志对象则该日志对象会继承根日志对象的属性。知道了这一点我们可以说其实logger标签并不是必须的。 3.1.3 appender appender nameLogFileAppender typelog4net.Appender.FileAppender param nameFile valuelog-file.txt / param nameAppendToFile valuetrue / layout typelog4net.Layout.PatternLayout param nameHeader value[Header]\r\n / param nameFooter value[Footer]\r\n/ param nameConversionPattern value%d [%t] %-5p %c - %m%n / /layout filter typelog4net.Filter.LevelRangeFilter param nameLevelMin valueDEBUG / param nameLevelMax valueWARN / /filter /appender 在root标签或单个的logger标签里的Appender对象可以用appender标签定义。appender标签的基本形式如上面所示。它定义了appender的名字和类型。 另外比较重要的是appender标签内部的其他标签。不同的appender有不同的param标签。在这里为了使用FileAppender,你需要一个文件名作为参数。另外还需要一个在appender标签内部定义一个Layout对象。Layout对象定义在它自己的layout标签内。layout标签的type属性定义了Layout的类型(在本例里是PatternLayout)同时也确定了需要提供的参数值。Header和Footer标签提供了一个日志会话(logging session)开始和结束时输出的文字。有关每种appender的具体配置的例子可以在log4net\doc\manual\example-config-appender.html中得到。 3.1.4 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):当前日志对象的名称例如 模式字符串为%-10c -%m%n 代码为 ILog logLogManager.GetLogger(“Exam.Log”); log.Debug(“Hello”); 则输出为下面的形式 Exam.Log - Hello %L输出语句所在的行号 %F输出语句所在的文件名 %-数字表示该项的最小长度如果不够则用空格填充 例如转换模式为%r [%t]%-5p %c - %m%n 的 PatternLayout 将生成类似于以下内容的输出 176 [main] INFO org.foo.Bar - Located nearest gas station. 3.1.5 filter 最后让我们看看在Appender元素里的filter标签。它定义了应用到Appender对象的过滤器。本例中我们使用了LevelRangeFilter过滤器,它可以只记录LevelMin和LevelMax参数指定的日志级别之间的日志事件。可以在一个Appender上定义多个过滤器Filter,这些过滤器将会按照它们定义的顺序对日志事件进行过滤。其他过滤器的有关信息可以在log4net的SDK文档中找到。 3.2 使用配置文件 3.2.1 关联配置文件 当我们创建了上面的配置文件后我们接下来需要把它和我们的应用联系起来。缺省的每个独立的可执行程序集都会定义它自己的配置。log4net框架使用 log4net.Config.DOMConfiguratorAttribute在程序集的级别上定义配置文件。 例如可以在项目的AssemblyInfo.cs文件里添加以下的语句 [assembly:log4net.Config.DOMConfigurator(ConfigFilefilename, ConfigFileExtensionext,Watchtrue/false)] l ConfigFile:指出了我们的配置文件的路径及文件名包括扩展名。 l ConfigFileExtension:如果我们对被编译程序的程序集使用了不同的文件扩展名那么我们需要定义这个属性缺省的程序集的配置文件扩展名为”config”。 l Watch (Boolean属性): log4net框架用这个属性来确定是否需要在运行时监视文件的改变。如果这个属性为true,那么FileSystemWatcher将会被用来监视文件的改变重命名删除等事件。 其中ConfigFile和ConfigFileExtension属性不能同时使用ConfigFile指出了配置文件的名字例如ConfigFile”Config.txt” ConfigFileExtension则是指明了和可执行程序集同名的配置文件的扩展名例如应用程序的名称是”test.exe”,ConfigFileExtension”txt”,则配置文件就应该是”test.exe.txt” 也可以不带参数应用DOMConfiguratio(): [assembly: log4net.Config.DOMConfigurator()] 也可以在程序代码中用DOMConfigurator类打开配置文件。类的构造函数需要一个FileInfo对象作参数以指出要打开的配置文件名。 这个方法和前面在程序集里设置属性打开一个配置文件的效果是一样的。 log4net.Config.DOMConfigurator.Configure( new FileInfo(TestLogger.Exe.Config)); DOMConfigurator 类还有一个方法ConfigureAndWatch(..), 用来配置框架并检测文件的变化。 以上的步骤总结了和配置相关的各个方面下面我们将分两步来使用logger对象。 3.2.2 创建或获取日志对象 日志对象会使用在配置文件里定义的属性。如果某个日志对象没有事先在配置文件里定义那么框架会根据继承结构获取祖先节点的属性最终的会从根日志获取属性。如下所示 Log4net.ILog log Log4net.LogManager.GetLogger(MyLogger); 3.2.3 输出日志信息 可以使用ILog的几种方法输出日志信息。你也可以在调用某方法前先检查IsXXXEnabled布尔变量再决定是否调用输出日志信息的函数这样可以提高程序的性能。因为框架在调用如ILog.Debug(…)这样的函数时也会先判断是否满足Level日志级别条件。 if (log.IsDebugEnabled) log.Debug(message); if (log.IsInfoEnabled) log.Info(message); 3.3 在程序中配置log4net 除了前面讲的用一个配置文件来配置log4net以外还可以在程序中用代码来配置log4net框架。如下面的例子: // 和PatternLayout一起使用FileAppender log4net.Config.BasicConfigurator.Configure( new log4net.Appender.FileAppender( new log4net.Layout.PatternLayout(%d [%t]%-5p %c [%x] - %m%n),testfile.log)); // using a FileAppender with an XMLLayout log4net.Config.BasicConfigurator.Configure( new log4net.Appender.FileAppender( new log4net.Layout.XMLLayout(),testfile.xml)); // using a ConsoleAppender with a PatternLayout log4net.Config.BasicConfigurator.Configure( new log4net.Appender.ConsoleAppender( new log4net.Layout.PatternLayout(%d [%t] %-5p %c - %m%n))); // using a ConsoleAppender with a SimpleLayout log4net.Config.BasicConfigurator.Configure( new log4net.Appender.ConsoleAppender(new log4net.Layout.SimpleLayout())); 尽管这里用代码配置log4net也很方便但是你却不能分别配置每个日志对象。所有的这些配置都是被应用到根日志上的。 log4net.Config.BasicConfigurator 类使用静态方法Configure 设置一个Appender 对象。而Appender的构造函数又会相应的要求Layout对象。你也可以不带参数直接调用BasicConfigurator.Configure()它会使用一个缺省的PatternLayout对象在一个ConsoleAppender中输出信息。如下所示 log4net.Config.BasicConfigurator.Configure(); 在输出时会显示如下格式的信息 0 [1688] DEBUG log1 A B C - Test 20 [1688] INFO log1 A B C - Test 当log4net框架被配置好以后就可以如前所述使用日志功能了。
