.Net Core3.0 WebApi 十一：基於Log4j的全局異常處理

.Net Core3.0 WebApi 目錄

安裝Log4j

webapi.core.api項目Nuget安裝Log4j

 

 

 添加Log4net.json配置文件

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <configSections>
        <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
    </configSections>

    <system.web>
        <compilation debug="true" targetFramework="4.5.2" />
        <httpRuntime targetFramework="4.5.2" />
    </system.web>
    <log4net>
        <!--錯誤日志：：：記錄錯誤日志-->
        <!--按日期分割日志文件 一天一個-->
        <!-- appender 定義日志輸出方式   將日志以回滾文件的形式寫到文件中。-->
        <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">
            <!--保存路徑：下面路徑項目啟動的時候自動在C盤中創建log、logError文件-->
            <file value="log/error/error_" />
            <!-- 如果想在本項目中添加路徑，那就直接去掉C:\\  只設置log\\LogError   項目啟動中默認創建文件 -->
            <appendToFile value="true"/>
            <!--按照何種方式產生多個日志文件(日期[Date],文件大小[Size],混合[Composite])-->
            <rollingStyle value="Date"/>
            <!--這是按日期產生文件夾-->
            <datePattern value="yyyy-MM-dd'.log'"/>
            <!--是否只寫到一個文件中-->
            <staticLogFileName value="false"/>
            <!--保留的log文件數量 超過此數量后 自動刪除之前的   好像只有在 按Size分割時有效 設定值value="－1"為不限文件數-->
            <param name="MaxSizeRollBackups" value="100"/>
            <!--每個文件的大小。只在混合方式與文件大小方式下使用。超出大小后在所有文件名后自動增加正整數重新命名，數字最大的最早寫入。可用的單位:KB|MB|GB。不要使用小數,否則會一直寫入當前日志-->
            <maximumFileSize value="50MB" />
            <!-- layout 控制Appender的輸出格式，也可以是xml  一個Appender只能是一個layout-->
            <layout type="log4net.Layout.PatternLayout">
                <!--每條日志末尾的文字說明-->
                <!--輸出格式 模板-->
                <!-- <param name="ConversionPattern"  value="記錄時間：%date 線程ID:[%thread] 日志級別：%-5level 記錄類：%logger   
        操作者ID：%property{Operator} 操作類型：%property{Action}%n  當前機器名:%property%n當前機器名及登錄用戶：%username %n  
        記錄位置：%location%n 消息描述：%property{Message}%n   異常：%exception%n 消息：%message%newline%n%n" />-->

                <!--樣例：2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
                <!--<conversionPattern value="%newline %n記錄時間：%date %n線程ID:[%thread] %n日志級別： %-5level %n錯誤描述：%message%newline %n"/>-->
                <conversionPattern value="%n＝＝＝＝＝＝＝＝＝＝
                                  %n【日志級別】%-5level
                                  %n【記錄時間】%date
                                  %n【執行時間】[%r]毫秒
                                  %n【錯誤位置】%logger 屬性[%property{NDC}]
                                  %n【錯誤描述】%message
                                  %n【錯誤詳情】%newline"/>
            </layout>
            <filter type="log4net.Filter.LevelRangeFilter,log4net">
                <levelMin value="ERROR" />
                <levelMax value="FATAL" />
            </filter>
        </appender>

        <!--DEBUG：：：記錄DEBUG日志-->
        <!--按日期分割日志文件 一天一個-->
        <!-- appender 定義日志輸出方式   將日志以回滾文件的形式寫到文件中。-->
        <appender name="DebugAppender" type="log4net.Appender.RollingFileAppender">
            <!--保存路徑：下面路徑項目啟動的時候自動在C盤中創建log、logError文件-->
            <file value="log/debug/debug_" />
            <!-- 如果想在本項目中添加路徑，那就直接去掉C:\\  只設置log\\LogError   項目啟動中默認創建文件 -->
            <appendToFile value="true"/>
            <!--按照何種方式產生多個日志文件(日期[Date],文件大小[Size],混合[Composite])-->
            <rollingStyle value="Date"/>
            <!--這是按日期產生文件夾-->
            <datePattern value="yyyy-MM-dd'.log'"/>
            <!--是否只寫到一個文件中-->
            <staticLogFileName value="false"/>
            <!--保留的log文件數量 超過此數量后 自動刪除之前的   好像只有在 按Size分割時有效 設定值value="－1"為不限文件數-->
            <param name="MaxSizeRollBackups" value="100"/>
            <!--每個文件的大小。只在混合方式與文件大小方式下使用。超出大小后在所有文件名后自動增加正整數重新命名，數字最大的最早寫入。可用的單位:KB|MB|GB。不要使用小數,否則會一直寫入當前日志-->
            <maximumFileSize value="50MB" />
            <!-- layout 控制Appender的輸出格式，也可以是xml  一個Appender只能是一個layout-->
            <layout type="log4net.Layout.PatternLayout">
                <!--每條日志末尾的文字說明-->
                <!--輸出格式 模板-->
                <!-- <param name="ConversionPattern"  value="記錄時間：%date 線程ID:[%thread] 日志級別：%-5level 記錄類：%logger   
        操作者ID：%property{Operator} 操作類型：%property{Action}%n  當前機器名:%property%n當前機器名及登錄用戶：%username %n  
        記錄位置：%location%n 消息描述：%property{Message}%n   異常：%exception%n 消息：%message%newline%n%n" />-->

                <!--樣例：2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
                <!--<conversionPattern value="%newline %n記錄時間：%date %n線程ID:[%thread] %n日志級別： %-5level %n錯誤描述：%message%newline %n"/>-->
                <conversionPattern value="%n＝＝＝＝＝＝＝＝＝＝
                                  %n【日志級別】%-2level
                                  %n【記錄時間】%date
                                  %n【執行時間】[%r]毫秒
                                  %n【debug位置】%logger 屬性[%property{NDC}]
                                  %n【debug描述】%message"/>
            </layout>
            <filter type="log4net.Filter.LevelRangeFilter,log4net">
                <levelMin value="DEBUG" />
                <levelMax value="WARN" />
            </filter>
        </appender>
        <!--Set root logger level to DEBUG and its only appender to A1-->
        <root>
            <!--控制級別，由低到高: ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF-->
            <level value="ALL" />
            <appender-ref ref="DebugAppender" />
            <appender-ref ref="ErrorAppender" />
        </root>
    </log4net>
