處理 ASP.NET Core 中的錯誤

作者：Tom Dykstra

本文說明處理 ASP.NET Core Web 應用程式錯誤的常見方法。 另請參閱處理 ASP.NET Core 控制器型 Web API 中的錯誤和處理最少 API 中的錯誤。

開發人員例外頁面

「開發人員例外狀況頁面」會顯示未處理要求例外狀況的詳細資訊。 當符合以下兩項條件時，ASP.NET Core 應用程式預設會啟用開發人員例外狀況頁面：

• 在開發環境中執行。
• 使用目前範本建立的應用程式，也就是使用 WebApplication.CreateBuilder。 使用WebHost.CreateDefaultBuilder 建立的應用程式必須透過呼叫 Configure 中的 app.UseDeveloperExceptionPage 來啟用開發人員例外狀況頁面。

開發人員例外狀況頁面會在中介軟體管線的早期執行，以便它可以攔截在後續中介軟體中擲回的未處理的例外狀況。

當應用程式在生產環境中執行時，不應該公開顯示詳細的例外狀況資訊。 如需設定環境的詳細資訊，請參閱在 ASP.NET Core 中使用多個環境。

「開發人員例外狀況頁面」可能包含下列有關例外狀況和要求的資訊：

• 堆疊追蹤
• 查詢字串參數 (如果有的話)
• Cookie (如果有的話)
• 標頭

不保證「開發人員例外狀況頁面」提供任何資訊。 請使用記錄來取得完整的錯誤資訊。

例外處理常式頁面

若要針對生產環境設定自訂錯誤處理頁面，請呼叫 UseExceptionHandler。 此例外狀況處理中介軟體會：

• 攔截並記錄未處理的例外狀況。
• 使用指示的路徑在替代管線中重新執行要求。 如果回應已啟動，就不會重新執行要求。 範本產生的程式碼會使用 /Error 路徑重新執行要求。

警告

如果替代管線擲回自己的例外狀況，則「例外狀況處理中介軟體」會重新擲回原始的例外狀況。

因為此中介軟體可以重新執行要求管線，所以：

• 中介軟體必須處理同一個要求的可重新進入性。 這通常意味著不是在呼叫 _next 之後清除它們的狀態，就是在 HttpContext 上快取它們的處理結果以避免重做。 在處理要求本文時，這意味著會像表單讀取器一樣緩衝或快取結果。
• 對於在範本中使用的 UseExceptionHandler(IApplicationBuilder, String) 多載，只會修改要求路徑，並清除路由資料。 要求資料 (例如標頭、方法和項目) 都會按原樣重複使用。
• 限定範圍的服務維持不變。

在下列範例中，UseExceptionHandler 會在非開發環境中加入例外狀況處理中介軟體：

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

Razor Pages 應用程式範本會在 Pages 資料夾中提供一個錯誤頁面 (.cshtml) 與 PageModel 類別 (ErrorModel)。 對於 MVC 應用程式，專案範本會包含 Home 控制器的一個 Error 動作方法和一個 Error 檢視。

例外狀況處理中介軟體會使用原始 HTTP 方法重新執行要求。 如果錯誤處理常式端點僅限於一組特定的 HTTP 方法，它只會針對這些 HTTP 方法執行。 例如，使用 [HttpGet] 屬性的 MVC 控制器動作只會針對 GET 要求執行。 為了確保所有 要求都會到達自訂錯誤處理頁面，請勿將它們限制為一組特定的 HTTP 方法。

若要根據原始 HTTP 方法進行不同的例外狀況處理：

• 針對 Razor Pages，建立多個處理常式方法。 例如，使用 OnGet 來處理 GET 例外狀況，並使用 OnPost 來處理 POST 例外狀況。
• 針對 MVC，將 HTTP 動詞屬性套用至多個動作。 例如，使用 [HttpGet] 來處理 GET 例外狀況，並使用 [HttpPost] 來處理 POST 例外狀況。

若要允許未經驗證的使用者檢視自訂錯誤處理頁面，請確定它支援匿名存取。

