log4net使用简介

当我们开发软件时,一般都会加入运行期的跟踪手段,以方便后续故障分析和Bug调试。.net framework本身提供了一个System.Diagnostics.Trace类来实现流程跟踪功能,但很多时候却不能满足我们的需求,这时往往需要一个更加强大的第三方日志系统。
前段时间在项目中使用了log4net来记录日志,感觉还不错,这里简单的介绍一下它的用法。使用log4net需要如下几个步骤:

一、在Nuget中下载log4net

image.png

二、在使用日志的类的名字空间前加上XmlConfiguratorAttribute标记

Log4net日志使用(下篇) - 图2
不加这个标记的话则log无法生效,如果类较多则比较麻烦,此时可以把这个配置放在AssemblyInfo.cs中,针对整个程序集生效。

三、在代码中使用log4net记录日志

  1. static void Main(string[] args)
  2. {
  3. ILog log = log4net.LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  4. log.Error("error", new Exception("发生了一个异常"));
  5. log.Fatal("fatal", new Exception("发生了一个致命错误"));
  6. log.Info("info");
  7. log.Debug("debug");
  8. log.Warn("warn");
  9. Console.WriteLine("日志记录完毕。");
  10. }

四、配置输出方式

log4net的输出方式是通过配置文件(App.config)来控制的,通过配置文件的好处是非常灵活,可以动态改变配置。一个简单的示例如下:

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <configuration>
  3. <configSections>
  4. <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
  5. </configSections>
  6. <log4net>
  7. <root>
  8. <appender-ref ref="LogFileAppender" />
  9. </root>
  10. <appender name="LogFileAppender" type="log4net.Appender.RollingFileAppender">
  11. <file value="r:/log4netfile.txt" />
  12. <appendToFile value="true" />
  13. <rollingStyle value="Date" />
  14. <LockingModel type="log4net.Appender.FileAppender+MinimalLock, log4net"/>
  15. <datePattern value="yyyyMMdd-HH:mm:ss" />
  16. <layout type="log4net.Layout.PatternLayout">
  17. <param name="ConversionPattern" value="%d [%t] %-5p %c [%x] %X{auth} - Line:%L %m%n" />
  18. </layout>
  19. </appender>
  20. </log4net>
  21. </configuration>

配置文件的方式初看上去非常复杂,但使用过后就会体会到它的强大之处。上面的配置定义了一个文本文件的方式输出日志,这个也是最常用的一种方式。log4net提供了非常强大的控制策略,例如,可以控制输出日志输出格式、页眉页脚、覆盖策略、安全控制等。具体的说明可以参看下Log4net中的RollingFileAppender解析这篇文章。
除了以文本方式输出外,还可以使用系统日志、数据库、控制台、邮件等多种方式。并且可以组合使用,这里就不一一介绍了,感兴趣的朋友可以参考下log4net的各种Appender配置示例这篇文章。

小结

log4net非常灵活而强大,是一个不可多得的日志系统。本文这里只是介绍了一下log4net的基本用法,方便初次上手的朋友快速入门。如果需要更加深入的了解它,请参考codeproject上的文章log4net Tutorial