asp.net webform使用log4net
1》 新建一个webForm应用程序, 2》在项目中引用log4net.dll 3》在项目中添加一个名字为log4net.config的配置文件
下面我们开始配置log4net.config
<configuration> <configSections> <!--配置一个结点 名称为log4net--> <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" /> </configSections> <log4net> <!--定义的是日志记录到文件的附着器 name表示该附着器的名称,--> <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender,log4net"> <!--文件路径,如果RollingStyle为Composite或Date,则这里设置为目录,文件名在DatePattern里设置,其他则这里要有文件名。已经扩展支持虚拟目录--> <param name="File" value="log\log.txt\" /><!-- <param name="File" value="d:\Log\\" />--> <!--True/false,默认为true。当文件存在时,是否在原文件上追加内容。通常无需设置--> <param name="AppendToFile" value="true" /> <!--每天记录的日志文件个数,默认为0,与MaxFileSize配合使用 在CountDirection为负数时有效。--> <param name="MaxSizeRollBackups" value="100" /> <!--每个日志文件的最大大小,可用的单位:KB|MB|GB (好像只有在RollingStyle的值为Size时有效)--> <param name="MaxFileSize" value="10240" /> <!--True/false,默认为true。为true时,RollingStyler的date值将无效。且为true时需要在file里指定文件名,所有日志都会记录在这个文件里。--> <param name="StaticLogFileName" value="false" /> <!--当RollingStyle为Composite或Date,这里设置文件名格式--> <param name="DatePattern" value="yyyyMMdd" /><!-- <param name="DatePattern" value="yyyy-MM-dd.TXT" />--> <!---创建新文件的方式,可选为Size(按文件大小),Date(按日期),Once(每启动一次创建一个文件),Composite(按日期及文件大小),默认为Composite--> <param name="RollingStyle" value="Date" /> <!--默认值为-1。当文件超过MaximumFileSize的大小时,如果要创建新的文件来存储日志,会根据CountDirection的值来重命名文件。大于-1的值时,file里指定的文件名会依次加上.0,.1,.2递增。当等于或小于-1时,创建依赖于MaxSizeRollBackups参数值,创建备份日志数。--> <param name="CountDirection" value="-1" /> <!---------------log4net记录错误的格式(即:用什么样的格式(布局)来记录错误)----------------> <layout type="log4net.Layout.PatternLayout"> <param name="conversionPattern" value="%date [%thread] %-5level %logger [%ndc] - %message%newline" /> <!--<param name="ConversionPattern" value="时间:%d %n级别:%level %n类名:%c%n文件:%F 第%L行%n日志内容:%m%n-----------------%n%n" />--> </layout> </appender> <!---------------log4net记录错误的级别(即:在出现什么级别的错误才记录错误)----------------> <root><!---logger其实就是root的一个子类,这里的root其实就代表了logger,具体就代表的是<logger name="myLogger"> --> <level value="ALL" /> <!--指定日记对象使用的Appender对象,我们就是通过appender对象来附加我们的日记信息--> <appender-ref ref="ErrorAppender" /> </root> <!--我们最好是使用<root> 这种形式,不用直接使用<logger naem=...>因为很多时候我们需要自动获取出错类的类名,如果在这里指定了类名,我们用的时候只能log4net.ILog log = log4net.LogManager.GetLogger("WebLogger");这样子用,获取到的出错类的类名永远是"WebLogger" ,因为很多时候我并不知道哪个类出错了,我就需要自动获取出错类的类名,就需要log4net.ILog log = log4net.LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); 这样来获取,如果这里定义了错误类名为"WebLogger"而真正出错的类名并不是"WebLogger"类,那么我们就无法调用log.Error("错误:"+ex);来将错误写入日记--> <!--<logger name="WebLogger"> <level value="ERROR" /> <appender-ref ref="ErrorAppender"/> </logger>--> </log4net> </configuration>
配置好后,因为我们新建这个log4net.config文件是独立的,目前与我们的webForm应用程序是没有任何关系的。所以,我们需要将它加载到我们的项目中
将log4net.config这个配置文件加载到我们的webForm应用程序中有两种方法
1》在我们项目下面的Properties 文件下面有一个AssemblyInfo.cs类 打开这个类,在最下面加入一条语句就可以了
[assembly: log4net.Config.XmlConfigurator(ConfigFile="log4net.config", Watch = true)]
注意:ConfigFile是指定我们刚创建的这个log4net.confi配置文件的路径 。
AssemblyInfo.cs类 具体代码如下
using System.Reflection; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; // 有关程序集的常规信息通过下列特性集 // 控制。更改这些特性值可修改 // 与程序集关联的信息。 [assembly: AssemblyTitle("WebTest")] [assembly: AssemblyDescription("")] [assembly: AssemblyConfiguration("")] [assembly: AssemblyCompany("")] [assembly: AssemblyProduct("WebTest")] [assembly: AssemblyCopyright("版权所有(C) 2015")] [assembly: AssemblyTrademark("")] [assembly: AssemblyCulture("")] // 将 ComVisible 设置为 false 会使此程序集中的类型 // 对 COM 组件不可见。如果需要从 COM 访问此程序集中的某个类型, // 请针对该类型将 ComVisible 特性设置为 true。 [assembly: ComVisible(false)] // 如果此项目向 COM 公开,则下列 GUID 用于类型库的 ID [assembly: Guid("82486936-a464-4292-96c3-18300f91122e")] // 程序集的版本信息由下列四个值组成: // // 主版本 // 次版本 // 内部版本号 // 修订号 // // 可以指定所有这些值,也可以使用“修订号”和“内部版本号”的默认值, // 方法是按如下所示使用“*”: [assembly: AssemblyVersion("1.0.0.0")] [assembly: AssemblyFileVersion("1.0.0.0")] //ConfigFile="log4net.config"表示:我们配置文件的路径为网站根目录下的mylognet4.config这个配置文件,这样程序运行的时候就会按照这个路径来读取这个配置文件 //Watch:log4net框架用这个属性来确定是否需要在运行时监视文件的改变,如果这个属性为true,那么FilsSystemWatcher将会被用来监视文件的改变,重命名,删除等事件。(即:如果这个配置文件发生变化的时候它是否自适应这个变化,也就是说它会自动的去读取这个变化,而不需要重新启动这个正在运行的这个web应用程序) //其实如果我们吧log4net的配置文件直接配置在web.config文件里,这里就不需要在配置了。这里之所以需要配置是因为我们是独立建立的一个log4net配置文件,为了让它与我们的程序关联起来,在这里,需要对我们建立的log4net配置文件进行读取,加载到我们的程序当中 [assembly: log4net.Config.XmlConfigurator(ConfigFile="log4net.config", Watch = true)]
2》假如,我的项目中没有AssemblyInfo.cs这个类文件怎么办呢? 答:我们可以在我们的项目下创建一个Global.asax 文件 ,在Global.asax文件的里来将我们的创建的log4net.config配置文件加载到我们的项目中去
Global.asax文件 具体代码如下:
using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Web; using System.Web.Security; using System.Web.SessionState; using log4net; namespace WebTest { public class Global : System.Web.HttpApplication { protected void Application_Start(object sender, EventArgs e) { string filePath = Server.MapPath("~/log4net.config"); FileInfo fil = new FileInfo(filePath); log4net.Config.XmlConfigurator.Configure(fil); //将 //log4net.Config.XmlConfigurator.Configure(new System.IO.FileInfo(Server.MapPath("~/log4net.config"))); 其实以上三句代码可以用这一句替代 } protected void Session_Start(object sender, EventArgs e) { } protected void Application_BeginRequest(object sender, EventArgs e) { } protected void Application_AuthenticateRequest(object sender, EventArgs e) { } protected void Application_Error(object sender, EventArgs e) { } protected void Session_End(object sender, EventArgs e) { } protected void Application_End(object sender, EventArgs e) { } } }
注意上面的两段代码:我们只需要AssemblyInfo.cs中加载log4net.config配置文件到我们的项目中,或者在Global.asax中加载log4net.config配置文件到我们的项目中,两种选其一就行,不需要在两个文件中都加载。
好了,文件都已经配置好了。我们就要开始使用了
首先我们在项目中添加WebForm1.aspx 文件,在里面我们认为的些一句会报错的代码,来测试一下我们的log4net.config文件是否配置成功。‘
我们在WebForm1.aspx页面添加一个按钮,点击按钮,执行代码(代码会报错)代码如下:
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using log4net; using System.Reflection; namespace WebTest { public partial class WebForm1 : System.Web.UI.Page { protected void Page_Load(object sender, EventArgs e) { } protected void Button1_Click(object sender, EventArgs e) { int x = 5; int y = 0; try { int z = x / y; } catch (Exception ex) { //Getlogger()静态方法,用来检索框架里是否存在logger对象,如果不存在就创建一个名字为logger的对象 //log4net.ILog log = log4net.LogManager.GetLogger("WebLogger");//这个WebLogger其实就是配置文件中的logger的name属性名称。它代表的是错误的类名 log4net.ILog log = log4net.LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);//自获取出错的类 if (log.IsErrorEnabled) { log.Error("错误:"+ex); } } } } }
我们点击 button按钮后代码执行完毕。我们去我们项目所在的磁盘文件路径下面会发现多出了一个log的文件夹,在文件夹里有一个log.txt文件。我们打开log.txt文件