asp.net core 自定义异常处理中间件

intro

在 asp.net core 中全局异常处理，有时候可能不能满足我们的需要，可能就需要自己自定义一个中间件处理了，最近遇到一个问题，有一些异常，不希望记录错误日志，目前主要是用户请求取消导致的 taskcanceledexception 和 operationcanceledexception 异常。因为我的 error 级别的日志会输出到 sentry，sentry的异常会自动发邮件提醒，如果是一些没必要的错误，自然不需要记录错误日志，于是就想自定义一个异常处理中间件，自己处理异常，不将异常处理直接交给 asp.net core 的异常处理。

请求取消

请求取消导致的异常：

asp.net core 引入了 httpcontext.requestaborted 来监听用户取消请求（实际测试下来，并不是每次都会触发，还没搞清楚怎么100%的触发），你可以使用 httpcontext.requestaborted 来在用户取消请求的时候中断后台逻辑的处理，避免处理一些不必要的业务，下面给出一个使用示例，示例源码
，更多详细信息可以参考 圣杰的这篇

[httpget]
public async task<iactionresult> getasync(string keyword, int pagenumber = 1, int pagesize = 10)
{
    expression<func<notice, bool>> predict = n => true;
    if (!string.isnullorwhitespace(keyword))
    {
        predict = predict.and(n => n.noticetitle.contains(keyword));
    }
    var result = await _repository.getpagedlistresultasync(x => new
    {
        x.noticetitle,
        x.noticevisitcount,
        x.noticecustompath,
        x.noticepublisher,
        x.noticepublishtime,
        x.noticeimagepath
    }, querybuilder => querybuilder
            .withpredict(predict)
            .withorderby(q => q.orderbydescending(_ => _.noticepublishtime))
        , pagenumber, pagesize, httpcontext.requestaborted); // 直接使用 httpcontext.requestaborted

    return ok(result);
}

// 在 action 方法中声明 cancellationtoken，asp.net core 会自动将 `httpcontext.requestaborted` 绑定到 cancellationtoken 对象
[httpget]
public async task<iactionresult> getasync(cancellationtoken cancellationtoken)
{
    var result = await _repository.getresultasync(p => new
    {
        p.placename,
        p.placeindex,
        p.placeid,
        p.maxreservationperiodnum
    }, builder => builder
    .withpredict(x => x.isactive)
    .withorderby(x => x.orderby(_ => _.placeindex).thenby(_ => _.updatetime)), cancellationtoken);
    return ok(result);
}

异常处理中间件

异常处理中间件源码：

public class customexceptionhandlermiddleware
{
    private readonly requestdelegate _next;
    private readonly customexceptionhandleroptions _options;

    public customexceptionhandlermiddleware(requestdelegate next, ioptions<customexceptionhandleroptions> options)
    {
        _next = next;
        _options = options.value;
    }

    public async task invokeasync(httpcontext context)
    {
        try
        {
            await _next(context);
        }
        catch (system.exception ex)
        {
            var logger = context.requestservices.getrequiredservice<iloggerfactory>()
                .createlogger<customexceptionhandlermiddleware>();
            if (context.requestaborted.iscancellationrequested && (ex is taskcanceledexception || ex is operationcanceledexception))
            {
                _options.onrequestaborted?.invoke(context, logger);
            }
            else
            {
                _options.onexception?.invoke(context, logger, ex);
            }
        }
    }
}

public class customexceptionhandleroptions
{
    public func<httpcontext, ilogger, exception, task> onexception { get; set; } =
        async (context, logger, exception) => logger.logerror(exception, $"request exception, requestid: {context.traceidentifier}");

    public func<httpcontext, ilogger, task> onrequestaborted { get; set; } =
        async (context, logger) => logger.loginformation($"request aborted, requestid: {context.traceidentifier}");
}

可以通过配置 customexceptionhandleroptions 来实现自定义的异常处理逻辑，默认请求取消会记录一条 information 级别的日志，其他异常则会记录一条 error 级别的错误日志

你可以通过下面的示例来配置遇到请求取消异常的时候什么都不做

service.configure(options=>
{
    options.onrequestaborted = (context, logger) => task.completedtask;
});

reference

• https://github.com/weihanli/activityreservation/blob/dev/activityreservation.api/reservationplacecontroller.cs