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);
    }
}