ASP.NET WebAPI异常处理中间件忽略取消请求的最佳实践

在.NET 6的Web应用中，要可靠过滤取消请求相关的异常，需要兼顾标准取消异常类型、请求取消标志和第三方库包装异常这三个核心场景，以下是经过验证的最佳实践：

核心判断逻辑 #

• 优先识别OperationCanceledException及其子类（包括TaskCanceledException）：这是.NET中任务/操作取消时抛出的标准异常类型。
• 结合HttpContext.RequestAborted.IsCancellationRequested或异常自带的CancellationToken.IsCancellationRequested判断：避免出现异常抛出但取消标志未设置的边缘情况（比如异步操作取消后，上下文标志未及时更新的场景）。

处理包装类异常 #

很多第三方库会将OperationCanceledException包装在其他异常内部（比如IOException、AggregateException），需要递归遍历异常链进行检查：

• 对于AggregateException，遍历其InnerExceptions集合逐一判断；
• 对于普通嵌套异常，递归检查InnerException直到异常链结束。

完整实现示例 #

以下是一个自定义异常日志中间件的实现，可直接用于过滤取消请求异常：

public class CancellationExceptionFilterMiddleware
{
    private readonly RequestDelegate _next;
    private readonly ILogger<CancellationExceptionFilterMiddleware> _logger;

    public CancellationExceptionFilterMiddleware(RequestDelegate next, ILogger<CancellationExceptionFilterMiddleware> logger)
    {
        _next = next;
        _logger = logger;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        try
        {
            await _next(context);
        }
        catch (Exception ex)
        {
            if (IsCancellationRelatedException(ex, context))
            {
                // 客户端主动取消，返回Nginx标准的499状态码，不记录错误日志
                context.Response.StatusCode = 499;
                return;
            }

            // 记录非取消类异常日志
            _logger.LogError(ex, "Unhandled application exception");
            context.Response.StatusCode = StatusCodes.Status500InternalServerError;
        }
    }

    private bool IsCancellationRelatedException(Exception ex, HttpContext context)
    {
        while (ex != null)
        {
            // 检查是否为取消异常，同时验证取消标志
            if (ex is OperationCanceledException oce)
            {
                if (context.RequestAborted.IsCancellationRequested || oce.CancellationToken.IsCancellationRequested)
                {
                    return true;
                }
            }

            // 处理AggregateException的内部异常集合
            if (ex is AggregateException aggregateEx)
            {
                foreach (var innerEx in aggregateEx.InnerExceptions)
                {
                    if (IsCancellationRelatedException(innerEx, context))
                    {
                        return true;
                    }
                }
            }

            ex = ex.InnerException;
        }

        return false;
    }
}

// 注册中间件的扩展方法
public static class MiddlewareExtensions
{
    public static IApplicationBuilder UseCancellationExceptionFilter(this IApplicationBuilder builder)
    {
        return builder.UseMiddleware<CancellationExceptionFilterMiddleware>();
    }
}

关键注意事项 #

• 不要依赖单一判断条件：仅检查异常类型会漏掉包装异常，仅检查取消标志会漏掉异常抛出但标志未更新的场景；
• 返回合适的状态码：使用499状态码可让服务器（如Nginx）识别为客户端主动取消，避免被统计为500错误；
• 谨慎扩展异常类型：除非明确遇到第三方库抛出的非标准取消异常，否则不要盲目添加IOException等类型的判断，避免误过滤正常异常。

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