Web API 异常处理解决方案

• 异常筛选器：在App_Start里面新建一个类WebApiExceptionFilterAttribute.cs(这实际上是定义了一个新的特性)，它继承于ExceptionFilterAttribute类，但是我们需要重写里面的OnException()方法
• 在接口级别上使用新定义的异常类，同时还需要在自定义异常类WebApiExceptionFilterAttribute.cs中定义错误信息，页面显示"不好意思，该方法不支持"，而且它的Status Code: 501 This Func is Not Supported

[App_Start.WebApiExceptionFilter]
[HttpGet]
public string GetData(){
    throw new NotImplementedException("不好意思，该方法不支持");
}

• 在控制器级别使用异常过滤，直接在控制器上面标注特性即可；如果想要在多个控制器上同时启用异常过滤，可以建立一个基类控制器，在该基类控制器上标注特性，其他控制器继承该基类控制器即可

[App_Start.WebApiExceptionFilter]
public class TestException2Controller : ApiController{
    [HttpGet]
    public string GetData(){
        throw new NotImplementedException("不好意思，该方法不支持");
    }
}
[App_Start.WebApiExceptionFilter]
public class TestExceptionBaseController : ApiController{ }

 

• 全部配置，对整个应用程序启用异常过滤

//在Global.asax全局配置里面添加
public class WebApiApplication : System.Web.HttpApplication{
    protected void Application_Start(){
        GlobalConfiguration.Configuration.Filters.Add(new App_Start.WebApiExceptionFilterAttribute());
    }
}
//在WebApiConfig.cs文件的Register方法里面添加
public static class WebApiConfig{
    public static void Register(HttpConfiguration config){
        config.Filters.Add(new App_Start.WebApiExceptionFilterAttribute());
}}

• 使用HttpResponseException类自定义异常信息
• HttpResponseMessage 用于返回一个来自于客户端的请求结果讯息，可以使用 HttpResponseMessage 自订返回的内容，HttpResponseException 则是以当发生例外时用来返回客户端错误讯息
• 当呼叫 Web API 服务时发生了与预期上不同的错误时，理当应该中止程序返回错误讯息，这时对于错误的返回就该使用 HttpResponseException，而使用 HttpResponseMessage 则是代表着当客户端发送了一个工作请求而 Web API 正确的完成了这个工作，就能够使用 HttpResponseMessage 返回一个 201 的讯息，所以 HttpResponseMessage 与 HttpResponseException 在使用上根本的目标就是不同的，用 HttpResponseMessage 去返回一个例外错误也会让程序结构难以辨别且不够清晰

[HttpGet]
public string GetData_Ex(int id){
    if (id == 1){
        return "function is OK";
    }else{
        var response = new HttpResponseException(new HttpResponseMessage(HttpStatusCode.NotFound){
            Content = new StringContent("不好意思，没有找到"+id.ToString()),
            ReasonPhrase = "object is not found"
        });
        throw response;
    }
}

• 使用HttpError对象提供一致的方法响应正文中返回的错误信息，二者都可以向客户端返回http状态码和错误讯息，并且都可以包含在HttpResponseException对象中发回到客户端；但是，一般情况下，HttpError只有在向客户端返回错误讯息的时候才会使用，而HttpResponseMessage对象既可以返回错误讯息，也可返回请求正确的消息

[HttpGet]
public HttpResponseMessage GetData_HttpError(){
    try{
        //业务逻辑
    }catch (Exception ex){
        return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ex.Message);
    }
    return Request.CreateResponse(HttpStatusCode.OK, "OKOKOK");
}
 

public class WebApiExceptionFilterAttribute : ExceptionFilterAttribute{
    public override void OnException(HttpActionExecutedContext actionExecutedContext){
        //1.异常日志记录（正式项目里面一般是用log4net记录异常日志）
        Console.WriteLine(DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss") + "——" + actionExecutedContext.Exception.GetType().ToString() + ":" + actionExecutedContext.Exception.StackTrace);
        //2.返回调用方具体的异常信息
        if (actionExecutedContext.Exception is NotImplementedException){
            actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.NotImplemented){
                Content = new StringContent("不好意思，该方法不支持"),//获取或设置 HTTP 响应消息的内容
                ReasonPhrase = "不好意思，该方法不支持"//获取或设置通常由服务器发出的原因短语（与状态代码一起发出
            };
        }
        else if(actionExecutedContext.Exception is TimeoutException){
            actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.RequestTimeout);
        }
        else{
            //.....这里可以根据项目需要返回到客户端特定的状态码。如果找不到相应的异常，统一返回服务端错误500
            actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.InternalServerError);
        }
        base.OnException(actionExecutedContext);
    }
}