</configuration>

添加日志接口類

weapi.core.api項目新建Log 文件夾，新建 ILoggerHelper.cs 

namespace WebApi.Core.Api.Log
{
    public interface ILoggerHelper
    {

        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Debug(object source, string message);
        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="ps">ps</param>
        void Debug(object source, string message, params object[] ps);
        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Debug(Type source, string message);
        /// <summary>
        /// 關鍵信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Info(object source, object message);
        /// <summary>
        /// 關鍵信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Info(Type source, object message);
        /// <summary>
        /// 警告信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Warn(object source, object message);
        /// <summary>
        /// 警告信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Warn(Type source, object message);
        /// <summary>
        /// 錯誤信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Error(object source, object message);
        /// <summary>
        /// 錯誤信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Error(Type source, object message);
        /// <summary>
        /// 失敗信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Fatal(object source, object message);
        /// <summary>
        /// 失敗信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        void Fatal(Type source, object message);

        /* Log a message object and exception */

        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Debug(object source, object message, Exception exception);
        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Debug(Type source, object message, Exception exception);
        /// <summary>
        /// 關鍵信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Info(object source, object message, Exception exception);
        /// <summary>
        /// 關鍵信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Info(Type source, object message, Exception exception);
        /// <summary>
        /// 警告信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Warn(object source, object message, Exception exception);
        /// <summary>
        /// 警告信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Warn(Type source, object message, Exception exception);
        /// <summary>
        /// 錯誤信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Error(object source, object message, Exception exception);
        /// <summary>
        /// 錯誤信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Error(Type source, object message, Exception exception);
        /// <summary>
        /// 失敗信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Fatal(object source, object message, Exception exception);
        /// <summary>
        /// 失敗信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        void Fatal(Type source, object message, Exception exception);
    }
}

