如何从Web Api消息处理程序中优雅地返回异常

时间:2012-08-08 13:57:10

标签: c# asp.net-web-api

我的Mvc \ WebApi应用程序中有一个全局ExceptionFilter,注册为:

public virtual void RegisterHttpFilters(HttpConfiguration config)
{
    config.Filters.Add(new MyExceptionFilter(_exceptionHandler));
}

MyExceptionFilter是:

public class MyExceptionFilter : ExceptionFilterAttribute
{
    private readonly IMyExceptionHandler m_exceptionHandler;

    public MyExceptionFilter(IMyExceptionHandler exceptionHandler)
    {
        m_exceptionHandler = exceptionHandler;
    }

    public override void OnException(HttpActionExecutedContext context)
    {
        Exception ex = context.Exception;
        if (ex != null)
        {
            object response = null;
            HttpStatusCode statusCode = m_exceptionHandler != null
                ? m_exceptionHandler.HandleException(ex, out response)
                : HttpStatusCode.InternalServerError;
            context.Response = context.Request.CreateResponse(statusCode, response ?? ex);
        }

        base.OnException(context);
    }
}

此过滤器将所有异常作为json-objects返回,并允许一些IMyExceptionHandler实现自定义要返回的对象。

这一切都运作良好。直到我的一些消息处理程序中有一个例外:

public class FooMessageHandler : DelegatingHandler
{
    private readonly Func<IBar> _barFactory;
    public FooMessageHandler(Func<IBar> barFactory)
    {
        _barFactory = varFactory;
    }

    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        request.Properties["MY_BAR"] = _barFactory();
        return base.SendAsync(request, cancellationToken);
    }
}

正如您所看到的,此处理程序创建了一些组件并将其放入当前的http请求消息中。 当FuncOfIBar发生异常时,我会得到黄色死亡屏幕。我没有调用我的ExceptionFilter。

我试图在消息处理程序中专门捕获异常并返回HttpResponseException但它没有改变任何东西 - 仍然得到YSOD:

public class XApplicationInitializerMessageHandler : DelegatingHandler
{
    private readonly Func<IXCoreApplication> _appFactory;
    private readonly IXExceptionHandler m_exceptionHandler;

    public XApplicationInitializerMessageHandler(Func<IXCoreApplication> appFactory, IXExceptionHandler exceptionHandler)
    {
        ArgumentValidator.EnsureArgumentNotNull(appFactory, "appFactory");
        _appFactory = appFactory;
        m_exceptionHandler = exceptionHandler;
    }

    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        try
        {
            request.SetApplication(_appFactory());
        }
        catch (Exception ex)
        {
            object resultObject = null;
            HttpStatusCode statusCode = m_exceptionHandler != null
                ? m_exceptionHandler.HandleException(ex, out resultObject)
                : HttpStatusCode.InternalServerError;
            HttpResponseMessage responseMessage = request.CreateResponse(statusCode, resultObject ?? ex);

            throw new HttpResponseException(responseMessage);
        }
        return base.SendAsync(request, cancellationToken);
    }
}

}

无论异常发生在哪里,我都希望我的应用程序的行为相同:在ApiController或消息处理程序中。

怎么做?

我知道Application_Error,但我想让HttpApplication自定义不可触及。

5 个答案:

答案 0 :(得分:8)

我应该只返回HttpResponseException

,而不是投掷HttpResponseMessage
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
    try
    {
        request.SetApplication(_appFactory());
    }
    catch (Exception ex)
    {
        object resultObject = null;
        HttpStatusCode statusCode = m_exceptionHandler != null
            ? m_exceptionHandler.HandleException(ex, out resultObject)
            : HttpStatusCode.InternalServerError;
        HttpResponseMessage responseMessage = request.CreateResponse(statusCode, resultObject ?? ex);

        return Task<HttpResponseMessage>.Factory.StartNew(() => responseMessage);
    }
    return base.SendAsync(request, cancellationToken);
}

答案 1 :(得分:5)

我在成功方面所做的是使用基于属性的方法。您在应该使用异常处理的每个操作上放置一个自定义属性:

[ExceptionHandling] 
public IEnumerable<string> Get()

您的自定义异常处理属性的实现方式如下:

public class ExceptionHandlingAttribute : ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext context)
    {}

正如您所见,自定义属性继承自ExceptionFilterAttribute。然后,您只需重写OnException方法。您可以做的是查看异常的类型并根据业务规则或任何符合您需求的处理它。在某些情况下,您可能只是吞下服务器上的异常。如果要通知客户端,可以抛出HttpResponseException,它可以保存所有相关信息,例如消息,调用堆栈,内部异常等。

如需更多灵感,请查看这篇精彩的博文:ASP.NET Web API Exception Handling

答案 2 :(得分:5)

我遇到了与未运行的全局异常过滤器相同的问题。解决方案是必须在与ASP.NET MVC异常过滤器不同的全局集合中配置Web API异常过滤器。

因此,要配置ASP.NET MVC错误处理,您将运行:

System.Web.Mvc.GlobalFilters.Filters.Add(new MyMvcExceptionFilter());

但是对于Web API错误处理,您必须运行:

System.Web.Http.GlobalConfiguration.Configuration.Filters.Add(new MyWebApiExceptionFilter());

根据我对Web API的有限经验,这种情况很典型:表面上使用的模式与ASP.NET MVC非常相似,因此很容易熟悉。这给人一种错觉,即编写一段代码会对两个框架产生影响,但实际上它们下面的实现都是大部分或完全独立的,你需要编写两个非常相似的代码版本来实现它们工作

Web API异常处理的优秀参考:http://www.asp.net/web-api/overview/web-api-routing-and-actions/exception-handling

答案 3 :(得分:2)

在startup.cs中:

config.Services.Replace(typeof(IExceptionHandler), new GlobalExceptionHandler());

我发现使用GlobalExceptionHandler可以在委托处理程序中捕获异常并返回自定义JSON对象。

答案 4 :(得分:0)

我发现这个博客的例子非常好: http://nodogmablog.bryanhogan.net/2016/07/getting-web-api-exception-details-from-a-httpresponsemessage/

我采用了一些更新的代码:

if ((int)response.StatusCode >= 400)
 {
      exceptionResponse = JsonConvert.DeserializeObject<ExceptionResponse>(LogRequisicao.CorpoResposta);
      LogRequisicao.CorpoResposta = exceptionResponse.ToString() ;
      if (exceptionResponse.InnerException != null)
             LogRequisicao.CorpoResposta += "\r\n InnerException: " + exceptionResponse.ToString();
 }

使用对象:

public class ExceptionResponse
    {
        public string Message { get; set; }
        public string ExceptionMessage { get; set; }
        public string ExceptionType { get; set; }
        public string StackTrace { get; set; }
        public ExceptionResponse InnerException { get; set; }

        public override String ToString()
        {
            return "Message: " + Message + "\r\n "
                + "ExceptionMessage: " + ExceptionMessage + "\r\n "
                + "ExceptionType: " + ExceptionType + " \r\n "
                + "StackTrace: " + StackTrace + " \r\n ";           
        }  
    }