log4net使用详解

reference:

http://blog.csdn.net/zhoufoxcn/article/details/2220533#reply

说明：本程序演示如何利用log4net记录程序日志信息。log4net是一个功能著名的开源日志记录组件。利用log4net可以方便地将日志信息记录到文件、控制台、Windows事件日志和数据库（包括MS SQL Server, Access, Oracle9i,Oracle8i,DB2,SQLite）中。并且我们还可以记载控制要记载的日志级别，可以记载的日志类别包括：FATAL（致命错误）、ERROR（一般错误）、WARN（警告）、INFO（一般信息）、DEBUG（调试信息）。要想获取最新版本的log4net组件库，可以到官方网站http://logging.apache.org/log4net/下载。现在的最新版本是1.2.10。

下面的例子展示了如何利用log4net记录日志 。

首先从官方网站下载最近版本的log4net组件，现在的最新版本是1.2.10。在程序中我们只需要log4net.dll文件就行了，添加对log4net.dll的引用，就可以在程序中使用了。

接着我们配置相关的配置文件（WinForm对应的是*.exe.config，WebForm对应的是*.config），本实例中是控制台应用程序，配置如下（附各配置的说明）：

<? xml version="1.0" encoding="utf-8"  ?>
< configuration >
   < configSections >
     < section  name ="log4net"  type ="System.Configuration.IgnoreSectionHandler" />
   </ configSections >
   < appSettings >
   </ appSettings >
   < log4net >
     <!-- 定义输出到文件中 -->
     < appender  name ="LogFileAppender"  type ="log4net.Appender.FileAppender" >
       <!-- 定义文件存放位置 -->
       < file  value ="D:/log4netfile.txt"   />
       < appendToFile  value ="true"   />
       < rollingStyle  value ="Date"   />
       < datePattern  value ="yyyyMMdd-HH:mm:ss"   />
       < layout  type ="log4net.Layout.PatternLayout" >
         <!-- 每条日志末尾的文字说明 -->
         < footer  value ="by 周公"   />
         <!-- 输出格式 -->
         <!-- 样例：2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info -->
         < conversionPattern  value ="记录时间：%date 线程ID:[%thread] 日志级别：%-5level 出错类：%logger property:[%property{NDC}] - 错误描述：%message%newline"   />
       </ layout >
     </ appender >
     <!-- 定义输出到控制台命令行中 -->
     < appender  name ="ConsoleAppender"  type ="log4net.Appender.ConsoleAppender" >
       < layout  type ="log4net.Layout.PatternLayout" >
         < conversionPattern  value ="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline"   />
       </ layout >
     </ appender >
     <!-- 定义输出到windows事件中 -->
     < appender  name ="EventLogAppender"  type ="log4net.Appender.EventLogAppender" >
       < layout  type ="log4net.Layout.PatternLayout" >
         < conversionPattern  value ="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline"   />
       </ layout >
     </ appender >
     <!-- 定义输出到数据库中，这里举例输出到Access数据库中，数据库为C盘的log4net.mdb -->
     < appender  name ="AdoNetAppender_Access"  type ="log4net.Appender.AdoNetAppender" >
       < connectionString  value ="Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:log4net.mdb"   />
       < commandText  value ="INSERT INTO LogDetails ([LogDate],[Thread],[Level],[Logger],[Message]) VALUES (@logDate, @thread, @logLevel, @logger,@message)"   />
       <!-- 定义各个参数 -->
       < parameter >
         < parameterName  value ="@logDate"   />
         < dbType  value ="String"   />
         < size  value ="240"   />
         < layout  type ="log4net.Layout.PatternLayout" >
           < conversionPattern  value ="%date"   />
         </ layout >
       </ parameter >
       < parameter >
         < parameterName  value ="@thread"   />
         < dbType  value ="String"   />
         < size  value ="240"   />
         < layout  type ="log4net.Layout.PatternLayout" >
           < conversionPattern  value ="%thread"   />
         </ layout >
       </ parameter >
       < parameter >
         < parameterName  value ="@logLevel"   />
         < dbType  value ="String"   />
         < size  value ="240"   />
         < layout  type ="log4net.Layout.PatternLayout" >
           < conversionPattern  value ="%level"   />
         </ layout >
       </ parameter >
       < parameter >
         < parameterName  value ="@logger"   />
         < dbType  value ="String"   />
         < size  value ="240"   />
         < layout  type ="log4net.Layout.PatternLayout" >
           < conversionPattern  value ="%logger"   />
         </ layout >
       </ parameter >
       < parameter >
         < parameterName  value ="@message"   />
         < dbType  value ="String"   />
         < size  value ="240"   />
         < layout  type ="log4net.Layout.PatternLayout" >
           < conversionPattern  value ="%message"   />
         </ layout >
       </ parameter >
     </ appender >
     <!-- 定义日志的输出媒介，下面定义日志以四种方式输出。也可以下面的按照一种类型或其他类型输出。 -->
     < root >
       <!-- 文件形式记录日志 -->
       < appender-ref  ref ="LogFileAppender"   />
       <!-- 控制台控制显示日志 -->
       < appender-ref  ref ="ConsoleAppender"   />
       <!-- Windows事件日志 -->
       < appender-ref  ref ="EventLogAppender"   />
       <!--  如果不启用相应的日志记录，可以通过这种方式注释掉
      <appender-ref ref="AdoNetAppender_Access" />
       -->
     </ root >
    
   </ log4net >
