從壹開始前后端分離 [.netCore 不定期更新 ] 三十五║ 完美實現全局異常日志記錄

緣起

哈嘍我是不定期更新的日常，昨天群里小伙伴問到了記錄日志，當然，以前我也挖過這個坑，后來一直沒有來得及填上，也想着 swagger 一直又有錯誤信息展示的功能，就遲遲沒有添加這個功能，不過昨天夜里想了想，還是需要增加上，旨在提高框架的高效性。不定期日常就直接上代碼了，我有一個小想法，就是希望大家有好的想法，可以給我說，我會整理下，添加到框架里，並在文章頭里寫上

投稿作者：這里重點說明下，是參考群里小伙伴 Hello World!  的相關內容，並在他的基礎上更新，添加了注入和全局，大家可以看看他的文章，支持開源，棒棒噠。

廢話不多，直接來看，最終的效果是這樣的：

 

更新：評論席很精彩

1、感謝網友@夢亦曉的意見，目前是在 .net core api 中可以捕獲，至於 mvc 的view視圖中的錯誤是否可以，熱心觀眾可以試試，感激不盡。

2、@易墨 提出了中間件的方法，在評論席里，我感覺也不錯，大家可以看看，中間件更偏重非業務操作，只不過需要注意中間件的順序。

3、感謝@blackheart 從官方教程中，提出指正，其實官方已經內置了接口ILogger，當然你可以直接用 官方地址

4、關於日志記錄，還有 NLog日志、Exceptionless分布式日志、官方的Logging等等都可以用，看個人喜好吧。甚至可以自己寫一個loghepler，但是一定要盡量使用接口，不僅可以依賴注入，還可以以后方便替換，不會到時候破壞底層框架。

 

一、添加日志接口類

在 Blog.core 下的 Log 文件夾內，新建 ILoggerHelper.cs 

更新：這個接口其實也沒必要，你可以直接參考官方提供的ILogger，然后注入就行，當然看個人習慣吧，如果一定要自己設計，可按照我的方法設計接口

namespace Blog.Core.Log
{
    /// <summary>
    /// 日志接口
    /// </summary>
    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);
    }

}

 

二、實現日志幫助類，引入 log4net 

1、在 Log 文件夾下新建 LogHelper.cs

namespace Blog.Core.Log
{
    /// <summary>
    /// 日志幫助實現類
    /// </summary>
    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);
        }
    }
}

 

2、引用 nuget 包 

 

這個時候，你會發現還有一個錯誤 ， 不過別慌，請往下看。

 

三、配置 LogManger 自啟動

1、在啟動文件中添加 Loger 日志倉庫

這個具體深入的概念，我還在研究中，有時間補充下，這里大概了解用法以及概念，留一個坑

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

Repository可以說成基於一個log4net配置節創建的log4net容器，它根據log4net配置節的指示創建其他所有對象（Logger/Appender/Filter/Layout等等）並保有他們的實例，隨時為你所用。

 每個Repository都有自己唯一的名字，如 root。

 一般而言一個AppDomain(或者說一個進程)有一個Repository，該AppDomain下所有程序集Assembly都可以使用這個Repository。Repository需要實現ILoggerRepository，log4net中log4net.Repository.Hierarchy.Hierarchy就通過繼承LoggerRepositorySkeleton實現了ILoggerRepository，它也是log4net中唯一實現ILoggerRepository的類。     

2、在 Startup.cs 啟動文件的 構造函數中，添加日志啟動

 //log4net
 repository = LogManager.CreateRepository("");//需要獲取日志的倉庫名，也就是你的當然項目名
 //指定配置文件，如果這里你遇到問題，應該是使用了InProcess模式，請查看Blog.Core.csproj,並刪之 

 XmlConfigurator.Configure(repository, new FileInfo("log4net.config"));//配置文件

 

 

