天天看點

ASP.NET Core 中間件的使用(三):全局異常處理機制(Filter攔截器對比)

前言

隻是Filter攔截器的對比,還不是中間件,注意甄别

我們經常聽到“秒修複秒上線”,覺得很厲害的樣子。

其實不然,這隻是一個調侃而已,出現問題的方式很多(邏輯漏洞、代碼異常、操作方式不正确等)。

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

這就是今天的主題“添加全局異常處理機制”捕捉異常存儲到資料庫(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路由資訊。

系統一旦出現未捕獲異常後,比較常見的做法就是使用日志工具,将異常的詳細資訊記錄下來,友善修正調試。

下面是日志記錄的實作。

ASP.NET Core 中間件的使用(三):全局異常處理機制(Filter攔截器對比)
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

            //下面是你的傳回頁面顯示的内容提示,以下省略

        }
    }
}      
ASP.NET Core 中間件的使用(三):全局異常處理機制(Filter攔截器對比)

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

在Startup.cs裡面把我們剛剛建立的全局異常處理機制注入,放到ConfigureServices方法裡面。

//添加全局異常處理機制

services.AddMvc(option => {

  option.Filters.Add<ExceptionFilter>();

});

ASP.NET Core 中間件的使用(三):全局異常處理機制(Filter攔截器對比)
// 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>();
            });
        }
                  
ASP.NET Core 中間件的使用(三):全局異常處理機制(Filter攔截器對比)

測試全局異常處理機制

“将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.(輸入字元串的格式不正确。)

下面是控制器方法截圖

推薦資料

  • ASP .Net Core 中間件的使用(一):搭建靜态檔案伺服器/通路指定檔案:https://www.cnblogs.com/xiongze520/p/14143581.html
  • ASP.NET Core 中間件的使用(二):依賴注入的使用:https://www.cnblogs.com/xiongze520/p/14155858.html

參考文獻

  • 處理 ASP.NET Core 中的錯誤:https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/error-handling?view=aspnetcore-5.0