ASP.NET Core中實現全局異常攔截的完整步驟

Posted on by

前言

異常是一種運行時錯誤，當異常沒有得到適當的處理，很可能會導致你的程序意外終止，這篇就來討論一下如何在 ASP.Net Core MVC 中實現全局異常處理，我會用一些 樣例代碼 和 截圖 來說明這些概念。

全局異常處理

其實在 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 中內置瞭 全局異常處理，你可以利用這項技術在一個集中化的地方去截獲你應用程序中的所有異常信息，當然你也可以基於環境的不同采取不用的異常處理措施，比如說：開發環境，測試環境，生產環境 等等。

譯文鏈接： https://www.infoworld.com/art…

更多高質量幹貨：參見我的 GitHub:dotnetfly

到此這篇關於ASP.NET Core中實現全局異常攔截的文章就介紹到這瞭,更多相關ASP.NET Core全局異常攔截內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：