在 Log 文件夾下新建 LogHelper.cs

namespace WebApi.Core.Api.Log
{
    public class LogHelper : ILoggerHelper
    {
        private readonly ConcurrentDictionary<Type, ILog> Loggers = new ConcurrentDictionary<Type, ILog>();

        /// <summary>
        /// 獲取記錄器
        /// </summary>
        /// <param name="source">soruce</param>
        /// <returns></returns>
        private ILog GetLogger(Type source)
        {
            if (Loggers.ContainsKey(source))
            {
                return Loggers[source];
            }
            else
            {
                ILog logger = LogManager.GetLogger(Startup.repository.Name, source);
                Loggers.TryAdd(source, logger);
                return logger;
            }
        }

        /* Log a message object */
        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Debug(object source, string message)
        {
            Debug(source.GetType(), message);
        }
        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="ps">ps</param>
        public void Debug(object source, string message, params object[] ps)
        {
            Debug(source.GetType(), string.Format(message, ps));
        }
        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Debug(Type source, string message)
        {
            ILog logger = GetLogger(source);
            if (logger.IsDebugEnabled)
            {
                logger.Debug(message);
            }
        }
        /// <summary>
        /// 關鍵信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Info(object source, object message)
        {
            Info(source.GetType(), message);
        }
        /// <summary>
        /// 關鍵信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Info(Type source, object message)
        {
            ILog logger = GetLogger(source);
            if (logger.IsInfoEnabled)
            {
                logger.Info(message);
            }
        }
        /// <summary>
        /// 警告信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Warn(object source, object message)
        {
            Warn(source.GetType(), message);
        }
        /// <summary>
        /// 警告信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Warn(Type source, object message)
        {
            ILog logger = GetLogger(source);
            if (logger.IsWarnEnabled)
            {
                logger.Warn(message);
            }
        }
        /// <summary>
        /// 錯誤信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Error(object source, object message)
        {
            Error(source.GetType(), message);
        }
        /// <summary>
        /// 錯誤信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Error(Type source, object message)
        {
            ILog logger = GetLogger(source);
            if (logger.IsErrorEnabled)
            {
                logger.Error(message);
            }
        }
        /// <summary>
        /// 失敗信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Fatal(object source, object message)
        {
            Fatal(source.GetType(), message);
        }
        /// <summary>
        /// 失敗信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        public void Fatal(Type source, object message)
        {
            ILog logger = GetLogger(source);
            if (logger.IsFatalEnabled)
            {
                logger.Fatal(message);
            }
        }
        /* Log a message object and exception */

        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Debug(object source, object message, Exception exception)
        {
            Debug(source.GetType(), message, exception);
        }
        /// <summary>
        /// 調試信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Debug(Type source, object message, Exception exception)
        {
            GetLogger(source).Debug(message, exception);
        }
        /// <summary>
        /// 關鍵信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Info(object source, object message, Exception exception)
        {
            Info(source.GetType(), message, exception);
        }
        /// <summary>
        /// 關鍵信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Info(Type source, object message, Exception exception)
        {
            GetLogger(source).Info(message, exception);
        }
        /// <summary>
        /// 警告信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Warn(object source, object message, Exception exception)
        {
            Warn(source.GetType(), message, exception);
        }
        /// <summary>
        /// 警告信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Warn(Type source, object message, Exception exception)
        {
            GetLogger(source).Warn(message, exception);
        }
        /// <summary>
        /// 錯誤信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Error(object source, object message, Exception exception)
        {
            Error(source.GetType(), message, exception);
        }
        /// <summary>
        /// 錯誤信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Error(Type source, object message, Exception exception)
        {
            GetLogger(source).Error(message, exception);
        }
        /// <summary>
        /// 失敗信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Fatal(object source, object message, Exception exception)
        {
            Fatal(source.GetType(), message, exception);
        }
        /// <summary>
        /// 失敗信息
        /// </summary>
        /// <param name="source">source</param>
        /// <param name="message">message</param>
        /// <param name="exception">ex</param>
        public void Fatal(Type source, object message, Exception exception)
        {
            GetLogger(source).Fatal(message, exception);
        }
    }
}

