如何創建一個自定義的`ErrorHandlerMiddleware`方法

来源:https://www.cnblogs.com/yilezhu/archive/2020/03/15/12497937.html
-Advertisement-
Play Games

在本文中，我將講解如何通過自定義 ，以便在中間件管道中發生錯誤時創建自定義響應，而不是提供一個“重新執行”管道的路徑。 作者：依樂祝 譯文：https://www.cnblogs.com/yilezhu/p/12497937.html 原文：https://andrewlock.net/creati ...


在本文中，我將講解如何通過自定義ExceptionHandlerMiddleware，以便在中間件管道中發生錯誤時創建自定義響應，而不是提供一個“重新執行”管道的路徑。

作者：依樂祝
譯文：https://www.cnblogs.com/yilezhu/p/12497937.html
原文：https://andrewlock.net/creating-a-custom-error-handler-middleware-function/

Razor頁面中的異常處理

所有的.NET應用程式都有可能會產生錯誤，並且不幸地引發異常，因此在ASP.NET中間件管道中處理這些異常顯得非常重要。伺服器端呈現的應用程式（如Razor Pages）通常希望捕獲這些異常並重定向到一個錯誤頁面。

例如，如果您創建一個使用Razor Pages（dotnet new webapp）的新Web應用程式，您將在Startup.Configure中看到如下的中間件配置：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Error");
    }

    // .. other middleware not shown
}

在Development環境中運行時，應用程式將捕獲處理請求時引發的所有異常，並使用一個非常有用的DeveloperExceptionMiddleware方法將其以網頁的形式進行顯示：

開發人員例外頁面

這在本地開發期間非常有用，因為它使您可以快速檢查堆棧跟蹤，請求標頭，路由詳細信息以及其他內容。

當然，這些都是您不想在生產中公開的敏感信息。因此，當不在開發階段時，我們將使用其他異常處理程式ExceptionHandlerMiddleware。此中間件允許您提供一個請求路徑，預設情況下是"/Error"，並使用它“重新執行”中間件管道，以生成最終響應：

使用以下命令重新執行管道

Razor Pages應用程式的最終結果是，每當生產中發生異常時，就會返回這個Error.cshtml 的Razor 頁面：

生產中的例外頁面

這涵蓋了razor 頁面的異常處理，但是Web API呢？

Web API的異常處理

Web API模板（dotnet new webapi）中的預設異常處理類似於Razor Pages使用的異常處理，但有一個重要的區別：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    // .. other middleware not shown
}

如您所見DeveloperExceptionMiddleware，在Development環境中仍會添加，但是在生產中根本沒有添加錯誤處理！這沒有聽起來那麼糟糕：即使沒有異常處理中間件，ASP.NET Core也會在其底層架構中捕獲該異常，將其記錄下來，並向客戶端返回一個空白的500響應：

一個例外

如果您正在使用該[ApiController]屬性（你可能應該這樣使用），並且該錯誤來自您的Web API控制器，那麼ProblemDetails預設情況下會得到一個結果，或者您可以進一步對其進行自定義。

對於Web API客戶端來說，這實際上還不錯。您的API使用者應能夠處理錯誤響應，因此最終用戶將不會看到上面的“中斷”頁面。但是，它通常不是那麼簡單。

例如，也許您使用的是錯誤的標準格式，例如ProblemDetails格式。如果您的客戶期望所有錯誤都具有該格式，那麼在某些情況下生成的空響應很可能導致客戶端中斷。同樣，在Development環境中，當客戶端期望返回JSON時而你返回一個HTML開發人員異常頁面，這可能會導致問題！

官方文檔中描述了一種解決方案，建議您創建ErrorController並具有兩個終結點的：

[ApiController]
public class ErrorController : ControllerBase
{
    [Route("/error-local-development")]
    public IActionResult ErrorLocalDevelopment() => Problem(); // Add extra details here

    [Route("/error")]
    public IActionResult Error() => Problem();
}

然後使用Razor Pages應用程式中使用的相同“重新執行”功能來生成響應：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseExceptionHandler("/error-local-development");
    }
    else
    {
        app.UseExceptionHandler("/error");
    }

    // .. other middleware
}

這可以正常工作，但是對於使用生成異常的同一基礎結構（例如Razor Pages或MVC）來生成異常消息，總有一些困擾我。由於被第二次拋出異常，我多次被失敗的錯誤響應所困擾！因此，我喜歡採取稍微不同的方法。

使用ExceptionHandler代替ExceptionHandlingPath

當我第一次開始使用ASP.NET Core時，解決此問題的方法是編寫自己的自定義ExceptionHandler中間件來直接生成響應。“處理異常不是那麼難，對吧”？