存取例外狀況

使用 IExceptionHandlerPathFeature 來存取錯誤處理常式中的例外狀況和原始要求路徑。 下列範例使用 IExceptionHandlerPathFeature 來取得擲回之例外狀況的詳細資訊：

[ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
[IgnoreAntiforgeryToken]
public class ErrorModel : PageModel
{
    public string? RequestId { get; set; }

    public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);

    public string? ExceptionMessage { get; set; }

    public void OnGet()
    {
        RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier;

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

        if (exceptionHandlerPathFeature?.Error is FileNotFoundException)
        {
            ExceptionMessage = "The file was not found.";
        }

        if (exceptionHandlerPathFeature?.Path == "/")
        {
            ExceptionMessage ??= string.Empty;
            ExceptionMessage += " Page: Home.";
        }
    }
}

警告

請勿提供敏感性的錯誤資訊給用戶端。 提供錯誤有安全性風險。

例外處理常式 Lambda

自訂例外處理常式頁面的替代方法，便是將 Lambda 提供給 UseExceptionHandler。 使用 lambda 可讓您在傳回回應之前存取錯誤。

下列程式碼使用 Lambda 來進行例外狀況處理：

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler(exceptionHandlerApp =>
    {
        exceptionHandlerApp.Run(async context =>
        {
            context.Response.StatusCode = StatusCodes.Status500InternalServerError;

            // using static System.Net.Mime.MediaTypeNames;
            context.Response.ContentType = Text.Plain;

            await context.Response.WriteAsync("An exception was thrown.");

            var exceptionHandlerPathFeature =
                context.Features.Get<IExceptionHandlerPathFeature>();

            if (exceptionHandlerPathFeature?.Error is FileNotFoundException)
            {
                await context.Response.WriteAsync(" The file was not found.");
            }

            if (exceptionHandlerPathFeature?.Path == "/")
            {
                await context.Response.WriteAsync(" Page: Home.");
            }
        });
    });

    app.UseHsts();
}

警告

請勿提供敏感性的錯誤資訊給用戶端。 提供錯誤有安全性風險。

IExceptionHandler

IExceptionHandler 是一個介面，可讓開發人員回撥以處理中央位置的已知例外狀況。

IExceptionHandler 實作會呼叫 IServiceCollection.AddExceptionHandler<T> 來進行註冊。 IExceptionHandler 實例的存留期是單一實例。 您可以新增多個實作，並以已註冊的順序呼叫這些實作。

如果例外處理常式處理要求，其可能會傳回 true 以停止處理。 如果任何例外處理常式未處理例外狀況，則控制項會回復為中介軟體的預設行為和選項。 系統會針對已處理與未處理的例外狀況發出不同的計量與記錄。

下列範例顯示 IExceptionHandler 的實作：

using Microsoft.AspNetCore.Diagnostics;

namespace ErrorHandlingSample
{
    public class CustomExceptionHandler : IExceptionHandler
    {
        private readonly ILogger<CustomExceptionHandler> logger;
        public CustomExceptionHandler(ILogger<CustomExceptionHandler> logger)
        {
            this.logger = logger;
        }
        public ValueTask<bool> TryHandleAsync(
            HttpContext httpContext,
            Exception exception,
            CancellationToken cancellationToken)
        {
            var exceptionMessage = exception.Message;
            logger.LogError(
                "Error Message: {exceptionMessage}, Time of occurrence {time}",
                exceptionMessage, DateTime.UtcNow);
            // Return false to continue with the default behavior
            // - or - return true to signal that this exception is handled
            return ValueTask.FromResult(false);
        }
    }
}

下列範例示範如何註冊 IExceptionHandler 實作以進行相依性插入：

using ErrorHandlingSample;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddDatabaseDeveloperPageExceptionFilter();
builder.Services.AddRazorPages();
builder.Services.AddExceptionHandler<CustomExceptionHandler>();

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

// Remaining Program.cs code omitted for brevity

當上面的程式碼在開發環境中執行時：