配置LogManger 自啟動

在startup.cs文件中添加 Loger 日志倉庫

 /// <summary>
 /// log4net 倉儲庫
 /// </summary>
 public static ILoggerRepository repository { get; set; }

ConfigureServices方法中注入ILoggerHelper和日志啟動

//log注入ILoggerHelper
services.AddSingleton<ILoggerHelper, LogHelper>();

//log4net
repository = LogManager.CreateRepository("");//需要獲取日志的倉庫名，也就是你的當然項目名
XmlConfigurator.Configure(repository, new FileInfo("Log4net.config"));//指定配置文件，

測試日志

Test控制寫一個測試接口

namespace WebApi.Core.Api.Controllers
{
    /// <summary>
    /// 測試控制器
    /// </summary>
    public class TestController : BaseController
    {
        private readonly ILoggerHelper _logger;


        public TestController(ILoggerHelper loggerHelper)
        {
            _logger = loggerHelper;
        }

        /// <summary>
        /// 測試日志
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public IActionResult LogTest()
        {
            _logger.Error(typeof(TestController), "這是錯誤日志", new Exception("123"));
            _logger.Debug(typeof(TestController), "這是bug日志");
            //throw new System.IO.IOException();
            return Ok();
        }
    }
}

運行調試

 

 

 查看輸出的日志：

 

 

 

 

定義全局異常過濾器

 

 webapi.core.api項目 新建Filters 文件夾，添加 GlobalExceptionFilter.cs

namespace WebApi.Core.Api.Filters
{
    public class GlobalExceptionsFilter : IExceptionFilter
    {
        private readonly IHostEnvironment _env;
        private readonly ILoggerHelper _loggerHelper;

        public GlobalExceptionsFilter(IHostEnvironment env, ILoggerHelper loggerHelper)
        {
            _env = env;
            _loggerHelper = loggerHelper;
        }

        public void OnException(ExceptionContext context)
        {
            var json = new JsonErrorResponse();
            json.Message = context.Exception.Message;//錯誤信息
            if (_env.IsDevelopment())
            {
                json.DevelopmentMessage = context.Exception.StackTrace;//堆棧信息
            }
            context.Result = new InternalServerErrorObjectResult(json);

            //采用log4net 進行錯誤日志記錄
            _loggerHelper.Error(json.Message, "出現未知異常", context.Exception);

        }

        public class InternalServerErrorObjectResult : ObjectResult
        {
            public InternalServerErrorObjectResult(object value) : base(value)
            {
                StatusCode = StatusCodes.Status500InternalServerError;
            }
        }
        //返回錯誤信息
        public class JsonErrorResponse
        {
            /// <summary>
            /// 生產環境的消息
            /// </summary>
            public string Message { get; set; }
            /// <summary>
            /// 開發環境的消息
            /// </summary>
            public string DevelopmentMessage { get; set; }
        }

    }
}

在啟動服務中，注入全局異常

services.AddControllers(option =>
{
    option.Filters.Add(typeof(GlobalExceptionsFilter));
});

測試全局異常

Test控制器新建接口，這里直接拋出一個異常。

/// <summary>
/// 拋出異常
/// </summary>
/// <returns></returns>
[HttpGet]
public IActionResult Throw()
{
    throw new System.IO.IOException();
}

運行，測試接口

 

繼續執行，代碼會走到這里來，GlobalExceptionsFilter

 

 下面是響應的結果：

 

 查看日志文件，有日志輸出。