log4net是.Net下一个非常优秀的开源日志记录组件。log4net记录日志的功能非常强大。它可以将日志分不同的等级，以不同的格式，输出到不同的媒介。本文主要是介绍如何在Visual Studio2008中使用log4net快速创建系统日志，如何扩展以输出自定义字段。
2、一个简单的使用实例
第一步：在项目中添加对log4net.dll的引用，这里引用版本是1.2.10.0。
第二步：程序启动时读取log4net的配置文件。
如果是CS程序，在根目录的Program.cs中的Main方法中添加：
log4net.Config.XmlConfigurator.Configure()
如果是BS程序，在根目录的Global.asax.cs（没有新建一个）中的Application_Start方法中添加：
log4net.Config.XmlConfigurator.Configure()
无论BS还是CS程序都可直接在项目的AssemblyInfo.cs文件里添加以下的语句：
[assembly: log4net.Config .XmlConfigurator()]
也可以使用自定义的配置文件，具体请参见4.4 关联配置文件。
第三步：修改配置文件。如果是CS程序，则在默认的App.config文件（没有新建一个）中添加内容；如果是BS程序，则添加到Web.config文件中，添加内容一样，这里不再列出。
App.config文件添加内容如下：
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="log4net"
type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
</configSections>
<log4net>
<root>
<level value="WARN" />
<appender-ref ref="LogFileAppender" />
<appender-ref ref="ConsoleAppender" />
</root>
<logger name="testApp.Logging">
<level value="DEBUG"/>
</logger>
<appender name="LogFileAppender" type="log4net.Appender.FileAppender" >
<param name="File" value="log-file.txt" />
<param name="AppendToFile" value="true" />
<layout type="log4net.Layout.PatternLayout">
<param name="Header" value="[Header] "/>
<param name="Footer" value="[Footer] "/>
<param name="ConversionPattern" value="%d [%t] %-5p %c [%x] - %m%n" />
</layout>
<filter type="log4net.Filter.LevelRangeFilter">
<param name="LevelMin" value="DEBUG" />
<param name="LevelMax" value="WARN" />
</filter>
</appender>
<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender" >
<layout type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%d [%t] %-5p %c [%x] - %m%n" />
</layout>
</appender>
</log4net>
</configuration>
第四步：在程序使用。
log4net.ILog log = log4net.LogManager.GetLogger("testApp.Logging")//获取一个日志记录器
log.Info(DateTime.Now.ToString() + ": login success")//写入一条新log
这样就将信息同时输出到控制台和写入到文件名为“log-file.txt”的文件中，其中“log-file.txt”文件的路径是当前程序运行所在目录；也可以定义为绝对路径，配置如：
<param name="File" value="C:\log-file.txt" />就写入C盘根目录下log-file.txt文件中，具体使用技巧参见4.2.1。
本例的实现请参见8.6附件。
3、Log4net的主要组成部分
3.1 Appenders
Appenders用来定义日志的输出方式，即日志要写到那种介质上去。较常用的Log4net已经实现好了，直接在配置文件中调用即可，可参见上面配置文件例子；当然也可以自己写一个，需要从log4net.Appender.AppenderSkeleton类继承。它还可以通过配置Filters和Layout来实现日志的过滤和输出格式。
已经实现的输出方式有：
AdoNetAppender 将日志记录到数据库中。可以采用SQL和存储过程两种方式。
AnsiColorTerminalAppender 将日志高亮输出到ANSI终端。
AspNetTraceAppender 能用asp.net中Trace的方式查看记录的日志。
BufferingForwardingAppender 在输出到子Appenders之前先缓存日志事件。
ConsoleAppender 将日志输出到应用程序控制台。
EventLogAppender 将日志写到Windows Event Log。
FileAppender 将日志输出到文件。
ForwardingAppender 发送日志事件到子Appenders。
LocalSyslogAppender 将日志写到local syslog service (仅用于UNIX环境下)。
MemoryAppender 将日志存到内存缓冲区。
NetSendAppender 将日志输出到Windows Messenger service.这些日志信息将在用户终端的对话框中显示。
OutputDebugStringAppender 将日志输出到Debuger，如果程序没有Debuger，就输出到系统Debuger。如果系统Debuger也不可用，将忽略消息。
RemoteSyslogAppender 通过UDP网络协议将日志写到Remote syslog service。
RemotingAppender 通过.NET Remoting将日志写到远程接收端。
RollingFileAppender 将日志以回滚文件的形式写到文件中。
SmtpAppender 将日志写到邮件中。
SmtpPickupDirAppender 将消息以文件的方式放入一个目录中，像IIS SMTP agent这样的SMTP代理就可以阅读或发送它们。
TelnetAppender 客户端通过Telnet来接受日志事件。
TraceAppender 将日志写到.NET trace 系统。
UdpAppender 将日志以无连接UDP数据报的形式送到远程宿主或用UdpClient的形式广播。
3.2 Filters
使用过滤器可以过滤掉Appender输出的内容。过滤器通常有以下几种：
DenyAllFilter 阻止所有的日志事件被记录
LevelMatchFilter 只有指定等级的日志事件才被记录
LevelRangeFilter 日志等级在指定范围内的事件才被记录
LoggerMatchFilter 与Logger名称匹配，才记录
PropertyFilter 消息匹配指定的属性值时才被记录
StringMathFilter 消息匹配指定的字符串才被记录
3.3 Layouts
Layout用于控制Appender的输出格式，可以是线性的也可以是XML。
一个Appender只能有一个Layout。
最常用的Layout应该是经典格式的PatternLayout，其次是SimpleLayout，RawTimeStampLayout和ExceptionLayout。然后还有IRawLayout，XMLLayout等几个，使用较少。Layout可以自己实现，需要从log4net.Layout.LayoutSkeleton类继承，来输出一些特殊需要的格式，在后面扩展时就重新实现了一个Layout。
SimpleLayout简单输出格式，只输出日志级别与消息内容。
RawTimeStampLayout 用来格式化时间，在向数据库输出时会用到。
样式如“yyyy-MM-dd HH:mm:ss“
ExceptionLayout需要给Logger的方法传入Exception对象作为参数才起作用，否则就什么也不输出。输出的时候会包含Message和Trace。
PatterLayout使用最多的一个Layout，能输出的信息很多，使用方式可参见上面例子中的配置文件。PatterLayout的格式化字符串见文后附注8.1。
3.4 Loggers
Logger是直接和应用程序交互的组件。Logger只是产生日志，然后由它引用的Appender记录到指定的媒介，并由Layout控制输出格式。
Logger提供了多种方式来记录一个日志消息，也可以有多个Logger同时存在。每个实例化的Logger对象对被log4net作为命名实体（Named Entity）来维护。log4net使用继承体系，也就是说假如存在两个Logger，名字分别为a.b.c和a.b。那么a.b就是a.b.c的祖先。每个Logger都继承了它祖先的属性。所有的Logger都从Root继承, Root本身也是一个Logger。
日志的等级，它们由高到底分别为：
OFF >FATAL >ERROR >WARN >INFO >DEBUG >ALL
高于等级设定值方法（如何设置参见“配置文件详解”）都能写入日志， Off所有的写入方法都不写到日志里，ALL则相反。例如当我们设成Info时，logger.Debug就会被忽略而不写入文件，但是FATAL, ERROR,WARN,INFO会被写入，因为他们等级高于INFO。
在具体写日志时，一般可以这样理解日志等级：
FATAL（致命错误）：记录系统中出现的能使用系统完全失去功能，服务停止，系统崩溃等使系统无法继续运行下去的错误。例如，数据库无法连接，系统出现死循环。
ERROR（一般错误）：记录系统中出现的导致系统不稳定，部分功能出现混乱或部分功能失效一类的错误。例如，数据字段为空，数据 *** 作不可完成， *** 作出现异常等。
WARN（警告）：记录系统中不影响系统继续运行，但不符合系统运行正常条件，有可能引起系统错误的信息。例如，记录内容为空，数据内容不正确等。
INFO（一般信息）：记录系统运行中应该让用户知道的基本信息。例如，服务开始运行，功能已经开户等。
DEBUG （调试信息）：记录系统用于调试的一切信息，内容或者是一些关键数据内容的输出。
Logger实现的ILog接口，ILog定义了5个方法（Debug,Inof,Warn,Error,Fatal）分别对不同的日志等级记录日志。这5个方法还有5个重载。以Debug为例说明一下，其它的和它差不多。
ILog中对Debug方法的定义如下：
void Debug(object message)
void Debug(object message, Exception ex)
还有一个布尔属性：
bool IsDebugEnabled { get}
如果使用Debug(object message, Exception ex)，则无论Layout中是否定义了%exception，默认配置下日志都会输出Exception。包括Exception的Message和Trace。如果使用Debug(object message)，则日志是不会输出Exception。
最后还要说一个LogManager类，它用来管理所有的Logger。它的GetLogger静态方法，可以获得配置文件中相应的Logger：
log4net.ILog log = log4net.LogManager.GetLogger("logger-name")
3.5 Object Renders
它将告诉logger如何把一个对象转化为一个字符串记录到日志里。（ILog中定义的接口接收的参数是Object，而不是String。）
例如你想把Orange对象记录到日志中，但此时logger只会调用Orange默认的ToString方法而已。所以要定义一个OrangeRender类实现log4net.ObjectRender.IObjectRender接口，然后注册它（我们在本文中的扩展不使用这种方法，而是直接实现一个自定义的Layout）。这时logger就会知道如何把Orange记录到日志中了。
3.6 Repository
Repository主要用于日志对象组织结构的维护。
您可以创建日志文件，并使其包含与互 *** 作性、程序加载和网络有关的诊断信息。通过设置注册表项，可以启用日志记录。首先，设置一个注册表项以启用常规日志记录，然后针对所需的日志记录组件和选项来设置注册表项。可以使用下列方法设置注册表项：
使用 Visual Studio 中的远程注册表编辑器。
在 .NET Compact Framework 2.0 Service Pack 1 中，使用远程性能监视器中的日志记录选项。有关远程性能监视器的更多信息，请参见 如何：在运行时监视性能。
在 .NET Compact Framework 3.5 中，可以使用日志记录工具 NetCFLogging.exe，该工具提供了用于启用和禁用日志记录的简单的图形用户界面。此工具包括在 Power Toys for .NET Compact Framework 中。有关更多信息，请参见 Power Toys for .NET Compact Framework。
使用 Registry 和 RegistryKey 类，.NET Compact Framework 2.0 版及更高版本支持这些类。
下表对这些日志文件进行了总结。
日志记录组件
日志文件内容
互 *** 作
记录 COM 互 *** 作调用。提供有关平台调用和封送处理的信息。
错误
记录所有未处理的异常和本机异常。将错误记录到日志文件和 OutputDebugString 中。将为位于当前路径的每个程序集创建日志文件，并将其应用于当前会话。在第一次出现未处理的异常或本机异常之后，将覆盖日志文件。
加载程序
记录有关程序加载的信息。文件标头包含下列信息：
应用程序名称。
进程 ID（由 Windows Embedded CE 提供）。
创建日志文件的本地日期和时间。其格式不是全局性的，而是区域性特定的。
.NET Compact Framework 版本，例如 2.0.5021.00。
与平台相关的信息，例如 Windows Embedded CE v5.0.1400 (CEPC) WinCE5x86 debug Dev i386 IJITv2。
文件提供以下信息：
强制状态（兼容性模式）。
加载模块时为模块指定的信任级别。
解析方法时失败。
解析类型时失败。
查找或加载程序集或模块时失败。
程序集加载成功。
无效的元数据版本。
查找平台调用 DLL 时失败。
在平台调用 DLL 中查找函数时失败。
策略文件的名称，或者指出缺少该文件的事实。
策略文件处理过程中的主要错误。
托管程序集基于策略的重定向。
此外，还可以包括有关全局程序集缓存的信息。
网络
记录网络流量。网络日志文件是二进制文件，如果没有 .NET Compact Framework 日志查看器 Logviewer.exe，则无法访问该文件。在 .NET Compact Framework 3.5 及更高版本中，该日志查看器包含在 Power Toys for .NET Compact Framework 中。有关更多信息，请参见 Power Toys for .NET Compact Framework。
由于网络日志记录发生在 Windows 套接字层，因此日志文件只包含网络数据包信息。这包括通过网络发送的数据，其中有些可能是敏感数据，因而需要进行加密。
终结器
记录在垃圾回收器丢弃对象之前未释放这些对象的类名。.NET Compact Framework 3.5 及更高版本支持此日志。
对象名不包含在日志中，原因是这些名称对于公共语言运行时 (CLR) 不可用。但是，未释放的对象的类名有助于识别这些对象。未释放的对象在应用程序中可能造成性能问题。
说明：
某些情况下，调用终结器的是 .NET Compact Framework 而不是应用程序代码。
此文件包含以下信息：
指示终结器何时对对象运行垃圾回收器的时间戳。
被终结对象的类。
跟踪
记录 Windows Communication Foundation (WCF) 的代码异常。桌面 .NET Framework 支持三种日志记录：跟踪、消息处理和事件日志记录。.NET Compact Framework 上的 WCF 只支持通过跟踪日志记录来跟踪代码异常，但它不记录警告和错误消息。
.NET Compact Framework 3.5 及更高版本支持此日志。
默认情况下，系统会将日志文件写入包含被诊断的应用程序的目录。但是，您可以使用注册表项指定路径和其他选项，如下所示：
使用其他路径写入日志文件。这需要安全注册表的访问权限。
在日志文件名中包含应用程序名称。
在日志文件名中包含进程 ID。
日志文件名由以下几部分组成，其中组件 可以是“互 *** 作”、“错误”、“加载程序”或“网络”、“终结器”或“跟踪”：
netcf_应用程序名称_组件_进程 ID.log
应用程序名称和进程 ID 为可选项，它们基于注册表设置。
例如，对于名为 MyApp.exe 的应用程序，其加载程序日志文件可命名如下：
netcf_MyApp_Loader_2066923010.log
有关如何检查互 *** 作日志文件和加载程序日志文件等日志文件的信息，请参见 日志文件信息。
启用日志记录
将以下 Enabled 项的值设置为 1：
HKLM\Software\Microsoft\.NETCompactFramework\Diagnostics\Logging\Enabled
必须设置此项值才能启用六种日志记录：互 *** 作、加载程序、错误、网络、终结器和跟踪。请注意，默认情况下，Logging 下的子项并不存在。
可以通过将此值设置为 0（零）来关闭所有日志记录。
指定日志文件路径（可选）
将以下 Path 项的值设置为表示日志文件位置的字符串：
HKLM\Security\.NETCompactFramework\Diagnostics\Logging\Path
此项只能通过可写入安全注册表的应用程序来访问。如果未指定路径，系统会将日志文件写入包含应用程序的目录。
在名称中包含应用程序（可选）
将以下 UseApp 项的值设置为 1：
HKLM\Software\Microsoft\.NETCompactFramework\Diagnostics\Logging\UseApp
如果要运行多个应用程序并为每个应用程序获取单独的日志文件，则可以使用此项。如果有两个应用程序将日志文件写入同一目录，则当第二个应用程序运行时，较早的日志文件始终会被较新的日志文件覆盖。UseApp 项可以用作日志文件的区分符。
在名称中包含进程 ID（可选）
将以下 UsePid 项的值设置为 1：
HKLM\Software\Microsoft\.NETCompactFramework\Diagnostics\Logging\UsePid
如果要多次运行同一个应用程序并为每个实例创建单独的日志，则可以使用此项。此设置会在日志文件名中添加进程 ID，以使应用程序的每个实例都能用不同的名称创建新日志文件。
在事件发生时记录事件（可选）
将以下 Flush 项的值设置为 1：
HKLM\Software\Microsoft\.NETCompactFramework\Diagnostics\Logging\Flush
设置此值后，公共语言运行时 (CLR) 便会在事件发生时立即将日志事件写入日志文件，而不是先将事件保存在缓冲区中，并在写满缓冲区时才写入日志文件。此设置会给应用程序的性能带来负面影响，并可能稍稍修改应用程序的计时。但是，它有助于诊断与应用程序故障或其他错误有关的问题，因为您可能需要查看导致错误的最后几个事件。如果不存在或未设置此项，则系统将只有在写满缓冲区后，才会向日志文件写入数据。
欢迎分享，转载请注明来源：内存溢出
微信扫一扫
支付宝扫一扫
评论列表（0条）