ASP.NET Core：IExceptionHandler未返回ProblemDetails的原因与解决方法

问题分析 #

你实现的IExceptionHandler能正确设置500状态码，但响应体为空，通常由以下几个原因导致：

• 异常处理服务未正确注册
• 中间件顺序错误，导致异常未被捕获
• 响应流已提前启动，无法写入新内容
• JSON序列化配置异常

解决方案 #

1. 确保服务正确注册 #

在Program.cs中必须注册两个关键服务：AddProblemDetails（提供ProblemDetails的序列化支持）和AddExceptionHandler（注册你的全局异常处理器）：

var builder = WebApplication.CreateBuilder(args);

// 注册ProblemDetails服务，提供标准化错误响应的序列化支持
builder.Services.AddProblemDetails();
// 注册自定义全局异常处理器
builder.Services.AddExceptionHandler<GlobalExceptionHandler>();

// 其他服务注册（如Controllers、DbContext等）...

var app = builder.Build();

// 异常处理中间件必须放在最前面（在路由、授权等中间件之前）
app.UseExceptionHandler();

// 其他中间件配置...
app.UseRouting();
app.UseAuthorization();

app.MapControllers();

app.Run();

2. 修正异常处理器代码 #

调整处理器逻辑，增加响应状态检查和写入异常捕获，同时使用依赖注入的日志组件：

using Microsoft.AspNetCore.Diagnostics;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using System.Net;

public class GlobalExceptionHandler : IExceptionHandler
{
    private readonly ILogger<GlobalExceptionHandler> _logger;

    // 通过构造函数注入ILogger，符合ASP.NET Core依赖注入规范
    public GlobalExceptionHandler(ILogger<GlobalExceptionHandler> logger)
    {
        _logger = logger;
    }

    public async ValueTask<bool> TryHandleAsync(
        HttpContext httpContext,
        Exception exception,
        CancellationToken cancellationToken)
    {
        _logger.LogError(exception, "捕获到未处理的全局异常");

        // 检查响应是否已开始发送，若已开始则无法写入内容
        if (httpContext.Response.HasStarted)
        {
            _logger.LogWarning("响应流已启动，无法写入ProblemDetails");
            return false;
        }

        var problemDetails = new ProblemDetails
        {
            Status = (int)HttpStatusCode.InternalServerError,
            Title = "发生未处理异常",
            Detail = exception.Message,
            Instance = httpContext.Request.Path // 添加请求路径信息，便于排查
        };

        httpContext.Response.StatusCode = problemDetails.Status.Value;
        httpContext.Response.ContentType = "application/problem+json";

        try
        {
            await httpContext.Response.WriteAsJsonAsync(problemDetails, cancellationToken);
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "写入ProblemDetails响应时发生异常");
            return false;
        }

        return true;
    }
}

3. 排查序列化配置问题 #

如果自定义了System.Text.Json配置，确保没有排除ProblemDetails类型的序列化：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        // 确保保留默认的序列化规则，或明确配置支持ProblemDetails
        options.JsonSerializerOptions.PropertyNamingPolicy = null;
        // 其他自定义配置...
    });

关键注意事项 #

• 中间件顺序：UseExceptionHandler必须放在UseRouting、UseAuthorization等业务中间件之前，确保所有请求的异常都能被捕获。
• 响应状态检查：如果响应流已启动（比如之前的中间件已经写入部分内容），此时无法再写入ProblemDetails，需记录日志并返回false，让框架处理后续逻辑。
• 日志规范：使用依赖注入的ILogger而非静态日志，便于框架统一管理日志上下文。

内容的提问来源于stack exchange，提问作者aim