ASP.NET Core 中間件的使用（三）：全局異常處理機制

前言

我們經常聽到「秒修復秒上線」，覺得很厲害的樣子。

其實不然，這只是一個調侃而已，出現問題的方式很多（邏輯漏洞、代碼異常、操作方式不正確等）。

我們今天來說代碼異常問題怎麼快速定位，減少不必要的時間浪費。

這就是今天的主題「添加全局異常處理機制」捕捉異常存儲到數據庫（mongodb、SqlServer、MySQL等）。

PS：輸出txt的話不怎麼友好，不是所有人都能登錄服務器的。

異常是一種運行時錯誤，當異常沒有得到適當的處理，很可能會導致你的程序意外終止。

創建項目

我們創建一個ASP.NET Core Web API項目，選擇.NET Core3.1。

 

創建全局異常過濾器

在控制器裏面創建一個異常過濾器，命名為ExceptionFilter.cs，過濾器繼承IExceptionFilter接口。

注意，我這裡入庫用的是efcore+sqlserver，大家可以根據自己實際情況使用ORM和數據庫方式。

 

異常過濾器，顧名思義，就是當程序發生異常時所使用的過濾器。用於在系統出現未捕獲異常時的處理。

實現一個自定義異常過濾器，自定義一個全局異常過濾器需要實現IExceptionFilter接口。

 

IExceptionFilter接口會要求實現OnException方法，當系統發生未捕獲異常時就會觸發這個方法。

OnException方法有一個ExceptionContext異常上下文，其中包含了具體的異常信息，HttpContext及mvc路由信息。

系統一旦出現未捕獲異常後，比較常見的做法就是使用日誌工具，將異常的詳細信息記錄下來，方便修正調試。

下面是日誌記錄的實現。

using Microsoft.AspNetCore.Mvc.Filters;
using 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;    //錯誤信息
            md.messagedetails = ex.ToString();  //錯誤詳情
            md.createTime= DateTime.Now;

            using (var ctx = new dbContext())
            {

                ctx.Add(md);
                ctx.SaveChanges();
            }
            #endregion

            //下面是你的返回頁面顯示的內容提示，以下省略

        }
    }
}

依賴注入全局異常處理機制

在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>();
            });
        }

測試全局異常處理機制

「將string字符串轉換為int類型」，如下代碼，肯定是報錯的，我們來捕捉一下錯誤信息入庫。

var numberNo = “我是序列號”;
//這裡是轉換為int類型，然後數據源是string，肯定報錯，然後我們全局捕捉
//注意，我們這裡沒有寫try catch
var 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.（輸入字符串的格式不正確。）

下面是控制器方法截圖

推薦資料

參考文獻

 

 
歡迎關注訂閱微信公眾號【熊澤有話說】，更多好玩易學知識等你來取

作者：熊澤-學習中的苦與樂
公眾號：熊澤有話說


出處： //www.cnblogs.com/xiongze520/p/15348130.html


您可以隨意轉載、摘錄，但請在文章內註明作者和原文鏈接。
  

 

 

 

Tags:

VirMach 便宜 VPS

QNews

QNews