如何捕获 Web API 2 中的所有异常？

Question

我正在用 Web API 编写一个 RESTful API，但我不确定如何有效地处理错误。我希望 API 返回 JSON，并且每次都需要包含完全相同的格式 - 即使出现错误。以下是成功和失败响应的几个示例。

成功：

{
    Status: 0,
    Message: "Success",
    Data: {...}
}

错误：

{
    Status: 1,
    Message: "An error occurred!",
    Data: null
}

如果有异常 - any 异常，我想返回一个像第二个一样形成的响应。什么是做到这一点的万无一失的方法，以便没有未处理的异常？

Answer 1

实现IExceptionHandler。

类似：

 public class APIErrorHandler : IExceptionHandler
 {
     public Task HandleAsync(ExceptionHandlerContext context, CancellationToken cancellationToken)
     {
         var customObject = new CustomObject
             {
                 Message = new { Message = context.Exception.Message }, 
                 Status = ... // whatever,
                 Data = ... // whatever
             };

        //Necessary to return Json
        var jsonType = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
        json.SerializerSettings.Formatting = Newtonsoft.Json.Formatting.Indented;    

        var response = context.Request.CreateResponse(HttpStatusCode.InternalServerError, customObject, jsonType);

        context.Result = new ResponseMessageResult(response);

        return Task.FromResult(0);
    }
}

并在 WebAPI 的配置部分 (public static void Register(HttpConfiguration config)) 写：

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