• 會先呼叫 CustomExceptionHandler 來處理例外狀況。
• 在記錄例外狀況之後，TryHandleException 方法會傳回 false，因此會顯示開發人員例外狀況頁面。

在其他環境中：

• 會先呼叫 CustomExceptionHandler 來處理例外狀況。
• 在記錄例外狀況之後，TryHandleException 方法會傳回 false，因此會顯示 /Error 頁面。

UseStatusCodePages

根據預設，ASP.NET Core 應用程式不會提供 HTTP 錯誤狀態碼 (例如「404 - 找不到」) 的狀態碼頁面。 當應用程式設定沒有本文的 HTTP 400-599 錯誤狀態碼時，它會傳回該狀態碼和一個空白的回應本文。 若要針對常見的錯誤狀態碼啟用預設的純文字處理常式，請在 Program.cs 中呼叫 UseStatusCodePages：

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseStatusCodePages();

在要求處理中介軟體之前呼叫 UseStatusCodePages。 例如，在靜態檔案中介軟體和端點中介軟體之前呼叫 UseStatusCodePages。

若未使用 UseStatusCodePages，則導覽至沒有端點的 URL 會傳回與瀏覽器相依的錯誤訊息，指示無法找到端點。 當呼叫 UseStatusCodePages 時，瀏覽器會傳回下列回應：

Status Code: 404; Not Found

UseStatusCodePages 通常不會用於生產環境，因為它會傳回對使用者無用的訊息。

注意

狀態碼頁面中介軟體不會攔截例外狀況。 若要提供自訂錯誤處理頁面，請使用例外狀況處理常式頁面。

具格式字串的 UseStatusCodePages

若要自訂回應內容類型和文字，請使用 UseStatusCodePages 的多載，其會採用內容類型和格式字串：

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

// using static System.Net.Mime.MediaTypeNames;
app.UseStatusCodePages(Text.Plain, "Status Code Page: {0}");

在上面的程式碼中，{0} 是錯誤碼的預留位置。

含格式化字串的 UseStatusCodePages 通常不會用於生產環境，因為它會傳回對使用者無用的訊息。

具 Lambda 的 UseStatusCodePages

若要指定自訂錯誤處理和回應撰寫程式碼，請使用 UseStatusCodePages 的多載，其會採用 Lambda 運算式：

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseStatusCodePages(async statusCodeContext =>
{
    // using static System.Net.Mime.MediaTypeNames;
    statusCodeContext.HttpContext.Response.ContentType = Text.Plain;

    await statusCodeContext.HttpContext.Response.WriteAsync(
        $"Status Code Page: {statusCodeContext.HttpContext.Response.StatusCode}");
});

含 Lambda 的 UseStatusCodePages 通常不會用於生產環境，因為它會傳回對使用者無用的訊息。

UseStatusCodePagesWithRedirects

UseStatusCodePagesWithRedirects 擴充方法：

• 傳送「302 - 已找到」狀態碼傳送給用戶端。
• 將用戶端重新導向至 URL 範本中所提供的錯誤處理端點。 錯誤處理端點通常會顯示錯誤資訊，並傳回 HTTP 200。

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseStatusCodePagesWithRedirects("/StatusCode/{0}");

URL 範本可為狀態碼包含一個 {0} 預留位置，如上面的程式碼中所示。 如果 URL 範本是以 ~ (波狀符號) 為開頭，該 ~ 會被應用程式的 PathBase 取代。 若在應用程式中指定端點時，請為該端點建立一個 MVC 檢視或 Razor 頁面。

此方法通常是在下列應用程式相關情況下使用：

• 應用程式應將用戶端重新導向至不同的端點時 (通常是在由其他應用程式處理錯誤的情況下)。 針對 Web 應用程式，用戶端的瀏覽器網址列會反映重新導向後的端點。
• 應用程式不應該保留並傳回原始狀態碼與初始重新導向回應時。

UseStatusCodePagesWithReExecute

UseStatusCodePagesWithReExecute 擴充方法：

