使用全局异常处理会搞砸 DelegatingHandler答案

【问题标题】：using global exception handeling messes up DelegatingHandler使用全局异常处理会搞砸 DelegatingHandler
【发布时间】：2017-08-17 03:59:26
【问题描述】：

oververide IExceptionHandler 时，发生意外异常时响应不会到达 DelegatingHandler。我该如何解决这个问题？

在 webapi 2 中，我想为请求和响应消息实现审计记录器。我还想添加一个全局异常处理程序。但是，当我用我的自定义实现替换 IExceptionHandler 时。响应永远不会到达 DelegatingHandler -on 异常 - 因此对响应的审计会丢失。

在 WebApiConfig 中

// add custom audittrail logger
config.MessageHandlers.Add(new AuditLogHandler());
// replace global exception handeling
config.Services.Replace(typeof(IExceptionHandler), new WebAPiExceptionHandler());

自定义异常处理程序

public class WebAPiExceptionHandler : ExceptionHandler
{
    //A basic DTO to return back to the caller with data about the error
    private class ErrorInformation
    {
        public string Message { get; set; }
        public DateTime ErrorDate { get; set; }
    }

    public override void Handle(ExceptionHandlerContext context)
    {
        context.Result = new ResponseMessageResult(context.Request.CreateResponse(HttpStatusCode.InternalServerError,
        new ErrorInformation { Message = "Iets is misgegaan", ErrorDate = DateTime.UtcNow }));
    }
}

自定义审核记录器

public class AuditLogHandler : DelegatingHandler
{
    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        if (request.Content != null)
        {
            var task = await request.Content.ReadAsStringAsync();

            // .. code for loggign request
        }

        var result = await base.SendAsync(request, cancellationToken);

        // .. code for logging response
        // when I do not replace WebAPiExceptionHandler, code is reachred here
        // When I Do use WebAPiExceptionHandler, code is not reached here

        return result;
    }
}

webapi中抛出异常的代码

public class Values_v2Controller : ApiController
{
    public string Get(int id)
    {
        throw new Exception("haha");
    }
}

【问题讨论】：

标签： c# .net-4.5.2 webapi2

【解决方案1】：

不要使用ExceptionHandler作为基类，实现接口IExceptionHandler

public class WebAPiExceptionHandler : IExceptionHandler
{
    public Task HandleAsync(ExceptionHandlerContext context, CancellationToken cancellationToken)
    {
        var fout = new ErrorInformation
        {
            Message = "Iets is misgegaan"
            , ErrorDate = DateTime.UtcNow
        };

        var httpResponse = context.Request.CreateResponse(HttpStatusCode.InternalServerError, fout);

        context.Result = new ResponseMessageResult(httpResponse);

        return Task.FromResult(0);
    }

    private class ErrorInformation
    {
        public string Message { get; set; }
        public DateTime ErrorDate { get; set; }
    }
}

【讨论】：

【解决方案2】：

问题是ExceptionHandler只有在ShouldHandle(ExceptionHandlerContext context)返回true时才会执行Handle(ExceptionHandlerContext context)方法。

覆盖 bool ShouldHandle(ExceptionHandlerContext context) 以始终返回 true 为我解决问题。

【讨论】：

@Liam 你是对的。谢谢。我编辑了答案以修复它。