OnExceptionAsync 与 OnException 之间的 ExceptionFilter 区别

Question

就是这样。

在MVC或WebApi中编写自定义异常过滤器时，OnExceptionAsync和OnException方法有什么区别？ 是不是只有在使用异步控制器时才调用 OnExceptionAsync ？ 还是两者都被调用？

什么时候用哪个？

如何使用返回任务结果的OnExceptionAsync？

需要说明的一些基本代码：

public class ApiExceptionFilterAttribute : ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext actionExecutedContext)
    {
        //TODO exception handling
    }

    public override Task OnExceptionAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
    {
        //TODO exception handling
    }
}

Answer 1

我认为 OnExceptionAsync 与异步操作一起使用。

如果你想要一个简单的场景，比如发送一个可序列化的错误描述，你可以覆盖 OnException 而不是 OnExceptionAsync，因为 OnExceptionAsync 在 ExceptionFilterAttribute default implementation 中调用 OnException：

public override void OnException(System.Web.Http.Filters.HttpActionExecutedContext actionExecutedContext)
{
    actionExecutedContext.Response = actionExecutedContext.Request.CreateResponse(HttpStatusCode.InternalServerError, new 
    {
        Message = "An unexpected error has occured",
        Description = actionExecutedContext.Exception.Message
    });

    actionExecutedContext.Response.Headers.CacheControl = new System.Net.Http.Headers.CacheControlHeaderValue()
    {
        NoCache = true,
        NoStore = true
    };
}

但您可能希望在数据库中记录异常并利用异步行为：

public override async Task OnExceptionAsync(HttpActionExecutedContext actionExecutedContext, CancellationToken cancellationToken)
{
    await LogException(actionExecutedContext.Exception);
}

async 和 await 关键字将为您管理异步行为。您不需要返回 Task 对象。