• 可透過使用替代路徑重新執行要求管線來產生回應本文。
• 不會在重新執行管線之前或之後改變狀態碼。

新的管線執行可能會改變回應的狀態碼，因為新的管線對狀態碼具有完全的控制權。 如果新的管線未改變狀態碼，則會將原始狀態碼傳送到用戶端。

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseStatusCodePagesWithReExecute("/StatusCode/{0}");

如果在應用程式內指定端點，請為該端點建立一個 MVC 檢視或 Razor 頁面。

此方法通常是在下列應用程式相關情況下使用：

• 在不重新導向至其他端點的情況下處理要求。 針對 Web 應用程式，用戶端的瀏覽器網址列會反映原始要求的端點。
• 保留並傳回原始狀態碼與回應時。

URL 範本必須以 / 開頭，而且可為狀態碼包含一個預留位置 {0}。 若要將狀態碼作為查詢字串參數來傳遞，請將第二個引數傳入 UseStatusCodePagesWithReExecute。 例如：

var app = builder.Build();  
app.UseStatusCodePagesWithReExecute("/StatusCode", "?statusCode={0}");

處理錯誤的端點可以取得產生該錯誤的原始 URL，如下列範例所示：

[ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
public class StatusCodeModel : PageModel
{
    public int OriginalStatusCode { get; set; }

    public string? OriginalPathAndQuery { get; set; }

    public void OnGet(int statusCode)
    {
        OriginalStatusCode = statusCode;

        var statusCodeReExecuteFeature =
            HttpContext.Features.Get<IStatusCodeReExecuteFeature>();

        if (statusCodeReExecuteFeature is not null)
        {
            OriginalPathAndQuery = $"{statusCodeReExecuteFeature.OriginalPathBase}"
                                    + $"{statusCodeReExecuteFeature.OriginalPath}"
                                    + $"{statusCodeReExecuteFeature.OriginalQueryString}";

        }
    }
}

因為此中介軟體可以重新執行要求管線，所以：

• 中介軟體必須處理同一個要求的可重新進入性。 這通常意味著不是在呼叫 _next 之後清除它們的狀態，就是在 HttpContext 上快取它們的處理結果以避免重做。 在處理要求本文時，這意味著會像表單讀取器一樣緩衝或快取結果。
• 限定範圍的服務維持不變。

停用狀態碼頁面

若要停用 MVC 控制器或動作方法的狀態碼頁面，請使用 [SkipStatusCodePages] 屬性。

若要停用 Razor 頁面處理常式方法或 MVC 控制器中的特定要求狀態碼頁面，請使用 IStatusCodePagesFeature：

public void OnGet()
{
    var statusCodePagesFeature =
        HttpContext.Features.Get<IStatusCodePagesFeature>();

    if (statusCodePagesFeature is not null)
    {
        statusCodePagesFeature.Enabled = false;
    }
}

例外狀況處理程式碼

例外狀況處理頁面中的程式碼也可能會擲回例外狀況。 生產錯誤頁面應該進行徹底的測試，並特別小心以避免擲回自己的例外狀況。

回應標頭

一旦傳送回應的標頭之後：

• 應用程式就無法變更回應的狀態碼。
• 無法執行任何例外狀況頁面或處理常式。 回應必須完成，否則會中止連線。

伺服器例外狀況處理

除了應用程式中的例外狀況處理邏輯之外，HTTP 伺服器實作也可以處理一些例外狀況。 如果伺服器在回應標頭傳送之前攔截到例外狀況，則伺服器會傳送一個沒有回應本文的 500 - Internal Server Error 回應。 如果伺服器在回應標頭傳送之後攔截到例外狀況，伺服器會關閉連線。 應用程式未處理的要求會由伺服器來處理。 當伺服器處理要求時，任何發生的例外狀況均由伺服器的例外狀況處理功能來處理。 應用程式的自訂錯誤頁面、例外狀況處理中介軟體或篩選條件並不會影響此行為。

啟動例外狀況處理

只有裝載層可以處理應用程式啟動期間發生的例外狀況。 可以將主機設定為會擷取啟動錯誤和擷取詳細錯誤。

只有在錯誤是於主機位址/連接埠繫結之後發生的情況下，裝載層才能顯示已擷取之啟動錯誤的錯誤頁面。 如果繫結失敗：

• 裝載層會記錄重大例外狀況。
• Dotnet 會處理損毀狀況。
• 當 HTTP 伺服器是 Kestrel 時，不會顯示任何錯誤頁面。

在 IIS (或 Azure App Service) 或 IIS Express 上執行時，如果無法啟動處理序，模組會傳回 502.5 - 處理序失敗。 如需詳細資訊，請參閱針對 Azure App Service 和 IIS 上的 ASP.NET Core 進行疑難排解。

資料庫錯誤頁面

資料庫開發人員頁面例外狀況篩選條件 AddDatabaseDeveloperPageExceptionFilter 會擷取可使用 Entity Framework Core 移轉來解決的資料庫相關例外狀況。 發生這些例外狀況時，會產生一個 HTML 回應，其中包含了解決該問題的可能動作的詳細資料。 此頁面只會在開發環境中啟用。 下列程式碼新增了資料庫開發人員頁面例外狀況篩選條件：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddDatabaseDeveloperPageExceptionFilter();
builder.Services.AddRazorPages();

例外狀況篩選條件

在 MVC 應用程式中，您能以全域設定例外狀況篩選條件，或是以每個控制器或每個動作為基礎的方式設定。 在 Razor Pages 應用程式中，您能以全域或每個頁面模型的方式設定它們。 這些篩選條件會處理在控制器動作或其他篩選條件執行期間發生但的任何未處理例外狀況。 如需詳細資訊，請參閱 ASP.NET Core 中的篩選條件。

例外狀況篩選條件適合用來截獲 MVC 動作中發生的例外狀況，但是它們並不像內建例外狀況處理中介軟體 (UseExceptionHandler) 那麼有彈性。 我們建議使用 UseExceptionHandler (除非您需要根據選擇的 MVC 動作以不同方式執行錯誤處理)。

模型狀態錯誤

如需如何處理模型狀態錯誤的相關資訊，請參閱模型繫結和模型驗證。

問題詳細資料

問題詳細資料 並不是描述 HTTP API 錯誤的唯一回應格式，不過，它們通常會用來報告 HTTP API 的錯誤。

問題詳細資料服務會實作 IProblemDetailsService 介面 (其支援在 ASP.NET Core 中建立問題詳細資料)。 IServiceCollection 上的 AddProblemDetails(IServiceCollection) 擴充方法會註冊預設的 IProblemDetailsService 實作。

在 ASP.NET Core 應用程式中，下列中介軟體會在呼叫 AddProblemDetails 時產生問題詳細資料 HTTP 回應，除非 Accept 要求 HTTP 標頭不包含註冊的 IProblemDetailsWriter 所支援的其中一個內容類型 (預設值：application/json)：

• ExceptionHandlerMiddleware：會在未定義自訂處理常式時產生問題詳細資料回應。
• StatusCodePagesMiddleware：預設會產生問題詳細資料回應。
• DeveloperExceptionPageMiddleware：在 Accept 要求 HTTP 標頭不包含 text/html 時，在開發過程中產生問題詳細資料回應。

下列程式碼會將應用程式設定為產生所有 HTTP 用戶端和伺服器錯誤回應的問題詳細資料回應，而這些錯誤回應「還沒有本文內容」：

builder.Services.AddProblemDetails();

var app = builder.Build();        

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler();
    app.UseHsts();
}

