dotNet8 全局異常處理

来源:https://www.cnblogs.com/ruipeng/p/18075123
-Advertisement-
Play Games

前言 異常的處理在我們應用程式中是至關重要的，在 dotNet 中有很多異常處理的機制，比如MVC的異常篩選器, 管道中間件定義try catch捕獲異常處理亦或者第三方的解決方案Hellang.Middleware.ProblemDetails等。MVC異常篩選器不太靈活，對管道的部分異常捕獲不到 ...


前言

異常的處理在我們應用程式中是至關重要的，在 dotNet 中有很多異常處理的機制，比如MVC的異常篩選器, 管道中間件定義try catch捕獲異常處理亦或者第三方的解決方案Hellang.Middleware.ProblemDetails等。MVC異常篩選器不太靈活，對管道的部分異常捕獲不到，後兩種方式大家項目應該經常出現。

在 dotNet8 發佈之後支持了新的異常處理機制 IExceptionHandler或者UseExceptionHandler異常處理程式的lambda配置，配合dotNet7原生支持的ProblemDetail使得異常處理更加規範。

本文用一個簡單的 Demo 帶大家看一下新的異常處理方式

文末有示例完整的源代碼

先起一個 WebApi 的新項目

Problem Details

Problem Details 是一種在 HTTP API 中用於描述錯誤信息的標準化格式。根據 RFC 7807，Problem Details 提供了一種統一、可機器讀取的方式來呈現出發生在 API 請求中的問題。它包括各種屬性，如 title、status、detail、type 等，用於清晰地描述錯誤的性質和原因。通過使用 Problem Details，開發人員可以為 API 的錯誤響應提供一致性和易於理解的結構化格式，從而幫助客戶端更好地處理和解決問題。

項目中使用 Problem Details

builder.Services.AddProblemDetails();

如果我們不對異常進行捕獲處理，Asp.Net Core 提供了兩種不同的內置集中式機制來處理未經處理的異常

  • app.UseDeveloperExceptionPage();

    開發人員異常中間件

    開發人員異常中間件會顯示伺服器錯誤的詳細堆棧跟蹤，不建議在非開發環境顯示，暴漏核心錯誤信息給客戶端，有嚴重的安全風險

  • app.UseExceptionHandler(); 異常處理程式中間件，
    使用異常處理程式中間件生成的是標準的簡化回覆

測試 UseDeveloperExceptionPage

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
builder.Services.AddProblemDetails();
var app = builder.Build();
app.MapGet("/TestUseDeveloperExceptionPage",
    () => { throw new Exception("測試UseDeveloperExceptionPage"); });
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
    app.UseDeveloperExceptionPage();// 開發人員異常頁
}
app.UseStatusCodePages();
app.UseHttpsRedirection();
app.Run();

調用 TestUseDeveloperExceptionPage 介面
回參

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
  "title": "System.Exception",
  "status": 500,
  "detail": "測試UseDeveloperExceptionPage",
  "exception": {
    "details": "System.Exception: 測試UseDeveloperExceptionPage\r\n   at Program.<>c.<<Main>$>b__0_0() in C:\\dotNetParadise\\dot-net-paradise-exception\\dotNetParadise-Exception\\dotNetParadise-Exception\\Program.cs:line 7\r\n   at lambda_method3(Closure, Object, HttpContext)\r\n   at Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionMiddleware.Invoke(HttpContext context)\r\n   at Microsoft.AspNetCore.Diagnostics.StatusCodePagesMiddleware.Invoke(HttpContext context)\r\n   at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddlewareImpl.Invoke(HttpContext context)",
    "headers": {
      "Accept": [
        "*/*"
      ],
      "Host": [
        "localhost:7130"
      ],
      "User-Agent": [
        "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36 Edg/122.0.0.0"
      ],
      "Accept-Encoding": [
        "gzip, deflate, br"
      ],
      "Accept-Language": [
        "en-US,en;q=0.9"
      ],
      "Cookie": [
        "ajs_anonymous_id=b96604ea-c096-4693-acfb-b3a9e8403f0e; Quasar_admin_Vue3_username=admin; Quasar_admin_Vue3_token=b1aa15b6-02bb-44b9-8668-0157a1d9b6f0; Quasar_admin_Vue3_lang=en-US"
      ],
      "Referer": [
        "https://localhost:7130/swagger/index.html"
      ],
      "sec-ch-ua": [
        "\"Chromium\";v=\"122\", \"Not(A:Brand\";v=\"24\", \"Microsoft Edge\";v=\"122\""
      ],
      "sec-ch-ua-mobile": [
        "?0"
      ],
      "sec-ch-ua-platform": [
        "\"Windows\""
      ],
      "sec-fetch-site": [
        "same-origin"
      ],
      "sec-fetch-mode": [
        "cors"
      ],
      "sec-fetch-dest": [
        "empty"
      ]
    },
    "path": "/TestUseDeveloperExceptionPage",
    "endpoint": "HTTP: GET /TestUseDeveloperExceptionPage",
    "routeValues": {}
  }

