OnExceptionAsync与OnException之间的ExceptionFilter差异

时间:2014-07-30 07:27:49

标签: asp.net-mvc asp.net-web-api asp.net-web-api2

就是这样。

在MVC或WebApi中编写 custome exception filter 时, OnExceptionAsync OnException 方法有什么区别? 是否仅在使用异步控制器时才调用OnExceptionAsync? 或两者都被称为?

何时使用?

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

一些基本代码:ilustrate:

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

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

1 个答案:

答案 0 :(得分:11)

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

如果您想要一个简单的场景,例如发送错误的可序列化描述,则可以覆盖OnException而不是OnExceptionAsync,因为OnExceptionAsync在ExceptionFilterAttribute默认实现中调用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对象。