app.UseStatusCodePages();

下一節說明如何自訂問題詳細資料回應本文。

自訂問題詳細資料

可使用下列任一選項來自訂 ProblemDetails 的自動建立：

1. 使用 ProblemDetailsOptions.CustomizeProblemDetails
2. 使用自訂 IProblemDetailsWriter
3. 呼叫中介軟體中的 IProblemDetailsService

CustomizeProblemDetails 作業

可以使用 CustomizeProblemDetails 來自訂產生的問題詳細資料，而自訂內容會套用至所有自動產生的問題詳細資料中。

下列程式碼使用 ProblemDetailsOptions 來設定 CustomizeProblemDetails：

builder.Services.AddProblemDetails(options =>
    options.CustomizeProblemDetails = ctx =>
            ctx.ProblemDetails.Extensions.Add("nodeId", Environment.MachineName));

var app = builder.Build();        

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler();
    app.UseHsts();
}

app.UseStatusCodePages();

例如，HTTP Status 400 Bad Request 端點結果會產生下列的問題詳細資料回應本文：

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "Bad Request",
  "status": 400,
  "nodeId": "my-machine-name"
}

自訂 IProblemDetailsWriter

可以針對進階自訂來建立 IProblemDetailsWriter 實作。

public class SampleProblemDetailsWriter : IProblemDetailsWriter
{
    // Indicates that only responses with StatusCode == 400
    // are handled by this writer. All others are
    // handled by different registered writers if available.
    public bool CanWrite(ProblemDetailsContext context)
        => context.HttpContext.Response.StatusCode == 400;