3、配置 log4net.config 文件

 在 Blog.core 根目錄下，添加 Log4net.config

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

  <log4net>
    <!-- 將日志以回滾文件的形式寫到文件中 -->
    <!-- 按日期切分日志文件，並將日期作為日志文件的名字 -->
    <appender name="RollingFileAppenderNameByDate" type="log4net.Appender.RollingFileAppender">
      <!-- 日志文件存放位置，可以為絕對路徑也可以為相對路徑 -->
      <file value="C:\Logs\" />
      <!-- 將日志信息追加到已有的日志文件中-->
      <appendToFile value="true" />
      <!-- 最小鎖定模式，以允許多個進程可以寫入同一個文件 -->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <!-- 指定按日期切分日志文件 -->
      <rollingStyle value="Date" />
      <!-- 日志文件的命名規則 -->
      <datePattern value="&quot;UtilLogs_&quot;yyyyMMdd&quot;.log&quot;" />
      <!-- 當將日期作為日志文件的名字時，必須將staticLogFileName的值設置為false -->
      <staticLogFileName value="false" />
      <!-- 日志顯示模板 -->
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="【異常時間】：%date %newline%message%newline--------------------------------------------------------------------%newline" />
      </layout>
    </appender>

    <root>
      <!-- 控制級別，由低到高：ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF -->
      <!-- 比如定義級別為INFO，則INFO級別向下的級別，比如DEBUG日志將不會被記錄 -->
      <!-- 如果沒有定義LEVEL的值，則缺省為DEBUG -->
      <level value="ALL" />
      <!-- 按日期切分日志文件，並將日期作為日志文件的名字 -->
      <appender-ref ref="RollingFileAppenderNameByDate" />
    </root>
  </log4net>
</configuration>

最終的結構是

 

這個時候，我們已經把日志添加好了，可以在任何需用用的地方去使用了，你會問了，不是全局么，總不能每個方法都寫 try catch 吧，有想法，請往下看。

 

四、定義全局異常過濾器

提醒下：

1、下邊的全局處理中，網友@夢亦曉：IExceptionFilter只能抓取Action執行過程中出現的未處理的異常。如果想捕獲view中的異常需要在startup中的Configure中 實現app.UseExceptionHandler()；

 

1、日志接口進行注入

 在 啟動文件的 ConfigureServices方法中，添加服務注入

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

 

2、Blog.core 新建Filter 文件夾，添加 GlobalExceptionFilter.cs

 

namespace Blog.Core.Filter
{
    /// <summary>
    /// 全局異常錯誤日志
    /// </summary>
    public class GlobalExceptionsFilter : IExceptionFilter
    {
        private readonly IHostingEnvironment _env;
        private readonly ILoggerHelper _loggerHelper;
        public GlobalExceptionsFilter(IHostingEnvironment 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, WriteLog(json.Message, context.Exception));

        }

        /// <summary>
        /// 自定義返回格式
        /// </summary>
        /// <param name="throwMsg"></param>
        /// <param name="ex"></param>
        /// <returns></returns>
        public string WriteLog(string throwMsg, Exception ex)
        {
            return string.Format("【自定義錯誤】：{0} \r\n【異常類型】：{1} \r\n【異常信息】：{2} \r\n【堆棧調用】：{3}", new object[] { throwMsg,
                ex.GetType().Name, ex.Message, ex.StackTrace });
        }

    }
    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; }
    }

}

 

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

//注入全局異常捕獲
services.AddMvc(o =>
{
    o.Filters.Add(typeof(GlobalExceptionsFilter));
}).SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

結構是這樣的

 

4、自定義錯誤進行測試

 我故意寫錯數據庫連接字符串，看看 swagger 如何報錯

 

看看日志是如何記錄的

 

五、結語

今天是不定期更新系列，也是群里小伙伴提出來的想法，我自己簡單搞搞，這里希望大家可以積極提意見喲，如果技術不錯，我會把你的個人主頁和Git放到文章中，也算是鼓勵大家的一個方式了。

 

1、網友好的點子：

1.  在.NET Core中使用Exceptionless分布式日志收集框架

 

六、Github & Gitee

https://github.com/anjoy8/Blog.Core

https://gitee.com/laozhangIsPhi/Blog.Core