事實證明，這要複雜得多（我知道，令人震驚）。您需要處理各種邊緣情況，例如：

  • 如果在發生異常時響應已經開始發送，則您將無法攔截它。
  • 如果在EndpointMiddleware發生異常時已執行，則需要對選定的端點進行一些處理
  • 您不想緩存錯誤響應

ExceptionHandlerMiddleware處理所有這些情況，所以重新寫你自己的版本不是一條要走的路。幸運的是，儘管通常顯示的方法是為中間件提供重新執行的路徑，但還有另一種選擇-直接提供處理函數。

在ExceptionHandlerMiddleware中有一個ExceptionHandlerOptions參數。該選項對象具有兩個屬性：

public class ExceptionHandlerOptions
{
    public PathString ExceptionHandlingPath { get; set; }
    public RequestDelegate ExceptionHandler { get; set; }
}

當你向UseExceptionHandler(path)方法提供重新執行的路徑時，實際上是在options對象上設置ExceptionHandlingPath。同樣的，如果需要的話，您可以設置ExceptionHandler屬性，並使用UseExceptionHandler()將ExceptionHandlerOptions的實例直接傳遞給中間件：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseExceptionHandler(new ExceptionHandlerOptions
    {
        ExceptionHandler = // .. to implement
    });

    // .. othe middleware
}

另外，您可以使用UseExceptionHandler()的另一個重載方法並配置一個迷你中間件管道來生成響應：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseExceptionHandler(err => err.UseCustomErrors(env)); // .. to implement

    // .. othe middleware
}

兩種方法都是等效的，因此更多是關於喜好的問題。在本文中，我將使用第二種方法並實現該UseCustomErrors()功能。

創建自定義異常處理函數

對於此示例，我將假設我們在中間件管道中遇到異常時需要生成一個ProblemDetails的對象。我還要假設我們的API僅支持JSON。這就避免了我們不必擔心XML內容協商等問題。在開發環境中，ProblemDetails響應將包含完整的異常堆棧跟蹤，而在生產環境中，它將僅顯示一般錯誤消息。

ProblemDetails是返回HTTP響應中錯誤的機器可讀詳細信息的行業標準方法。這是從ASP.NET Core 3.x（在某種程度上在2.2版中）的Web API返回錯誤消息的普遍支持的方法。

