ASP.NET Core 中間件的使用之全局異常處理機制

更新時間：2021年09月29日 17:24:00 作者：熊澤-學(xué)習(xí)中的苦與樂

我們今天這篇文章就來說說代碼異常問題怎么快速定位，減少不必要的時間浪費。異常是一種運行時錯誤，當(dāng)異常沒有得到適當(dāng)?shù)奶幚?，很可能會?dǎo)致你的程序意外終止。下面雄安邊將詳細介紹,需要的朋友可以參考下

1、創(chuàng)建項目

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

2、創(chuàng)建全局異常過濾器

在控制器里面創(chuàng)建一個異常過濾器，命名為ExceptionFilter.cs，過濾器繼承IExceptionFilter接口。

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

異常過濾器，顧名思義，就是當(dāng)程序發(fā)生異常時所使用的過濾器。用于在系統(tǒng)出現(xiàn)未捕獲異常時的處理。

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

IExceptionFilter接口會要求實現(xiàn)OnException方法，當(dāng)系統(tǒng)發(fā)生未捕獲異常時就會觸發(fā)這個方法。

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

系統(tǒng)一旦出現(xiàn)未捕獲異常后，比較常見的做法就是使用日志工具，將異常的詳細信息記錄下來，方便修正調(diào)試。

下面是日志記錄的實現(xiàn)：

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 寫入信息到【數(shù)據(jù)庫】，這里自行入庫即可（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

            //下面是你的返回頁面顯示的內(nèi)容提示，以下省略

        }
    }
}

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

在Startup.cs里面把我們剛剛創(chuàng)建的全局異常處理機制注入到中間件來，放到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字符串轉(zhuǎn)換為int類型”，如下代碼，肯定是報錯的，我們來捕捉一下錯誤信息入庫。

var numberNo = "我是序列號";
//這里是轉(zhuǎn)換為int類型，然后數(shù)據(jù)源是string，肯定報錯，然后我們?nèi)植蹲?br /> //注意，我們這里沒有寫try catch
var number = Convert.ToInt32(numberNo);

運行項目后我們查詢一下數(shù)據(jù)庫，發(fā)現(xiàn)捕捉到錯誤信息了，包括

錯誤時間：2021-09-28 15:12:58.307

日志類型：error

錯誤的方法位置：Log4NetWebAPI.Controllers.WeatherForecastController.Get (Log4NetWebAPI)，

錯誤的行號：36行，

錯誤的信息：Input string was not in a correct format.（輸入字符串的格式不正確。）