可以看到所有的信息都拋出來給到了客戶端，適合在開發環境用，非開發環境尤其是生產環境不要啟用。

app.UseExceptionHandler();

異常處理程式中間件

// app.UseDeveloperExceptionPage();// 開發人員異常頁
app.UseExceptionHandler();//異常處理中間件

測試一下

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
  "title": "An error occurred while processing your request.",
  "status": 500
}

可以看到只保留了最基本的報錯信息，這樣第一步我們已經完成了。

自定義異常 和 IExceptionHandler

創建一個自定義異常信息

public class CustomException(int code, string message) : Exception(message)
{
    public int Code { get; private set; } = code;

    public string Message { get; private set; } = message;
}

集成IExceptionHandler創建自定義異常處理器

public class CustomExceptionHandler(ILogger<CustomException> logger, IWebHostEnvironment environment) : IExceptionHandler
{
    public async ValueTask<bool> TryHandleAsync(HttpContext httpContext, Exception exception, CancellationToken cancellationToken)
    {
        if (exception is not CustomException customException) return false;
        logger.LogError(
              exception, "Exception occurred: {Message} {StackTrace} {Source}", exception.Message, exception.StackTrace, exception.Source);

        var problemDetails = new ProblemDetails
        {
            Status = customException.Code,
            Title = customException.Message,
        };
        if (environment.IsDevelopment())
        {
            problemDetails.Detail = $"Exception occurred: {customException.Message} {customException.StackTrace} {customException.Source}";
        }
        httpContext.Response.StatusCode = problemDetails.Status.Value;
        await httpContext.Response
            .WriteAsJsonAsync(problemDetails, cancellationToken);
        return true;
    }
}

可以註冊多個自定義異常處理器分別處理不同類型的異常，按預設的註冊順序來處理，如果返回true則會處理此異常返回false會跳到下一個ExceptionHandler,沒處理的異常在 UseExceptionHandler 中間件做最後處理。

創建第二個ExceptionHandler 處理系統異常

public class SystemExceptionHandle(ILogger<CustomException> logger, IWebHostEnvironment environment) : IExceptionHandler
{
    public async ValueTask<bool> TryHandleAsync(HttpContext httpContext, Exception exception, CancellationToken cancellationToken)
    {
        if (exception is CustomException) return false;
        logger.LogError(
              exception, "Exception occurred: {Message} {StackTrace} {Source}", exception.Message, exception.StackTrace, exception.Source);

        var problemDetails = new ProblemDetails
        {
            Status = StatusCodes.Status500InternalServerError,
            Title = "An error occurred while processing your request",
        };
        if (environment.IsDevelopment())
        {
            problemDetails.Detail = $"Exception occurred: {exception.Message} {exception.StackTrace} {exception.Source}";
        }

        httpContext.Response.StatusCode = problemDetails.Status.Value;

        await httpContext.Response
            .WriteAsJsonAsync(problemDetails, cancellationToken);

        return true;

    }
}

IOC 容器註冊ExceptionHandler

builder.Services.AddExceptionHandler<CustomExceptionHandler>();
builder.Services.AddExceptionHandler<SystemExceptionHandle>();

新加介面測試一下

app.MapGet("/CustomThrow", () =>
{
    throw new CustomException(StatusCodes.Status403Forbidden, "你沒有許可權！");
}).WithOpenApi();

回參

{
  "title": "你沒有許可權！",
  "status": 403,
  "detail": "Exception occurred: 你沒有許可權！    at Program.<>c.<<Main>$>b__0_1() in C:\\dotNetParadise\\dot-net-paradise-exception\\dotNetParadise-Exception\\dotNetParadise-Exception\\Program.cs:line 15\r\n   at lambda_method5(Closure, Object, HttpContext)\r\n   at Microsoft.AspNetCore.HttpsPolicy.HttpsRedirectionMiddleware.Invoke(HttpContext context)\r\n   at Microsoft.AspNetCore.Diagnostics.StatusCodePagesMiddleware.Invoke(HttpContext context)\r\n   at Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddlewareImpl.<Invoke>g__Awaited|10_0(ExceptionHandlerMiddlewareImpl middleware, HttpContext context, Task task) dotNetParadise-Exception"
}

