[MVC學習筆記]4.使用Log4Net來進行錯誤日誌的記錄

分析ASP.NET MVC中隱藏處理的方法,使用記憶體隊列記錄日誌防止併發錯誤,Log4Net的使用方法及簡單應用 ...

在Web應用運行過程中，我們難免會遇到程式運行異常，這個時候我們就應該將異常信息記錄下來，以便開發人員和維護人員對異常原因進行還原，對異常原因進行修複。在ASP.NET平臺中進行日誌記錄的組件也有很多，如Log4Net、CommonLogging等，我們這裡選用Log4Net進行異常日誌的記錄。

1.捕獲異常

在ASP.NET MVC中提供了一個全局的異常處理過濾器：HandleErrorAttribute，可以通過該過濾器捕獲異常信息。

我們在Models文件夾下新建類型Log4ExceptionAttribute，繼承HandleErrorAttribute類，同時重寫OnException方法來捕獲異常數據：

using System.Web.Mvc;

namespace PMS.WebApp.Models
{
    public class Log4ExceptionAttribute:HandleErrorAttribute
    {
        /// <summary>
        /// 重寫OnException方法來捕獲異常數據
        /// </summary>
        /// <param name="filterContext"></param>
        public override void OnException(ExceptionContext filterContext)
        {
            base.OnException(filterContext);
            //捕獲當前異常數據
            var ex = filterContext.Exception;
        }
    }
}

新建過濾器後我們還需要在Global文件中調用的RegisterGlobalFilters方法中完成自己定義異常處理過濾的註冊。

using System.Web.Mvc;
using PMS.WebApp.Models;

namespace PMS.WebApp
{
    public class FilterConfig
    {
        public static void RegisterGlobalFilters(GlobalFilterCollection filters)
        {
            //filters.Add(new HandleErrorAttribute());
            filters.Add(new Log4ExceptionAttribute());
        }
    }
}

2.考慮到多用戶併發操作時可能產生的問題，我們需要新建一個隊列來進行異常信息的暫存，同時開闢一個線程專門對隊列中的異常信息進行處理。

在Log4ExceptionAttribute類中新建一個靜態的異常類型的隊列，在發生異常後，程式自動觸發OnException方法，方法中將當前的異常信息入隊後，跳轉到錯誤頁面。

using System;
using System.Collections.Generic;
using System.Web.Mvc;

namespace PMS.WebApp.Models
{
    public class Log4ExceptionAttribute:HandleErrorAttribute
    {
        public static Queue<Exception> Exceptions=new Queue<Exception>();
        /// <summary>
        /// 重寫OnException方法來捕獲異常數據
        /// </summary>
        /// <param name="filterContext"></param>
        public override void OnException(ExceptionContext filterContext)
        {
            base.OnException(filterContext);
            //捕獲當前異常數據
            var ex = filterContext.Exception;
            //將異常數據入隊
            Exceptions.Enqueue(ex);
            //跳轉到錯誤頁面
            filterContext.HttpContext.Response.Redirect("/Error.html");
        }
    }
}

Log4Net的配置是在應用程式配置文件中進行的，我們先在配置文件中進行Log4Net的配置。Log4Net需要配置的節點位置和SpringNet完全相同，首先需要在configSessions中新增子節點,然後在configuration節點中增加log4net節點完成具體配置。

<configuration>
  <configSections>
    <section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
    <!-- For more information on Entity Framework configuration, visit http://go.microsoft.com/fwlink/?LinkID=237468 -->
    
    <!--↓Log4Net配置↓-->
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
    <!--↑Log4Net配置↑-->
    
    <!--↓Spring.Net配置↓-->
    <sectionGroup name="spring">
      <section name="context" type="Spring.Context.Support.MvcContextHandler, Spring.Web.Mvc4"/>
    </sectionGroup>
    <!--↑Spring.Net配置↑-->
    
  </configSections>
  
  <!--↓Spring.Net配置↓-->
  <spring>
    <context>
      <resource uri="file://~/Config/controllers.xml"/>
      <resource uri="file://~/Config/services.xml"/>
    </context>
  </spring>
  <!--↑Spring.Net配置↑-->
  
  <!--↓Log4Net配置↓-->
  <log4net>
    <!-- OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL -->
    <!-- Set root logger level to ERROR and its appenders -->
    <root>
      <level value="ALL"/>
      <appender-ref ref="SysAppender"/>
    </root>

    <!-- Print only messages of level DEBUG or above in the packages -->
    <logger name="WebLogger">
      <level value="DEBUG"/>
    </logger>

    <appender name="SysAppender" type="log4net.Appender.RollingFileAppender,log4net" >
      <param name="File" value="App_Data/" />
      <param name="AppendToFile" value="true" />
      <param name="RollingStyle" value="Date" />
      <param name="DatePattern" value="&quot;Logs_&quot;yyyyMMdd&quot;.txt&quot;" />
      <param name="StaticLogFileName" value="false" />
      <layout type="log4net.Layout.PatternLayout,log4net">
        <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
        <param name="Header" value="&#13;&#10;----------------------header--------------------------&#13;&#10;" />
        <param name="Footer" value="&#13;&#10;----------------------footer--------------------------&#13;&#10;" />
      </layout>
    </appender>
    <appender name="consoleApp" type="log4net.Appender.ConsoleAppender,log4net">
      <layout type="log4net.Layout.PatternLayout,log4net">
        <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
      </layout>
    </appender>
  </log4net>
  <!--↑Log4Net配置↑-->
  ...