    public ValueTask WriteAsync(ProblemDetailsContext context)
    {
        // Additional customizations.

        // Write to the response.
        var response = context.HttpContext.Response;
        return new ValueTask(response.WriteAsJsonAsync(context.ProblemDetails));
    }
}

注意： 使用自訂 IProblemDetailsWriter 時，必須在呼叫 AddRazorPages、AddControllers、AddControllersWithViews 或 AddMvc 之前先註冊自訂 IProblemDetailsWriter：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddTransient<IProblemDetailsWriter, SampleProblemDetailsWriter>();

var app = builder.Build();

// Middleware to handle writing problem details to the response.
app.Use(async (context, next) =>
{
    await next(context);
    var mathErrorFeature = context.Features.Get<MathErrorFeature>();
    if (mathErrorFeature is not null)
    {
        if (context.RequestServices.GetService<IProblemDetailsWriter>() is
            { } problemDetailsService)
        {

            if (problemDetailsService.CanWrite(new ProblemDetailsContext() { HttpContext = context }))
            {
                (string Detail, string Type) details = mathErrorFeature.MathError switch
                {
                    MathErrorType.DivisionByZeroError => ("Divison by zero is not defined.",
                        "https://en.wikipedia.org/wiki/Division_by_zero"),
                    _ => ("Negative or complex numbers are not valid input.",
                        "https://en.wikipedia.org/wiki/Square_root")
                };

                await problemDetailsService.WriteAsync(new ProblemDetailsContext
                {
                    HttpContext = context,
                    ProblemDetails =
                    {
                        Title = "Bad Input",
                        Detail = details.Detail,
                        Type = details.Type
                    }
                });
            }
        }
    }
});

// /divide?numerator=2&denominator=4
app.MapGet("/divide", (HttpContext context, double numerator, double denominator) =>
{
    if (denominator == 0)
    {
        var errorType = new MathErrorFeature
        {
            MathError = MathErrorType.DivisionByZeroError
        };
        context.Features.Set(errorType);
        return Results.BadRequest();
    }

    return Results.Ok(numerator / denominator);
});

// /squareroot?radicand=16
app.MapGet("/squareroot", (HttpContext context, double radicand) =>
{
    if (radicand < 0)
    {
        var errorType = new MathErrorFeature
        {
            MathError = MathErrorType.NegativeRadicandError
        };
        context.Features.Set(errorType);
        return Results.BadRequest();
    }

    return Results.Ok(Math.Sqrt(radicand));
});

app.Run();

中介軟體的問題詳細資料

將 ProblemDetailsOptions 與 CustomizeProblemDetails 一起使用的另一種方法是在中介軟體中設定 ProblemDetails。 可以透過呼叫 IProblemDetailsService.WriteAsync 來撰寫問題詳細資料回應：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();

builder.Services.AddProblemDetails();

var app = builder.Build();