可以看出全局異常捕獲生效了。

最後

本文講的是 dotNet8 新的異常處理方式，當時也可以用UseExceptionHandler的lambda方式可以創建，但是不如這種強類型約束的規範，大家在升級 dotNet8 時可以參考本文來修改項目現有的全部異常捕獲方式。

Demo 源代碼

dotNet 官網教程

本文來自博客園，作者：董瑞鵬，轉載請註明原文鏈接：https://www.cnblogs.com/ruipeng/p/18075123


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

-Advertisement-
Play Games
更多相關文章
  • aardio教程一) 基礎語法-上
    前言 想開發一些小工具，所以想系統性的學習一遍aardio，之前都是哪裡不會搜哪裡，順便寫些教程。我的主要語言是Python，所以會以Python作為對比來加深印象。 aardio的基礎語法和JavaScript基本類似，如果你學過JavaScript，aardio很容易上手。下麵的文檔來自官方文檔 ...
  • .Net Core 你必須知道的source-generators
    源生成器是 C# 9 中引入的一項功能，允許在編譯過程中動態生成代碼。 它們直接與 C# 編譯器集成(Roslyn)併在編譯時運行，分析源代碼並根據分析結果生成附加代碼。 源生成器提供了一種簡化的自動化代碼生成方法，無需外部工具或單獨的預編譯步驟。 通過無縫集成到編譯過程中，源生成器可以提高生產力、 ...
  • 內網穿透，遠程網盤，網站外掛資源，可嵌入到頁面的網盤資源解決方案
    這是一個我個人寫的庫，主要實現的是基於tcpclient的網站外擴網盤的解決方案，可以使用家用網路外掛個人電腦中的資源到自己的網站上，已經上傳nuget，大家可以直接在nuget包管理中搜索到，直接搜索ZmjNetDisk即可，下麵介紹具體的使用方式： 另外一提這個庫做的比較的個人化，因為他就是為了 ...
  • WPF線程模型
    1. 渲染系統概述 WPF 採用保留模式渲染系統 (Retained Mode Rendering System)，該系統可分為 UI 線程和複合線程兩個主要部分，兩者協作完成 WPF 應用程式的渲染工作。 1.1 立即模式GUI和保持模式GUI 圖形 API 可分為保留模式API 和即時模式API ...
  • C#實時監測文件夾變化
    在開發各種應用程式時，我們經常需要對文件系統中的文件或文件夾進行實時監測，以便在文件內容改變、文件被創建或刪除時能夠及時做出反應。在 C# 中，System.IO.FileSystemWatcher 類為我們提供了這樣一個強大的功能。 一、引入 FileSystemWatcher 類 首先，在項目中 ...
  • 輕量級.net standard微信支付登錄Nuget開源庫
    我個人編寫的庫，在我個人網站，小程式等很多地方都在使用中，大家可以搜索小程式 什邡市宅貓君網路工作室 或者到我的網站 store.zhaimaojun.cn 去體驗支付和登錄效果。 本庫主要實現了native pay（二維碼支付）jsapi pay（小程式直接調起支付），需要註意的是這是基於api3 ...
  • 超輕量級的c#版基於文件的日誌記錄工具，可定製輸出格式，可指定日誌文件
    這是我自己個人編寫的日誌記錄，主要使用在只需要記錄日誌，偶爾到文件中查看一下日誌記錄的情況。我自己寫的一些服務之類的是使用了這個的，代碼很少，使用很簡單。 第一步 搜索和安裝我的Nuget包 搜索和安裝zmjtool這個包，我寫的，如下圖： 第二步 引入namespace和創建logger對象 1 ...
  • 告別繁瑣！1分鐘帶你構建RabbitMQ消息應用
    支持.Net/.Net Core/.Net Framework，可以部署在Docker, Windows, Linux, Mac。 RabbitMQ作為一款主流的消息隊列工具早已廣受歡迎。相比於其它的MQ工具，RabbitMQ支持的語言更多、功能更完善。 1.發送消息、獲取消息、使用消息 本文提供一 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類