全域性異常處理

其實在 ASP.Net Core MVC 框架中已經有了全域性異常處理的機制，你可以在一箇中心化的地方使用 全域性異常處理中介軟體 來進行異常攔截，如果不用這種中心化方式的話，你就只能在 Controller 或者 Action 作用域上單獨處理，這會導致異常處理程式碼零散在專案各處，不好維護也特別麻煩，不是嗎？

第二種處理 全域性異常 的做法就是使用 exception filter，在本篇中，我準備跟大家聊一聊 全域性異常處理中介軟體 和 UseExceptionHandler 方法來管控異常。

使用 UseExceptionHandler 擴充套件方法

UseExceptionHandler 擴充套件方法能夠將 ExceptionHandler 中介軟體註冊到 Asp.net Core 的 請求處理管道 中，然後在 IExceptionHandlerFeature 介面的例項中獲取 異常物件，下面的程式碼片段展示瞭如何使用 UseExceptionHandler 方法來截獲全域性異常。

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)        {            app.UseExceptionHandler(builder =>             {                 builder.Run(async context =>                {                    context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;                    context.Response.ContentType = "application/json";                    var exception = context.Features.Get<IExceptionHandlerFeature>();                    if (exception != null)                    {                        var error = new ErrorMessage()                        {                            Stacktrace = exception.Error.StackTrace,                            Message = exception.Error.Message                        };                        var errObj = JsonConvert.SerializeObject(error);                        await context.Response.WriteAsync(errObj).ConfigureAwait(false);                    }                });             }         );            app.UseStaticFiles();            app.UseRouting();            app.UseAuthorization();            app.UseEndpoints(endpoints =>            {                endpoints.MapControllerRoute(                    name: "default",                    pattern: "{controller=Home}/{action=Index}/{id?}");            });        }

下面是程式碼中引用的 ErrorMessage 類的定義。

    public class ErrorMessage    {        public string Message { get; set; }        public string Stacktrace { get; set; }    }

配置 全域性異常中介軟體

大家都知道，ASP.Net Core MVC 專案中都會有一個 Startup.cs 檔案，可以在 Configure 方法下配置 全域性異常攔截中介軟體 程式碼，如下所示：

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)        {            if (env.IsDevelopment())            {                app.UseDeveloperExceptionPage();            }            else            {                app.UseExceptionHandler("/Error");            }            app.UseStaticFiles();            app.UseCookiePolicy();            app.UseMvc(routes =>            {                routes.MapRoute(                    name: "default",                    template:                    "{controller=Home}/{action=Index}/{id?}");            });        }

可以著重看一下上面的 app.UseExceptionHandler("/Error");，這裡的 UseExceptionHandler 實現了 pipeline 註冊，一旦應用程式出現了未處理異常，那麼會自動將 使用者 導向 /Error 頁面。

你可以用 UseStatusCodePagesWithReExecute 擴充套件方法給 pipeline 新增一些狀態碼頁面，這是什麼意思呢？ 其實也就是 http 500 導向 500 頁面， http 404 導向 404 頁面，下面的程式碼片段展示了修改後的 Configure 方法程式碼。

   public void Configure(IApplicationBuilder app, IHostingEnvironment env)   {            if (env.IsDevelopment())            {                app.UseDeveloperExceptionPage();            }            else            {                app.UseExceptionHandler("/Error");                app.UseStatusCodePagesWithReExecute("/Error/NotFound/{0}");            }            //Other code   }

使用 ErrorController

在 HomeController 下有一個專門處理錯誤的 action 方法，這裡我們不使用這個 action，你可以把它刪掉，接下來我準備定義一個專門的 ErrorController，裡面包含了一個路由為 /Error 的 action 方法。

    public class ErrorController : Controller    {        [HttpGet("/Error")]        public IActionResult Index()        {            IExceptionHandlerPathFeature iExceptionHandlerFeature = HttpContext.Features.Get<IExceptionHandlerPathFeature>();            if (iExceptionHandlerFeature != null)            {                string path = iExceptionHandlerFeature.Path;                Exception exception = iExceptionHandlerFeature.Error;                //Write code here to log the exception details                return View("Error",iExceptionHandlerFeature);            }                            return View();        }        [HttpGet("/Error/NotFound/{statusCode}")]        public IActionResult NotFound(int statusCode)        {            var iStatusCodeReExecuteFeature =HttpContext.Features.Get<IStatusCodeReExecuteFeature>();            return View("NotFound",iStatusCodeReExecuteFeature.OriginalPath);        }    }

你可以用 IExceptionHandlerPathFeature 來獲取異常相關資訊，也可以用 IStatusCodeReExecuteFeature 來獲取 http 404 異常時當時的請求路徑，對了，要想用上 IExceptionHandlerPathFeature 和 IStatusCodeReExecuteFeature,要記得在 nuget 上安裝了 Microsoft.AspNetCore.Diagnostics 包，下面的程式碼展示瞭如何獲取異常發生時刻的路由地址。

string route = iExceptionHandlerFeature.Path;

如果想獲取異常的詳細資訊，可以使用如下語句。

var exception = HttpContext.Features.Get<IExceptionHandlerPathFeature>();

一旦獲取了這個路由地址和異常的詳細資訊，就可以將它記錄到你的日誌檔案中，可供後續仔細分析。

使用 View 展示錯誤資訊

可以建立一個 View 來展示出現的錯誤資訊，下面時 Error ViewPage 的詳細程式碼。

@model Microsoft.AspNetCore.Diagnostics.IExceptionHandlerFeature@{    ViewData["Title"] = "Index";    Layout = "~/Views/Shared/_Layout.cshtml";}<div class="row">    <div class="text-danger">        <h3>Error: @Model.Error.Message</h3>    </div></div><div class="row">    <div class="col-12">        <p>@Model.Error.StackTrace</p>        <p>@Model.Error.InnerException</p>    </div></div>

下面是 NotFound 頁面的 程式碼

@model string@{    ViewData["Title"] = "NotFound";    Layout = "~/Views/Shared/_Layout.cshtml";}    <h1 class="text-danger">    Error: The requested URL @Model was not found!</h1><hr />

現在可以把程式跑起來了，你會看到如下的錯誤資訊。

如果你嘗試開啟一個不存在的頁面， 會自動跳轉到 ErrorController.NotFound 所包裝的 404 描述資訊。

ASP.NET Core 中內建了 全域性異常處理，你可以利用這項技術在一個集中化的地方去截獲你應用程式中的所有異常資訊，當然你也可以基於環境的不同採取不用的異常處理措施，比如說：開發環境，測試環境，生產環境 等等。