如何在WebAPI中使用IExceptionHandler避免重复日志问题？

问题场景 #

在WebAPI应用中实现了自定义IExceptionHandler处理全局异常，但每个错误会被记录两次：一次由自定义处理器处理，另一次由ExceptionHandlerMiddleware自行记录，且后者未经过自定义方法。断点显示自定义处理器仅触发一次，说明中间件在进入自定义处理器前就完成了日志记录，需要阻止这一默认行为。

已尝试的无效方案 #

在appsettings.json中添加以下配置，但未解决问题，且并非理想方案：

"Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware": "None"

当前代码实现 #

自定义异常处理器 #

public class MyGlobalExceptionHandler: IExceptionHandler
{
    public async ValueTask<bool> TryHandleAsync(HttpContext httpContext, Exception exception, CancellationToken cancellationToken)
    {
        // 自定义日志与异常处理逻辑
        // ...
        return true; // 关键：返回true标记异常已处理
    }
}

Program.cs中的现有配置 #

builder.Services.AddExceptionHandler<MyGlobalExceptionHandler>();
// 其他业务代码
app.UseExceptionHandler(_ => { });

正确解决方案 #

步骤1：修正自定义处理器的返回值 #

确保TryHandleAsync方法返回true，这会告诉ExceptionHandlerMiddleware：异常已被完全处理，无需执行后续默认操作（包括默认日志）。

步骤2：调整Program.cs的中间件配置 #

将app.UseExceptionHandler(_ => { });改为无参数重载，让中间件直接使用已注册的自定义处理器：

builder.Services.AddExceptionHandler<MyGlobalExceptionHandler>();
// 其他中间件注册（如UseRouting、UseAuthorization等）
app.UseExceptionHandler(); // 使用已配置的自定义处理器

步骤3：确保日志配置生效（可选） #

如果仍存在重复日志，可在appsettings.json中添加更精确的日志过滤配置，彻底禁用中间件的日志输出：

"Logging": {
  "LogLevel": {
    "Default": "Information",
    "Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware": "None"
  }
}

关键说明 #

• IExceptionHandler.TryHandleAsync返回true是核心，它会终止ExceptionHandlerMiddleware的后续流程，避免默认日志和响应生成。
• 中间件注册顺序很重要：UseExceptionHandler需要在UseRouting、UseEndpoints等业务中间件之前注册，才能捕获所有异常。

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