我們將從在靜態幫助器類中定義UseCustomErrors函數開始。該幫助類將一個生成響應的中間件添加到IApplicationBuilder方法擴展中。在開發環境中，它最終會調用WriteResponse方法，並且設置includeDetails: true。在其他環境中，includeDetails`設置為false。

using System;
using System.Diagnostics;
using System.Text.Json;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Hosting;

public static class CustomErrorHandlerHelper
{
    public static void UseCustomErrors(this IApplicationBuilder app, IHostEnvironment environment)
    {
        if (environment.IsDevelopment())
        {
            app.Use(WriteDevelopmentResponse);
        }
        else
        {
            app.Use(WriteProductionResponse);
        }
    }

    private static Task WriteDevelopmentResponse(HttpContext httpContext, Func<Task> next)
        => WriteResponse(httpContext, includeDetails: true);

    private static Task WriteProductionResponse(HttpContext httpContext, Func<Task> next)
        => WriteResponse(httpContext, includeDetails: false);

    private static async Task WriteResponse(HttpContext httpContext, bool includeDetails)
    {
        // .. to implement
    }
}

剩下的就是實現WriteResponse方法來生成我們的響應的功能。這將從ExceptionHandlerMiddleware（通過IExceptionHandlerFeature）中檢索異常，並構建一個包含要顯示的詳細信息的ProblemDetails對象。然後，它使用System.Text.Json序列化程式將對象寫入Response流。

private static async Task WriteResponse(HttpContext httpContext, bool includeDetails)
{
    // Try and retrieve the error from the ExceptionHandler middleware
    var exceptionDetails = httpContext.Features.Get<IExceptionHandlerFeature>();
    var ex = exceptionDetails?.Error;

    // Should always exist, but best to be safe!
    if (ex != null)
    {
        // ProblemDetails has it's own content type
        httpContext.Response.ContentType = "application/problem+json";

        // Get the details to display, depending on whether we want to expose the raw exception
        var title = includeDetails ? "An error occured: " + ex.Message : "An error occured";
        var details = includeDetails ? ex.ToString() : null;

        var problem = new ProblemDetails
        {
            Status = 500,
            Title = title,
            Detail = details
        };

        // This is often very handy information for tracing the specific request
        var traceId = Activity.Current?.Id ?? httpContext?.TraceIdentifier;
        if (traceId != null)
        {
            problem.Extensions["traceId"] = traceId;
        }

        //Serialize the problem details object to the Response as JSON (using System.Text.Json)
        var stream = httpContext.Response.Body;
        await JsonSerializer.SerializeAsync(stream, problem);
    }
}

您可以在序列化ProblemDetails之前記錄從HttpContext中檢索的自己喜歡的任何其他值。

請註意，在調用異常處理程式方法之前，ExceptionHandlerMiddleware會 清除路由值，以使這些值不可用。

如果您的應用程式現在在Development環境中引發異常，則您將在響應中獲取作為JSON返回的完整異常：

開發中的ProblemDetails響應

在生產環境中，您仍然會得到ProblemDetails響應，但是省略了詳細信息：

生產中的ProblemDetails響應

與MVC /重新執行路徑方法相比，此方法顯然具有一些局限性，即您不容易獲得模型綁定，內容協商，簡單的序列化或本地化（取決於您的方法）。

如果您需要其中任何一個（例如，也許您使用PascalCase而不是camelCase從MVC進行序列化），那麼使用此方法可能比其價值更麻煩。如果是這樣，那麼所描述的Controller方法可能是明智的選擇。

如果您不關心這些，那麼本文中顯示的簡單處理程式方法可能是更好的選擇。無論哪種方式，都不要嘗試實現自己的版本ExceptionHandlerMiddleware-使用可用的擴展點！

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 如何自行實現一個多租戶系統
    如何自行實現一個多租戶系統 註意：前情概要描述的文字比較多，說的是我的思考過程，不感興趣的可以直接到跳到 “解析租戶信息” 一節。 現如今框架滿天飛的環境下，好像很少機會需要自己來實現一個模塊。畢竟這樣能節省很多的開發時間，提高效率。 這就是框架的好處，也是我們使用框架的直接原因。 情況總有例外，假 ...
  • 為.net Core 3.0 WebApi 創建Linux守護進程
    前言 我們一般可以在Linux伺服器上執行 命令來運行我們的.net Core WebApi應用。但是這樣運行起來的應用很不穩定，關閉終端視窗之後，應用也會停止運行。為了讓其可以穩定運行，我們需要讓它變成系統的守護進程，成為一種服務一直在系統中運行，出現異常時也能重新啟動。 Linux系統有自己的守 ...
  • C#基礎篇——反射
    前言 在探究地球內部的結構中，如何做到在地球錶面不用深入地球內部就可以知道內部的構造呢？其實，向地球發射“地震波”。利用這種方式，可以判斷地球放回的情況，大體上，我們也可以斷定地球內部的構造了。 從這個例子中，通過一個對象的外部去瞭解對象內部的構造，都是利用了波的反射功能。而利用這種原理，在編程程式 ...
  • iNeuOS工業互聯平臺，開放設備驅動管理、服務驅動管理、雲組態自定義畫布等，促進平臺開放、賦能和落地。發佈：v2.3版本。
    目 錄 1. 概述... 2 2. iNeuOS平臺演示... 2 3. 設備驅動管理... 2 4. 服務驅動管理... 3 5. 雲組態自定義畫布... 4 6. 快速切換組態頁面菜單... 5 7. 自定義右鍵菜單項，顯示組態子頁面... 5 8. 工況關聯數據點... 6 9. 修改用戶密碼 ...
  • 記一次業餘項目的敏捷開發實踐
    本次是在原有ApiTemplate項目之上，增加一個用戶登錄許可權控制模塊，用於驗證ApiTemplate項目在面對一些簡單問題時，如何抽象並支持未來的擴展。用戶登錄許可權控制模塊看上去很簡單，但由於業餘時間總是有限的。所以藉助此機會實踐一次用戶敏捷開發。首先拆分模塊，本次只實現用戶登錄和登出。apit ...
  • 棄元
    棄元就是使用下劃線_作為一個占位符，但不占存儲空間。 元組（ValueTuple、Tuple）使用棄元例子。 using System; namespace ConsoleApp4 { class Program { public static void Main() { // ValueTuple ...
  • c# 委托的進化
    這篇文章是為了梳理自己關於委托的知識脈落，便於對委托有更清晰的認識。 本文的重點不在於，委托是什麼，怎麼定義委托，委托有什麼好處。。。這些網上知識很豐富了。 本文演示的是 委托是怎麼一步步形成並精簡代碼的 我稱之為“進化”。 這些方法也是從.net 1.0 2.0 3.0版本一步步形成的。 ...
  • C# .Net Core 3.1 中關於Process.Start 啟動Url鏈接的問題
    WPF 項目遷移到.Net Core中時居然出了一堆問題...(很無語) 今天在使用的時候居然發現Process.Start居然打不開Url鏈接了？ 報 找不到指定文件 的異常？！ 一、bug重現 首先以.Net Core 3.1框架 中一個Console項目 打開百度為例: 運行然後你就會得到: ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類