log4net 在 Winform中的使用

本次想在winform中用log4net,網上教程很多,但是也讓我走了幾下彎路。現記錄詳細使用步驟如下:

 

1、lot4net簡介:

log4net(Log For Net)是Apache開源的應用於.Net框架的日誌記錄工具,詳細信息參見Apache網站.它是針對Java的log4j(Log For Java的)姊妹工具.用過log4j的都知道,它功能強大,可配置性靈活,線程安全,對日誌的輸出管理和級別管理方便。使用log4net需要知道其中兩個比較重要的概念:logger 和 appender。前者是日誌記錄對象,後者是日誌記錄的目標載體,包括控制檯,文件,定量大小的文件,遠程廣播。log4net的工作原理簡單地說是這樣的:獲得一個用來記錄日誌的工具對象logger,然後爲logger對象指定日誌的記錄位置。值得一提的是這一切工作都可以在應用程序的配置文件中完成,所需代碼量極少。

2、單項目配置

2.1、引用log4net.dll

    兩個方式:

    a、在NuGet包管理器中安裝

    b、下載dll,引用

2.2、在app.config中添加配置

    寫在<configuration>節點內。具體配置信息見附錄。

2.3、在Properties-->AssemblyInfo.cs文件中添加配置

    [assembly: log4net.Config.XmlConfigurator(Watch = true)]

2.4、創建LogHelper.cs,方便使用

    具體類信息見附錄。

2.5、在程序中使用,方式示例如下

            log.Info("ft輸出INfO信息");
            log.Debug("ft輸出Debug信息");
            log.Warn("ft輸出Warn信息");
            log.Error("ft輸出Error信息");

3、多項目配置

    把LogHelper.cs提取出來公用,其它配置信息每個需要打印日誌的項目還是都需要單獨配置的。

4、全局異常捕獲

在下面的連個事件中進行捕獲(具體寫法見附3):

Application.ThreadException 事件--UI線程中某個異常未被捕獲時出現。

AppDomain.UnhandledException 事件--非UI線程中某個異常未被捕獲時出現。

 

 

附1、在app.config中添加的配置信息

  <configSections>
    <sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" >
      <section name="AdjustMeter.My.MySettings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
    </sectionGroup>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
  </configSections>
  <system.diagnostics>
    <sources>
      <!-- 本部分定義 My.Application.Log 的登錄配置-->
      <source name="DefaultSource" switchName="DefaultSwitch">
        <listeners>
          <add name="FileLog"/>
          <!-- 取消以下部分的註釋,以寫入應用程序事件日誌-->
          <!--<add name="EventLog"/>-->
        </listeners>
      </source>
    </sources>
    <switches>
      <add name="DefaultSwitch" value="Information" />
    </switches>
    <sharedListeners>
      <add name="FileLog"
           type="Microsoft.VisualBasic.Logging.FileLogTraceListener, Microsoft.VisualBasic, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL"
           initializeData="FileLogWriter"/>
      <!-- 取消以下部分的註釋,並用應用程序名替換 APPLICATION_NAME,以寫入應用程序事件日誌-->
      <!--<add name="EventLog" type="System.Diagnostics.EventLogTraceListener" initializeData="APPLICATION_NAME"/> -->
    </sharedListeners>
  </system.diagnostics>
  <applicationSettings>
    <AdjustMeter.My.MySettings>
      <setting name="HL_Meter_WebReference_Service" serializeAs="String">
        <value>http://172.16.23.63/webjmj/Service.asmx</value>
      </setting>
    </AdjustMeter.My.MySettings>
  </applicationSettings>
  <log4net>
    <root>
      <!--控制級別,由低到高: ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF-->
      <!--比如定義級別爲INFO,則INFO級別向下的級別,比如DEBUG日誌將不會被記錄-->
      <!--如果沒有定義LEVEL的值,則缺省爲DEBUG-->
      <level value="ALL" />
      <appender-ref ref="InfoAppender" />
      <appender-ref ref="DebugAppender" />
      <appender-ref ref="ErrorAppender" />
    </root>
    <appender name="DebugAppender" type="log4net.Appender.RollingFileAppender">
      <!--定義文件存放位置-->
      <file value="TermLog\\Frames\\"/>
      <appendToFile value="true"/>
      <rollingStyle value="Date"/>
      <datePattern value="yyyyMMdd'.txt'"/>
      <staticLogFileName value="false"/>
      <param name="MaxSizeRollBackups" value="100"/>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]Frames %c - %m%n"/>
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <param name="LevelMin" value="DEBUG" />
        <param name="LevelMax" value="DEBUG" />
      </filter>
    </appender>
    <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">
      <!--定義文件存放位置-->
      <file value="TermLog\\Error\\"/>
      <appendToFile value="true"/>
      <rollingStyle value="Date"/>
      <datePattern value="yyyyMMdd'.txt'"/>
      <staticLogFileName value="false"/>
      <param name="MaxSizeRollBackups" value="100"/>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]%-5p %c - %n%m%n%n"/>
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <param name="LevelMin" value="ERROR" />
        <param name="LevelMax" value="ERROR" />
      </filter>
    </appender>
  </log4net>

 

附錄2、LogHelper.cs


    public class LogHelper
    {
        private static readonly ILog logInfo = LogManager.GetLogger("Log");
        private static readonly ILog logErr = LogManager.GetLogger("Err");
        /// <summary>
        /// 記錄正常的消息
        /// </summary>
        /// <param name="msg">消息內容</param>
        public static void info(string msg)
        {
            logInfo.Info(msg);
        }
        /// <summary>
        /// 記錄異常信息
        /// </summary>
        /// <param name="msg">異常信息內容</param>
        public static void error(string msg)
        {
            StackTrace stackTrace = new StackTrace();
            StackFrame stackFrame = stackTrace.GetFrame(1);
            MethodBase methodBase = stackFrame.GetMethod();
            logErr.Error("類名:" + methodBase.ReflectedType.Name + " 方法名:" + methodBase.Name + " 信息:" + msg);
        }

 

附3、全局異常捕獲

using System;
using System.Collections.Generic;
using System.Linq;
using System.Windows.Forms;
using System.Text;
using Common;

namespace testLog4N
{
    static class Program
    {
        /// <summary>
        /// 應用程序的主入口點。
        /// </summary>
        [STAThread]
        static void Main()
        {
            BindExceptionHandler();//綁定程序中的異常處理
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            Application.Run(new Form1());
        }
        /// <summary>
        /// 綁定程序中的異常處理
        /// </summary>
        private static void BindExceptionHandler()
        {
            //設置應用程序處理異常方式:ThreadException處理
            Application.SetUnhandledExceptionMode(UnhandledExceptionMode.CatchException);
            //處理UI線程異常
            Application.ThreadException += new System.Threading.ThreadExceptionEventHandler(Application_ThreadException);
            //處理未捕獲的異常
            AppDomain.CurrentDomain.UnhandledException += new UnhandledExceptionEventHandler(CurrentDomain_UnhandledException);
        }
        /// <summary>
        /// 處理UI線程異常
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        static void Application_ThreadException(object sender, System.Threading.ThreadExceptionEventArgs e)
        {
            LogHelper.ErrorLog(null, e.Exception as Exception);
        }
        /// <summary>
        /// 處理未捕獲的異常
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        static void CurrentDomain_UnhandledException(object sender, UnhandledExceptionEventArgs e)
        {
            LogHelper.ErrorLog(null, e.ExceptionObject as Exception);
        }
    }
}

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章