日志记录组件[Log4net]详细介绍

 

一Log4net简介

Log4net是基于.net开发的一款非常著名的记录日志开源组件。他最早是2001年7月由NeoWorksLimited启动的项目，基本的框架源于另外的一个非常著名的姐妹组件－log4j。Log4net记录日志的功能非常强大。它可以将日志分不同的等级，比不同的样式，将日志输出到不同的媒介。

Log4net可以从http://logging.apache.org/log4net/downloads.html网站下载最新版本。

 

 

二Log4net核心组成

Log4net主要由五个部分组成，分别为Logger，Appenders,Filters,Layouts和ObjectRenders。

 

一）Logger(日志)

 

1．记录日志的分类：

Log4net能够以多种方式输出日志。支持的日志输出常用的主要媒介有数据库（包括MSSQLServer,Access,Oracle9i,Oracle8i,DB2,SQLite，控制台，文件，事件日志(可以用事件查看器查看)和邮件等多种方式。

 

2．日志的级别

Log4net支持多种级别的日志。优先级从高到低依次排列如下:

FATAL>ERROR>WARN>INFO>DEBUG

此外还有ALL（允许所有的日志请求）和OFF（拒绝所有的日志请求）这两种特殊的级别。

 

二）Appenders

 

Appenders决定日志输出的方式。

Appenders必须实现log4net.Appenders.IAppender接口。

 

Log4net目前支持的输出方式包括：
1AdoNetAppender
将日志记录到数据库中。可以采用SQL和存储过程两种方式。

2AnsiColorTerminalAppender
在ANSI窗口终端写下高亮度的日志事件。

3AspNetTraceAppender
能用asp.net中Trace的方式查看记录的日志。

4BufferingForwardingAppender
在输出到子Appenders之前先缓存日志事件。

5ConsoleAppender
将日志输出到控制台。

6EventLogAppender
将日志写到WindowsEventLog.

7FileAppender
将日志写到文件中。

8LocalSyslogAppender
将日志写到localsyslogservice(仅用于UNIX环境下).
9MemoryAppender
将日志存到内存缓冲区。

10NetSendAppender
将日志输出到WindowsMessengerservice.这些日志信息将在用户终端的对话框中显示。

11RemoteSyslogAppender
通过UDP网络协议将日志写到Remotesyslogservice。

12RemotingAppender
通过.NETRemoting将日志写到远程接收端。

13RollingFileAppender
将日志以回滚文件的形式写到文件中。

14SmtpAppender
将日志写到邮件中。

15TraceAppender
将日志写到.NETtrace系统。

16UdpAppender
将日志connectionlessUDPdatagrams的形式送到远程宿主或以UdpClient的形式广播。

 

三）Filters

 

Appender对象将日志以缺省的方式传到输出流，然后Filter可以按照不同的标准控制日志的输出。Filter可以再配置文件中配置。最简单的形式是在appender中写明一个Threshold.这样只有级别大于或等于此Threshold的日志才被记录。

Filters必须实现log4net.Filters.IFilter接口。

 

四）Layouts

 

Layouts控制日志显示的格式样式。日志的显示格式如下：

"%timestamp[%thread]%-5level%logger-%message%newline"

Timestamp:表示程序已经开始执行的时间。单位[毫秒]。

Thread:执行当前代码的线程。

Level：日志的级别。

Logger：日志相关请求的名称。

Message:　日志消息。

 

Layouts还可以控制日志的输出样式，比如以普通形式或以xml等形式输出。

 

五）ObjectRenderers

 

这是很重要的一项，log4net将按照用户定义的标准输出日志消息。

ObjectRenders必须实现log4net.ObjectRenderer.IObjectRenerer接口。

 

 

三如何在项目中使用log4net

 

下面有个基于控制台的demo，举例描述了log4net怎么用于输出日志。
本例中，日志将会记录到文件，控制台，事件日至和Access数据库中。

一）主要代码:

1.配置文件app.config

 

