ASP.NET Core 中介軟體的使用之全域性異常處理機制
目錄
- 1、建立專案
- 2、建立全域性異常過濾器
- 3、依賴注入全域性異常處理機制
- 4、測試全域性異常處理機制
前言:
我們經常聽到“秒修復秒上線”,覺得很厲害的樣子。
其實不然,這只是一個調侃而已,出現問題的方式很多(邏輯漏洞、程式碼異常、操作方式不正確等)。
我們今天來說程式碼異常問題怎麼快速定位,減少不必要的時間浪費。
這就是今天的主題“新增全域性異常處理機制”捕捉異常儲存到(mongodb、SqlServer、等)。
PS:輸出txt的話不怎麼友好,不是所有人都能登入伺服器的。
異常是一種執行時錯誤,當異常沒有得到適當的處理,很可能會導致你的程式意外終止。
1、建立專案
我們建立一個ASP.NET Core Web API
.NET Core3.1
。
2、建立全域性異常過濾器
在控制器裡面建立一個異常過濾器,命名為ExceptionFilter.cs
,過濾器繼承IExceptionFilter
介面。
注意,我這裡入庫用的是efcore+sqlserver
,大家可以根據自己實際情況使用ORM
和資料庫方式。
異常過濾器,顧名思義,就是當程式發生異常時所使用的過濾器。用於在系統出現未捕獲異常時的處理。
實現一個自定義異常過濾器,自定義一個全域性異常過濾器需要實現IExceptionFilter
介面。
IExceptionFilter
介面會要求實現OnException
方法,當系統發生未捕獲異常時就會觸發這個方法。
OnException方法有一個ExceptionContext
異常上下文,其中包含了具體的異常資訊,HttpContext
及mvc
路由資訊。
系統一旦出現未捕獲異常後,比較常見的做法就是使用日誌工具,將異常的詳細資訊記錄下來,方便修正除錯。
下面是日誌記錄的實現:
using Microsoft.AspNetCore.Mvc.Filters; uwww.cppcns.comsing System; namespace Log4NetWebAPI.Controllers { public class ExceptionFilter: IExceptionFilter { //全域性異常處理機制 public void OnException(ExceptionContext context) { Exception ex = context.Exception; //錯誤所在的控制器方法名稱 var DisplayName = context.ActionDescriptor.DisplayName; #region 錯誤所在的行號行號 ////行號前的名稱有的是中文,有的是英文,注意甄別 //var aaa = ex.StackTrace.Substring(ex.StackTrace.IndexOf("行號"),ex.StackTrace.Length - ex.StackTrace.IndexOf("行號")); //var ccc = ex.StackTrace.Substring(ex.StackTrace.IndexOf("line"),ex.StackTrace.Length - ex.StackTrace.IndexOf("line")); var lineNumber = 0; const string lineSearch = ":line "; var index = ex.StackTrace.LastIndexOf(lineSearch); if (index != -1) { var lineNumberText = ex.StackTrace.Substring(index + lineSearch.Length); var lineNumberStr = lineNumberText.Substring(0,lineNumberText.IndexOf("\r\n")); if (int.TryParse(lineNumberStr,out lineNumber)) { } } #endregion #region 寫入資訊到【資料庫】,這裡自行入庫即可(mongodb、SqlServer、MySQL等),我以SqlServer為例 errorLog md = new errorLog(); md.logTime = DateTime.Now; md.logType = "error"; md.displayName = DisplayName; //錯誤位置 md.lineNumber = lineNumber; //錯誤行號 md.message = ex.Message; //錯誤資訊 http://www.cppcns.commd.messagedetails = ex.ToString(); //錯誤詳情 md.createTime= DateTime.Now; using (var ctx = new dbContext()) { ctx.Add(md); ctx.SaveChanges(); } #endregion //下面是你的返回頁面顯示的內容提示,以下省略 } } }
3、依賴注入全域性異常處理機制
在Startup.cs
裡面把我們剛剛建立的全域性異常處理機制注入到中介軟體來,放到ConfigureServices
方法裡面。
//新增全域性異常處理機制
services.AddMvc(option => {
option.Filters.Add<ExceptionFilter>();
});
// This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) { services.AddControllers(); //新增全域性異常處理機制 services.AddMvc(option => { option.Filters.Add<ExceptionFilter>(); }); }
4、測試全域性異常處理機制
“將string
字串轉換為int型別”,如下程式碼,肯定是報錯的,我們來捕捉一下錯誤資訊入庫。
var numberNo = "我是序列號";
//這裡是轉換為int型別,然後資料來源是string,肯定報錯,然後我們全域性捕捉
//注意,我們這裡沒有寫try catch
vareuExFX number = Convert.ToInt32(numberNo);
執行專案後我們查詢一下資料庫,發現捕捉到錯誤資訊了,包括
錯誤時間:2021-09-28 15:12:58.307
日誌型別:error
錯誤的方法位置:Log4NetWebAPI.Controllers.WeatherForecastController.Get (Log4NetWebAPI),
錯誤的行號:36行,
錯誤的資訊:Input string was not in a correct format.(輸入字串的格式不正確。)
下面是控制器方法截圖
到此這篇關於ASP.NET Core
中介軟體的使用之全域性異常處理機制的文章就介紹到這了,更多相關ASP.NET Core
全域性異常處理機制內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支http://www.cppcns.com持我們!