從零開始搭建前後端分離的NetCore2.2(EF Core CodeFirst+Autofac)+Vue的專案框架之五全域性異常處理
在 上一篇 中講到了在NetCore專案中如何配置NLog將日誌存到資料庫,這篇中將講述如何處理自定義丟擲的異常以及未處理的異常,並通過日誌記錄下來。
為什麼要進行異常的全域性處理和記錄日誌呢?
在實際的軟體專案開發與迭代中,無論程式設計師是久經沙場的老將,還是初出茅廬的萌新,出現異常(尤其是空指標異常)是必然的,
一般來說,當出現異常且沒有處理的情況下,異常會直接拋至執行環境,導致系統崩潰或其它錯誤,那麼如何才能做到系統在執行時遇到錯誤而不致使系統崩潰呢,需要在系統出現未捕捉的異常時進行全域性處理並記錄以方便修復!
在程式中,在某些地方可能需要手動丟擲異常,需要自定義訊息等等,因此,我們先新增自定義異常類 CustomSystemException 。
/// <inheritdoc /> /// <summary> /// 自定義系統錯誤異常 /// </summary> public class CustomSystemException : Exception { /// <summary> /// HTTP狀態碼 /// </summary> public int Code { get; set; } /// <summary> /// 錯誤訊息 /// </summary> public object[] Args { get; set; } public CustomSystemException(string message, int code, params object[] args) : base(message) { Code = code; Args = args; } }
在NetCore中有一個 ExceptionFilterAttribute 的異常過濾屬性,可以繼承它來重寫當觸發時的事件。
/// <inheritdoc /> /// <summary> /// 全域性異常處理過濾器 /// </summary> public class ExceptionFilter : ExceptionFilterAttribute { public override void OnException(ExceptionContext filterContext) { if (filterContext.ExceptionHandled) return; var controllerName = (string)filterContext.RouteData.Values["controller"]; var actionName = (string)filterContext.RouteData.Values["action"]; var request = filterContext.HttpContext.Request; LogHelper.Logger.Fatal(filterContext.Exception, $"【異常資訊】:{filterContext.Exception.Message} 【請求路徑】:{request.Method}:{request.Path}\n " + $"【控制器】:{controllerName} - 【方法】:{actionName}\n " + $"【主機地址】:{ DemoWeb.GetClientIp()} " + $"【使用者代理】:{ request.Headers["User-Agent"]}");//DemoWeb為前面章節新增的類 if (filterContext.Exception is CustomSystemException se) { filterContext.Result = new CustomHttpStatusCodeResult(200, se.Code, se.Message); } else { #if DEBUG Console.WriteLine(filterContext.Exception); var content = filterContext.Exception.ToJson();//ToJson為靜態擴充套件方法 為前面章節新增的類 #else var content = "系統錯誤,請稍後再試或聯絡系統管理人員。"; #endif filterContext.Result = new CustomHttpStatusCodeResult(200, 500, content);//CustomHttpStatusCodeResult為自定義返回結果 為前面章節新增的類 } filterContext.ExceptionHandled = true; } }
其中涉及到的在前面章節都有新增,統一返回結果以及靜態方法等。
這裡新增好了之後,我們需要將這個過濾器注入到MVC中去,在 Startup 類中的 ConfigureServices方法 中做如下更改:
services.AddMvc(options => { options.Filters.Add(new ExceptionFilter()); }).SetCompatibilityVersion(CompatibilityVersion.Version_2_1); //用上面的替換下面的 //services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
到這裡,新增完了全域性異常處理,然後在控制器層新增一個測試方法,測試程式碼如下: PS:若啟動訪問不到測試介面,請在啟動專案中新增該控制器類庫的引用!
[Route("api/[controller]")] public class ExceptionTestController : BaseController { [HttpGet] [Route("dividezero")] public ActionResult TestDivideZero() { LogHelper.Logger.Debug("測試除0異常"); var zero = 0; var test = 10 / zero; return Succeed(); } }
測試效果如下:
個人建議:不要用太多的異常處理,也最好不要進行手動丟擲異常處理,能規避的異常和能處理的異常建議都進行處理並返回提示資訊,同時要儘量避免使用套嵌異常處理,因為異常處理使用不合理會使系統的效能下降。
在下一篇中將介紹如何使用過濾器來進行模型驗證處理,驗證請求資料是否符合訪問模型設定的要求,並返回錯誤提示資訊。
有需要原始碼的在下方評論或私信~給我的SVN訪客賬戶密碼下載,程式碼未放在GitHub上。
&n