前言
作为Web平台或winform应用程序等软件来说,错误日志记录是一项基本并且十分重要的功能,比较简单的方式是使用try{}catch{}这类方式来将错误记录下来。这种方式有明显的代码堆积的弊端,另外它在处理不可控异常时也不能达到将异常全部记录下来的作用。
原始解决方案
以web为例,以下代码是我以前使用的方式,思路就是使用页面基类记录错误,然后在其它页面中继承该类,这样实现了错误信息被记录到文本文件中。
01 | public class SessionGlobal:System.Web.UI.Page |
03 | public SessionGlobal() |
05 | this .Load += new EventHandler(BasePage_Load); |
06 | this .Error += new EventHandler(BasePage_Error); |
12 | /// <param name="sender"></param> |
13 | /// <param name="e"></param> |
14 | void BasePage_Error( object sender, EventArgs e) |
16 | string filePath=MapPath( "~\\log" ); |
17 | string fileName= "ErrLog_" + String.Format( "{0:yyyyMMdd}" , DateTime.Now) + ".log" ; |
18 | if (!Directory.Exists(filePath)) |
22 | Directory.CreateDirectory(filePath); |
27 | StringBuilder sbLogContent= new StringBuilder(); |
28 | sbLogContent.Append( "********************************************************\r\n" ); |
29 | sbLogContent.Append( "错误地址:" + HttpContext.Current.Request.Url.ToString() + "\r\n" ); |
30 | sbLogContent.Append( "绝对路径:" + Request.PhysicalApplicationPath.ToString() + Request.FilePath.ToString() + "\r\n" ); |
31 | if (Request.UrlReferrer != null ) |
33 | sbLogContent.Append( "上一页面:" + Request.UrlReferrer.ToString() + "\r\n" ); |
35 | sbLogContent.Append( "客户端IP:" + Request.UserHostAddress.ToString() + "\r\n" ); |
36 | sbLogContent.Append( "客户端浏览器:" + Request.UserAgent.ToString() + "\r\n" ); |
37 | sbLogContent.Append( "错误信息:" + HttpContext.Current.Error.Message + "\r\n" ); |
39 | sbLogContent.Append( "出错时间:" + DateTime.Now.ToString() + "\r\n" ); |
40 | sbLogContent.Append( "\r\n" ); |
41 | sbLogContent.Append( "*******************************************************\r\n" ); |
43 | string file = filePath + "\\" + fileName; |
46 | if (!File.Exists(file)) |
50 | StreamWriter SW=File.CreateText(file); |
51 | SW.WriteLine(sbLogContent.ToString()); |
61 | StreamWriter SW=File.AppendText(file); |
62 | SW.WriteLine(sbLogContent.ToString()); |
当然这是非常非常简单的记录错误的方式,它的缺点也很明显:一是只能记录错误类信息,另外就是它只局限于存储于文本(或数据库)中,不能以windows事件的方式来存储。
log4net简介
鼎鼎大名的日志记录组件log4net来自log4j,除了支持文本文件记录外,还支持windows事件记录、控制台、以及数据库记录,同时还可以控制要记载的日志级别,日志类别包括FAIL、ERROR、WARN、INFO、DEBUG。
log4net由五部分组成,分别为Appenders、Filters、Layouts、Logger和Object Renders。Appenders定义日志的输出;Filters用于过滤Appender输出的内容,可以设置指定等级、指定Logger名称、消息匹配属性或字符串才被记录;Layouts用于控制Appender输出格式,Loggers直接与应用程序交互,由它产生日志,然后由其引用的Appender记录再指定的媒介,由Layouts控制输出格式。Object Renders定义ILog实现方式。
log4net使用
首先到官方网站下载log4net,在项目中添加引用。然后在web.config中定义参数。我们以最简单的方式来使用:
02 | < section name = "log4net" type = "log4net.Config.Log4NetConfigurationSectionHandler, log4net" /> |
05 | < log4net debug = "true" > |
06 | < appender name = "LogFileAppender" type = "log4net.Appender.FileAppender" > |
07 | < param name = "File" value = "log\\log4net.log" /> |
08 | < layout type = "log4net.Layout.PatternLayout" > |
09 | < param name = "ConversionPattern" value = "%d [%t] %-5p %c %m%n" /> |
14 | < appender-ref ref = "LogFileAppender" /> |
这里我们是将写入方式是写入到当前站点的log文件夹中,这里如果担心文本增长过大,可以设置文本大小限制。关于这里的设置可以查看这篇文章:http://blog.youkuaiyun.com/lyjcn/archive/2009/08/11/4432833.aspx 也可以查看官方文档。
上面我们定义的Appender的Name为File,在代码中也要使用该名称,否则就会产生对象无法实例化的错误。
具体实现起来非常简单:
01 | ILog log = log4net.LogManager.GetLogger("File");//引入log4net |
03 | log.Error("error", new Exception("Error Occur")); |
05 | log.Fatal("fatal", new Exception("Fatal Occur")); |