1<?xmlversion="1.0"encoding="utf-8"?>
2<configuration>
3<!--Registerasectionhandlerforthelog4netsection-->
4<configSections>
5<sectionname="log4net"type="System.Configuration.IgnoreSectionHandler"/>
6</configSections>
7<appSettings>
8<!--Toenableinternallog4netloggingspecifythefollowingappSettingskey-->
9<!--<addkey="log4net.Internal.Debug"value="true"/>--></appSettings>
10<!--Thissectioncontainsthelog4netconfigurationsettings-->
11<log4net>
12<!--定义输出到文件中-->
13<appendername="LogFileAppender"type="log4net.Appender.FileAppender">
14<!--定义文件存放位置-->
15<filevalue="D:/log-file1.txt"/>
16<!--Exampleusingenvironmentvariablesinparams-->
17<!--<filevalue="${TMP}/log-file.txt"/>-->
18<!--<sppendToFilevalue="true"/>-->
19<!--Analternateoutputencodingcanbespecified-->
20<!--<encodingvalue="unicodeFFFE"/>-->
21<layouttype="log4net.Layout.PatternLayout">
22<!--每条日志末尾的文字说明-->
23<footervalue="[Footer]--TestByRing1981"/>
24<!--输出格式-->
25<conversionPatternvalue="%date[%thread]%-5level%logger[%ndc]&lt;%property{auth}&gt;-%message%newline"/>
26</layout>
27</appender>
28<!--定义输出到控制台命令行中-->
29<appendername="ConsoleAppender"type="log4net.Appender.ConsoleAppender">
30<layouttype="log4net.Layout.PatternLayout">
31<conversionPatternvalue="%date[%thread]%-5level%logger[%property{NDC}]-%message%newline"/>
32</layout>
33</appender>
34<!--定义输出到windows事件中-->
35<appendername="EventLogAppender"type="log4net.Appender.EventLogAppender">
36<layouttype="log4net.Layout.PatternLayout">
37<conversionPatternvalue="%date[%thread]%-5level%logger[%property{NDC}]-%message%newline"/>
38</layout>
39</appender>
40<!--定义输出到数据库中，这里举例输出到Access数据库中，数据库为D盘的access.mdb-->
41<appendername="AdoNetAppender_Access"type="log4net.Appender.AdoNetAppender">
42<connectionStringvalue="Provider=Microsoft.Jet.OLEDB.4.0;DataSource=D:/access.mdb"/>
43<commandTextvalue="INSERTINTOLog([Date],[Thread],[Level],[Logger],[Message])VALUES(@log_date,@thread,@log_level,@logger,@message)"/>
44<!--定义各个参数-->
45<parameter>
46<parameterNamevalue="@log_date"/>
47<dbTypevalue="String"/>
48<sizevalue="255"/>
49<layouttype="log4net.Layout.PatternLayout">
50<conversionPatternvalue="%date"/>
51</layout>
52</parameter>
53<parameter>
54<parameterNamevalue="@thread"/>
55<dbTypevalue="String"/>
56<sizevalue="255"/>
57<layouttype="log4net.Layout.PatternLayout">
58<conversionPatternvalue="%thread"/>
59</layout>
60</parameter>
61<parameter>
62<parameterNamevalue="@log_level"/>
63<dbTypevalue="String"/>
64<sizevalue="50"/>
65<layouttype="log4net.Layout.PatternLayout">
66<conversionPatternvalue="%level"/>
67</layout>
68</parameter>
69<parameter>
70<parameterNamevalue="@logger"/>
71<dbTypevalue="String"/>
72<sizevalue="255"/>
73<layouttype="log4net.Layout.PatternLayout">
74<conversionPatternvalue="%logger"/>
75</layout>
76</parameter>
77<parameter>
78<parameterNamevalue="@message"/>
79<dbTypevalue="String"/>
80<sizevalue="1024"/>
81<layouttype="log4net.Layout.PatternLayout">
82<conversionPatternvalue="%message"/>
83</layout>
84</parameter>
85</appender>
86<!--定义日志的输出媒介，下面定义日志以四种方式输出。也可以下面的按照一种类型或其他类型输出。-->
87<root>
88<appender-refref="LogFileAppender"/>
89<appender-refref="ConsoleAppender"/>
90<appender-refref="EventLogAppender"/>
91<appender-refref="AdoNetAppender_Access"/>
92</root>
93</log4net>
94</configuration>
2.LoggingExample.cs

1//Configurelog4netusingthe.configfile
2[assembly:log4net.Config.XmlConfigurator(Watch=true)]
3//Thiswillcauselog4nettolookforaconfigurationfile
4//calledConsoleApp.exe.configintheapplicationbase
5//directory(i.e.thedirectorycontainingConsoleApp.exe)
6
7namespaceConsoleApp
8{
9usingSystem;
10
11/**////<summary>
12///Exampleofhowtosimplyconfigureanduselog4net
13///</summary>
14publicclassLoggingExample
15{
16privatestaticreadonlylog4net.ILoglog=log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
17
18publicstaticvoidMain(string[]args)
19{
20log.Error("ErrorAcc");
21log.Fatal("FatleAcc");
22System.Console.ReadLine();
23
24}
25
26}
27}
28
运行程序，日志就会以xml中定义的四种媒介形式输出。