</ configuration >

程序文件：

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using System.Reflection;
using log4net;

// 注意下面的语句一定要加上，指定log4net使用.config文件来读取配置信息
// 如果是WinForm（假定程序为MyDemo.exe，则需要一个MyDemo.exe.config文件）
// 如果是WebForm，则从web.config中读取相关信息
[assembly: log4net.Config.XmlConfigurator(Watch =  true)]
namespace Log4NetDemo
{
     ///   <summary>
     ///  说明：本程序演示如何利用log4net记录程序日志信息。log4net是一个功能著名的开源日志记录组件。
     ///  利用log4net可以方便地将日志信息记录到文件、控制台、Windows事件日志和数据库中（包括MS SQL Server, Access, Oracle9i,Oracle8i,DB2,SQLite）。
     ///  下面的例子展示了如何利用log4net记录日志
     ///  作者：周公
     ///  时间：2008-3-26
     ///  首发地址： http://blog.csdn.net/zhoufoxcn/archive/2008/03/26/2220533.aspx
     ///   </summary>
     public  class MainClass
    {
         public  static  void Main( string[] args)
        {
             // Application.Run(new MainForm());
             // 创建日志记录组件实例
            ILog log = log4net.LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
             // 记录错误日志
            log.Error("error", new Exception("发生了一个异常"));
             // 记录严重错误
            log.Fatal("fatal", new Exception("发生了一个致命错误"));
             // 记录一般信息
            log.Info("info");
             // 记录调试信息
            log.Debug("debug");
             // 记录警告信息
            log.Warn("warn");
            Console.WriteLine("日志记录完毕。");
            Console.Read();
        }
    }
}

运行结果：

控制台上的输出

日志文件内容

 

在这里需要特别说明一下，注意上面的代码中有这么一句：[assembly: log4net.Config.XmlConfigurator(Watch = true)]（在需要使用log4net的类的namespace处），如果没有这句就会在调试时得到如下留言中所说的“程序调试起来时isDebugEnable"的情况，希望大家注意。 

关于未尽之处，请看周公对下面读者的一些问题的答复《Log4Net使用详解（续）》。

=========================================================================

2.reference:

http://www.cnblogs.com/wangsaiming/archive/2013/01/11/2856253.html

第一步：下载Log4Net

           下载地址：http://logging.apache.org/log4net/download_log4net.cgi

           把下载的  log4net-1.2.11-bin-newkey解压后，如下图所示：

          

            双击bin文件夹

              

              双击net文件夹，选择针对.NET FramerWork的不同版本

              

             找到相应版本的log4net.dll

第二步：应用Log4Net

          

          1、在项目中添加Log4Net.DLL的引用

                开发环境：XP Professional Service Pack3

               开发工具：VS2010旗舰版

          新建个WinForm应用程序，效果图如下仅为了简单演示

            

           窗体命名为：FormMain

          把Log4Net.Dll复制到项目的根目录下，然后添加Log4Net的引用

          

 

      添加引用之后

    2、配置Log4Net

       （1）新建一个应用程序配置文件app.config

               

      （2）app.config的配置文件内容如下

       

 1 <?xml version="1.0"?>
 2 <configuration>
 3   <configSections>
 4     <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
 5   </configSections>
 6   <log4net>
 7     <!--定义输出到文件中-->
 8     <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
 9       <!--定义文件存放位置-->