app.UseHttpsRedirection();
app.UseStatusCodePages();

// Middleware to handle writing problem details to the response.
app.Use(async (context, next) =>
{
    await next(context);
    var mathErrorFeature = context.Features.Get<MathErrorFeature>();
    if (mathErrorFeature is not null)
    {
        if (context.RequestServices.GetService<IProblemDetailsService>() is
                                                           { } problemDetailsService)
        {
            (string Detail, string Type) details = mathErrorFeature.MathError switch
            {
                MathErrorType.DivisionByZeroError => ("Divison by zero is not defined.",
                "https://en.wikipedia.org/wiki/Division_by_zero"),
                _ => ("Negative or complex numbers are not valid input.", 
                "https://en.wikipedia.org/wiki/Square_root")
            };

            await problemDetailsService.WriteAsync(new ProblemDetailsContext
            {
                HttpContext = context,
                ProblemDetails =
                {
                    Title = "Bad Input",
                    Detail = details.Detail,
                    Type = details.Type
                }
            });
        }
    }
});

// /divide?numerator=2&denominator=4
app.MapGet("/divide", (HttpContext context, double numerator, double denominator) =>
{
    if (denominator == 0)
    {
        var errorType = new MathErrorFeature { MathError =
                                               MathErrorType.DivisionByZeroError };
        context.Features.Set(errorType);
        return Results.BadRequest();
    }

    return Results.Ok(numerator / denominator);
});

// /squareroot?radicand=16
app.MapGet("/squareroot", (HttpContext context, double radicand) =>
{
    if (radicand < 0)
    {
        var errorType = new MathErrorFeature { MathError =
                                               MathErrorType.NegativeRadicandError };
        context.Features.Set(errorType);
        return Results.BadRequest();
    }

    return Results.Ok(Math.Sqrt(radicand));
});

app.MapControllers();

app.Run();

在上面的程式碼中，Mnimal API 端點 /divide 和 /squareroot 在錯誤輸入時傳回了預期的自訂問題回應。

API 控制器端點在錯誤輸入時傳回了預設的問題回應，而不是自訂的問題回應。 因為在呼叫 IProblemDetailsService.WriteAsync 之前，API 控制器已將「錯誤狀態碼的問題詳細資料」寫入回應串流中，而且不會再次寫入回應中，所以傳回了預設的問題回應。

下列的 ValuesController 傳回了 BadRequestResult (其寫入回應串流中，因而阻止傳回自訂的問題回應)。

[Route("api/[controller]/[action]")]
[ApiController]
public class ValuesController : ControllerBase
{
    // /api/values/divide/1/2
    [HttpGet("{Numerator}/{Denominator}")]
    public IActionResult Divide(double Numerator, double Denominator)
    {
        if (Denominator == 0)
        {
            var errorType = new MathErrorFeature
            {
                MathError = MathErrorType.DivisionByZeroError
            };
            HttpContext.Features.Set(errorType);
            return BadRequest();
        }

        return Ok(Numerator / Denominator);
    }

    // /api/values/squareroot/4
    [HttpGet("{radicand}")]
    public IActionResult Squareroot(double radicand)
    {
        if (radicand < 0)
        {
            var errorType = new MathErrorFeature
            {
                MathError = MathErrorType.NegativeRadicandError
            };
            HttpContext.Features.Set(errorType);
            return BadRequest();
        }

        return Ok(Math.Sqrt(radicand));
    }

}

下列的 Values3Controller 傳回了 ControllerBase.Problem，因此傳回了預期的自訂問題結果：

[Route("api/[controller]/[action]")]
[ApiController]
public class Values3Controller : ControllerBase
{
    // /api/values3/divide/1/2
    [HttpGet("{Numerator}/{Denominator}")]
    public IActionResult Divide(double Numerator, double Denominator)
    {
        if (Denominator == 0)
        {
            var errorType = new MathErrorFeature
            {
                MathError = MathErrorType.DivisionByZeroError
            };
            HttpContext.Features.Set(errorType);
            return Problem(
                title: "Bad Input",
                detail: "Divison by zero is not defined.",
                type: "https://en.wikipedia.org/wiki/Division_by_zero",
                statusCode: StatusCodes.Status400BadRequest
                );
        }

        return Ok(Numerator / Denominator);
    }