</configuration>

在配置文件中可以對日誌記錄的信息、格式、文件名等作出具體的配置，下麵是配置信息的詳解

<?xml version="1.0"?>
<configuration>
  <configSections>
    <section name="log4net" 
             type="log4net.Config.Log4NetConfigurationSectionHandler,log4net"/>
  </configSections>
  <!--站點日誌配置部分-->
  <log4net>
    <root>
      <!--控制級別，由低到高: ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF-->
      <!--比如定義級別為INFO，則INFO級別向下的級別，比如DEBUG日誌將不會被記錄-->
      <!--如果沒有定義LEVEL的值，則預設為DEBUG-->
      <level value="ERROR"/>
      <appender-ref ref="RollingFileAppender"/>
    </root>
    <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
      <!--日誌文件名開頭-->
      <file value="c:\Log\TestLog4net.TXT"/>
      <!--多線程時採用最小鎖定-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock"/>
      <!--日期的格式，每天換一個文件記錄，如不設置則永遠只記錄一天的日誌，需設置-->
      <datePattern value="(yyyyMMdd)"/>
      <!--是否追加到文件,預設為true，通常無需設置-->
      <appendToFile value="true"/>
      <!--變換的形式為日期，這種情況下每天只有一個日誌-->
      <!--此時MaxSizeRollBackups和maximumFileSize的節點設置沒有意義-->
      <!--<rollingStyle value="Date"/>-->
      <!--變換的形式為日誌大小-->
      <!--這種情況下MaxSizeRollBackups和maximumFileSize的節點設置才有意義-->
      <RollingStyle value="Size"/>
      <!--每天記錄的日誌文件個數，與maximumFileSize配合使用-->
      <MaxSizeRollBackups value="10"/>
      <!--每個日誌文件的最大大小-->
      <!--可用的單位:KB|MB|GB-->
      <!--不要使用小數,否則會一直寫入當前日誌-->
      <maximumFileSize value="2MB"/>
      <!--日誌格式-->
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%t]%-5p %c - %m%n"/>
      </layout>
    </appender>
  </log4net>
</configuration>

在Global文件中的Application_Start方法中開啟一個線程，用於將隊列中的錯誤信息寫入日誌文件。

using System.Linq;
using System.Threading;
using System.Web.Http;
using System.Web.Mvc;
using System.Web.Optimization;
using System.Web.Routing;
using log4net;
using PMS.WebApp.Models;
using Spring.Web.Mvc;

namespace PMS.WebApp
{
    // 註意: 有關啟用 IIS6 或 IIS7 經典模式的說明，
    // 請訪問 http://go.microsoft.com/?LinkId=9394801

    public class MvcApplication : SpringMvcApplication//HttpApplication
    {
        protected void Application_Start()
        {
            log4net.Config.XmlConfigurator.Configure();//讀取Log4Net配置信息
            AreaRegistration.RegisterAllAreas();

            WebApiConfig.Register(GlobalConfiguration.Configuration);
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);

            //開啟一個線程,掃描異常信息隊列.
            var filePath = Server.MapPath("/Log/");
            ThreadPool.QueueUserWorkItem((a) =>
            {
                while (true)
                {
                    //判斷隊列中是否有數據
                    if (Log4ExceptionAttribute.Exceptions.Any())
                    {
                        //出隊一條異常信息
                        var ex = Log4ExceptionAttribute.Exceptions.Dequeue();
                        //若異常信息不為空
                        if (ex == null) continue;
                        //將異常信息寫入到日誌文件中
                        var logger = LogManager.GetLogger("errorMsg");
                        logger.Error(ex.ToString());
                    }
                    else
                    {
                        //若異常信息隊列為空，則線程休息三秒
                        Thread.Sleep(3000);
                    }
                }
            }, filePath);
        }
    }
}

成功完成錯誤日誌的配置。