10       <file value="log\\"/>
11       <appendToFile value="true"/>
12       <rollingStyle value="Date"/>
13       <datePattern value="yyyy\\yyyyMM\\yyyyMMdd'.txt'"/>
14       <staticLogFileName value="false"/>
15       <param name="MaxSizeRollBackups" value="100"/>
16       <layout type="log4net.Layout.PatternLayout">
17         <!--每条日志末尾的文字说明-->
18         <!--输出格式-->
19         <!--样例：2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
20         <conversionPattern value="%newline %n记录时间：%date %n线程ID:[%thread] %n日志级别：  %-5level %n出错类：%logger property: [%property{NDC}] - %n错误描述：%message%newline %n"/>
21       </layout>
22     </appender>
23     <root>
24       <level value="ERROR"/>
25       <!--文件形式记录日志-->
26       <appender-ref ref="RollingLogFileAppender"/>
27     </root>
28   </log4net>
29 </configuration>

 

      

    每个参数的含义请参考如下链接：

    Log4Net使用详解转载周公

    http://blog.csdn.net/zhoufoxcn/article/details/2220533

   Log4Net使用详解续转载周公

   http://www.cnblogs.com/zhoufoxcn/archive/2010/11/23/2515616.html

(3)新建一个LogHelper帮助类，为了在多个窗体中都进行调用，类内容如下：

  

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Text;
 5 
 6 [assembly: log4net.Config.XmlConfigurator(Watch = true)]
 7 namespace TestLog4Net
 8 {
 9    public  class LogHelper
10     {
11         /// <summary>
12         /// 输出日志到Log4Net
13         /// </summary>
14         /// <param name="t"></param>
15         /// <param name="ex"></param>
16         #region static void WriteLog(Type t, Exception ex)
17 
18         public static void WriteLog(Type t, Exception ex)
19         {
20             log4net.ILog log = log4net.LogManager.GetLogger(t);
21             log.Error("Error", ex);
22         }
23 
24         #endregion
25 
26         /// <summary>
27         /// 输出日志到Log4Net
28         /// </summary>
29         /// <param name="t"></param>
30         /// <param name="msg"></param>
31         #region static void WriteLog(Type t, string msg)
32 
33         public static void WriteLog(Type t, string msg)
34         {
35             log4net.ILog log = log4net.LogManager.GetLogger(t);
36             log.Error(msg);
37         }
38 
39         #endregion
40 
41 
42     }
43 }

此时生成解决方案，可能会出现如下错误信息：

   未能找到类型或命名空间名称"log4net"(是否缺少using指令或程序集引用?)解决方法  

   当前上下文中不存在名称"log4net"解决方法

此时可能有的人很纳闷，明明添加了引用怎么还提示找不到命名空间呢。解决这个问题很简单，右键项目选择属性

 

 

 

将目标框架默认的.NET Framework4 Client Profile修改为.NET Framework4之后再重新生成解决方案就行了。

 

第三步：测试Log4Net

 

           在按钮的事件中添加如下的代码

 

 1 using System;
 2 using System.Collections.Generic;
 3 using System.ComponentModel;
 4 using System.Data;
 5 using System.Drawing;
 6 using System.Linq;
 7 using System.Text;
 8 using System.Windows.Forms;
 9 
10 namespace TestLog4Net
11 {
12     public partial class FormMain : Form
13     {
14         public FormMain()
15         {
16             InitializeComponent();
17         }
18 
19         private void btnTest_Click(object sender, EventArgs e)
20         {
21             //第一种记录用法
22             //（1）FormMain是类名称
23             //（2）第二个参数是字符串信息
24             LogHelper.WriteLog(typeof(FormMain), "测试Log4Net日志是否写入");
25 
26 
27             //第二种记录用法
28             //（1）FormMain是类名称
29             //（2）第二个参数是需要捕捉的异常块
30             //try { 
31             
32             //}catch(Exception ex){
33 
34             //    LogHelper.WriteLog(typeof(FormMain), ex);
35 
36             //}
37           
38 
39         }
40     }
41 }

 

 

运行项目点击Button按钮，在项目的根目录下就会看到log文件夹

打开log文件夹就会看到里面以日期命名的文件夹一直打开可以看到如下图

看到这个文件就说明log4net.dll的应用已经成功了。

 

 

备注：文件夹的命名是根据你在app.config里面设置的file节点自动生成的，你可以根据自己的需要自己设置存放的路径和格式等。

       如果部分图片显示不出来，请用Chrome浏览器查看。

      下载log4net测试源码