ProblemDetails模式无法在所有API场景生效的排查求助

问题原因 #

• /hello接口抛出未处理异常，会被UseExceptionHandler中间件捕获，触发AddProblemDetails()注册的逻辑，自动生成标准ProblemDetails响应。
• /bad接口是主动返回自定义对象，属于手动构造的响应内容，ProblemDetails中间件默认仅处理未捕获异常或状态码页面场景，不会拦截这种主动返回的自定义结果。

解决办法 #

方法1：手动返回ProblemDetails实例 #

直接构造标准ProblemDetails对象返回，保证响应格式统一：

app.MapGet("/bad", () => Results.BadRequest(new ProblemDetails
{
    Status = StatusCodes.Status400BadRequest,
    Title = "无效请求",
    Detail = "请求存在错误，请检查后重试。"
}));

方法2：配置状态码页面自动转换 #

替换原有app.UseStatusCodePages();为专门的状态码转ProblemDetails逻辑，让主动返回的状态码也被标准化：

// 替换原app.UseStatusCodePages();
app.UseStatusCodePages(pages => pages.MapToStatusCodePagesProblemDetails());

如果需要自定义不同状态码的内容，可以用更灵活的写法：

app.UseStatusCodePages(async context =>
{
    var response = context.HttpContext.Response;
    if (response.StatusCode is >= 400 and < 600)
    {
        var problemDetails = new ProblemDetails
        {
            Status = response.StatusCode,
            Title = "请求出错",
            Detail = response.StatusCode == 400 ? "请求参数无效" : "服务器处理失败"
        };
        await context.HttpContext.Response.WriteAsJsonAsync(problemDetails);
    }
});

方法3：用结果过滤器统一拦截转换 #

创建全局或局部过滤器，拦截指定类型的结果并转换为ProblemDetails：

public class ProblemDetailsResultFilter : IResultFilter
{
    public void OnResultExecuting(ResultExecutingContext context)
    {
        if (context.Result is BadRequestObjectResult badRequestResult)
        {
            var problemDetails = new ProblemDetails
            {
                Status = StatusCodes.Status400BadRequest,
                Title = "无效请求",
                Detail = badRequestResult.Value?.ToString() ?? "请求不符合要求"
            };
            context.Result = Results.BadRequest(problemDetails);
        }
    }

    public void OnResultExecuted(ResultExecutedContext context) { }
}

注册全局过滤器：

builder.Services.AddControllers(options =>
{
    options.Filters.Add<ProblemDetailsResultFilter>();
});

或者仅在单个端点应用：

app.MapGet("/bad", () => Results.BadRequest("Very bad, you have a problem."))
   .AddEndpointFilter<ProblemDetailsResultFilter>();

内容的提问来源于stack exchange，提问作者Frédéric De Lène Mirouze