從壹開始前後端分離 [.netCore 不定期更新 ] 三十五║ 完美實現全域性異常日誌記錄
阿新 • • 發佈：2018-12-17
緣起
哈嘍我是不定期更新的日常，昨天群裡小夥伴問到了記錄日誌，當然，以前我也挖過這個坑，後來一直沒有來得及填上，也想著 swagger 一直又有錯誤資訊展示的功能，就遲遲沒有新增這個功能，不過昨天夜裡想了想，還是需要增加上，旨在提高框架的高效性。不定期日常就直接上程式碼了，我有一個小想法，就是希望大家有好的想法，可以給我說，我會整理下，新增到框架裡，並在文章頭裡寫上
投稿作者：這裡重點說明下，是參考群裡小夥伴 Hello World! 的相關內容，並在他的基礎上更新，添加了注入和全域性，大家可以看看他的文章，支援開源，棒棒噠。
廢話不多，直接來看，最終的效果是這樣的：
更新：評論席很精彩
1、感謝網友@的意見，目前是在 .net core api 中可以捕獲，至於 mvc 的view檢視中的錯誤是否可以，熱心觀眾可以試試，感激不盡。
2、@ 提出了中介軟體的方法，在評論席裡，我感覺也不錯，大家可以看看，中介軟體更偏重非業務操作，只不過需要注意中介軟體的順序。
3、感謝@ 從官方教程中，提出指正，其實官方已經內建了介面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("");//需要獲取日誌的倉庫名，也就是你的當然專案名 //指定配置檔案 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=""UtilLogs_"yyyyMMdd".log"" /> <!-- 當將日期作為日誌檔案的名字時，必須將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