    // /api/values3/squareroot/4
    [HttpGet("{radicand}")]
    public IActionResult Squareroot(double radicand)
    {
        if (radicand < 0)
        {
            var errorType = new MathErrorFeature
            {
                MathError = MathErrorType.NegativeRadicandError
            };
            HttpContext.Features.Set(errorType);
            return Problem(
                title: "Bad Input",
                detail: "Negative or complex numbers are not valid input.",
                type: "https://en.wikipedia.org/wiki/Square_root",
                statusCode: StatusCodes.Status400BadRequest
                );
        }

        return Ok(Math.Sqrt(radicand));
    }

}

產生例外狀況的 ProblemDetails 承載

請思考下列應用程式：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();
builder.Services.AddProblemDetails();

var app = builder.Build();

app.UseExceptionHandler();
app.UseStatusCodePages();

if (app.Environment.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
}

app.MapControllers();
app.Run();

在非開發環境中，當發生例外狀況時，以下是傳回給用戶端的標準 ProblemDetails 回應：

{
"type":"https://tools.ietf.org/html/rfc7231#section-6.6.1",
"title":"An error occurred while processing your request.",
"status":500,"traceId":"00-b644<snip>-00"
}

對於大部分的應用程式，上面的程式碼就是例外狀況所需的全部內容。 不過，下節將示範如何取得更詳細的問題回應。

自訂例外處理常式頁面的替代方法，便是將 Lambda 提供給 UseExceptionHandler。 使用 Lambda 可讓您存取錯誤，並使用 IProblemDetailsService.WriteAsync 來撰寫問題詳細資料回應：

using Microsoft.AspNetCore.Diagnostics;
using static System.Net.Mime.MediaTypeNames;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();
builder.Services.AddProblemDetails();

var app = builder.Build();

app.UseExceptionHandler();
app.UseStatusCodePages();

if (app.Environment.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
}
else
{
    app.UseExceptionHandler(exceptionHandlerApp =>
    {
        exceptionHandlerApp.Run(async context =>
        {
            context.Response.StatusCode = StatusCodes.Status500InternalServerError;
            context.Response.ContentType = Text.Plain;

            var title = "Bad Input";
            var detail = "Invalid input";
            var type = "https://errors.example.com/badInput";

            if (context.RequestServices.GetService<IProblemDetailsService>() is
                { } problemDetailsService)
            {
                var exceptionHandlerFeature =
               context.Features.Get<IExceptionHandlerFeature>();

                var exceptionType = exceptionHandlerFeature?.Error;
                if (exceptionType != null &&
                   exceptionType.Message.Contains("infinity"))
                {
                    title = "Argument exception";
                    detail = "Invalid input";
                    type = "https://errors.example.com/argumentException";
                }

                await problemDetailsService.WriteAsync(new ProblemDetailsContext
                {
                    HttpContext = context,
                    ProblemDetails =
                {
                    Title = title,
                    Detail = detail,
                    Type = type
                }
                });
            }
        });
    });
}

app.MapControllers();
app.Run();

警告

請勿提供敏感性的錯誤資訊給用戶端。 提供錯誤有安全性風險。

產生問題詳細資料的另一種方法是使用協力廠商 NuGet 套件 Hellang.Middleware.ProblemDetails (該套件可用來將例外狀況和用戶端錯誤對應至問題詳細資料)。

其他資源

• 檢視或下載範例程式碼 \(英文\) (如何下載)
• 針對 Azure App Service 和 IIS 上的 ASP.NET Core 進行疑難排解
• Azure App Service 與 IIS 搭配 ASP.NET Core 時的常見錯誤疑難排解
• 處理 ASP.NET Core 控制器型 Web API 中的錯誤
• 處理最少 API 中的錯誤。