arm webapi遇到異常怎么處理？詳細步驟告訴你
時間：2018-07-20 來源：未知
我們都知道，webapi是作為服務器來使用的，每次客戶端發送http請求到我們的WebApi服務里面，那么服務器就會把結果輸到response到客戶端，在這個步驟中，如果服務器發生異常，那么就會返回500的錯誤，那么在這個時候我們應該如何來處理這樣的異常呢，在這里給你們提供一些處理異常的小技巧。
通常webapi會出現的異常一般有下面幾點：Controller構造方法中出現的異常， MessageHandlers中出現的異常，路由過程中出現的異常，Body在序列化/反序列化過程中出現的異常
由于ExceptionFilter解決不了這些異常，那么為了解決這些問題，webapi還有兩個針對異常記錄、處理的擴展點：那就是IExceptionLogger 和IExceptionHandler。
對于這兩個來說，他們是webapi管道組件進行注冊管理的，他們是有不同分工的。
IExceptionHandler作為異常處理組件，負責異常發生后的處理工作，他處于異常處理管道的最末端，當IExceptionLogger組件進行一場記錄完畢、沒有相關的ExceptoinFilter進行異常處理時，才會最終調用ExceptionHandler進行異常處理，在Web API中，有且僅有一個ExceptionHandler進行異常的處理。
IExceptionLogger作為異常日志記錄組件，負責異常發生后的日志記錄，他貫穿于整個Web API的生命周期中，在Web API框架里，任何一個請求周期中出現任何一個未被捕獲/處理的異常都會首先進入這個異常日志記錄管道進行異常Log記錄，在Web API中可以注冊多個IExceptionLogger實例負責不同的異常處理。
在Web API框架中給出了兩個基類：ExceptionLogger和ExceptionHandler，我們在使用ExceptionLogger基類時，他提供了ShouldLog虛方法，該方法在基類中被調用，其作用在于避免同一個異常被同一個ExceptionLogger實例重復記錄(如當后續的管道中該異常又被拋出，或者同一個ExceptionLogger對象不小心被注冊了兩次就會出現重復記錄的可能)我們也能復寫ShouldLog方法加入我們自己的異常記錄判斷邏輯以針對不同的場景進行不同的ExceptionLogger調用。如果有興趣可以反編譯一下ExceptionLogger基類看看，他使用了顯示接口實現，挺有意思的一個技巧。下面我們來看一個ExceptionLogger使用的例子：
public class ErroLogger : ExceptionLogger
{
public async Task LogAsync(ExceptionLoggerContext context, CancellationToken cancellationToken)
{
var sb = new StringBuilder();
//獲取Log組件
ILogger log = LogManager.GetCurrentClassLogger();
var request = context.Request;
sb.AppendLine("URL:");
//獲取URL
var url = request.RequestUri.ToString();
sb.AppendLine(url);
log.Error(context.Exception,sb.ToString(),"");
}
public override bool ShouldLog(ExceptionLoggerContext context)
{
return context.Exception is DemoException && base.ShouldLog(context);
}
}
在這里，我們重新寫了ShouldLog，就是為了保證ExceptionLogger只記錄DemoException這個類型的異常，而且他也調用了基類的方法不會重復記錄同一個異常。在LogAsync方法中，我通過Log組件記錄了導致異常的請求URL，也記錄了異常信息。
那接下來我們就是要開始對組件來注冊了：
在App_Start/WebApiConfig.cs文件中的Register方法中寫入
config.Services.Add(typeof(IExceptionLogger),new ErroLogger());
這樣，針對DemoException的異常記錄組件就完成了，當Web API執行管道中出現未處理的DemoException異常，均會調用則個組件進行記錄。
接下來我們來寫一個ExceptionHandler，在整個Web API框架中，ExceptionHandler只能提供一個實例，與ExceptionLogger一樣，我們可以繼承ExceptionHandler基類來簡化異常處理，在ExceptionHandler中也提供了ShouldHandle方法來判斷該異常是否應該處理，避免重復處理管道中其他環節重復拋出的異常。我們也同樣提供一個例子：
public class ErrorHandler : ExceptionHandler
{
public override async Task HandleAsync(ExceptionHandlerContext context, CancellationToken cancellationToken)
{
if (context.Exception is DemoException)
{
context.Result = new ResponseMessageResult(context.Request.CreateResponse(HttpStatusCode.BadRequest,new {Message=context.Exception.Message}));
}
else
{
context.Result = new ResponseMessageResult(context.Request.CreateResponse(HttpStatusCode.InternalServerError,new {Message = "服務器已被外星人綁架"}));
}
}
}
在這個例子中，我們判斷了異常的類型，并根據不同的異常返回客戶端不同的響應內容和不同的HTTP狀態碼。
然后在配置中注冊這個異常處理模塊，在App_Start/WebApiConfig.cs文件中的Register方法中寫入
config.Services.Replace(typeof(IExceptionHandler),new ErrorHandler());
這樣就替換了系統默認的ExceptionHandler，可以使用我們自定義的Handler進行異常的處理了。
在異常記錄、處理過程中，我們都碰到相應的異常上下文參數，我們能通過這個參數獲取當前請求的上下文，獲取請求、響應(小心有時會為空哦)、捕獲到該異常的catch塊信息等內容，我們可以利用這些信息更好地描述、記錄、處理異常。
到這里ExceptionLogger組件和ExceptionHandler組件簡單的開發就完成了。在開發的過程中我們可以看到，ExceptionLogger負責了全局的異常記錄，在Web API框架管道下出現未處理的異常ExceptionLogger都會進行捕獲、記錄。而ExceptionHandler和ExceptionFilter功能是有重疊的，那么問題來了，如何使用這兩個呢?下面讓你清楚的了解：
現在你是否已經get到這些小竅門，小方法了嗎，要多加練習，在出現異常時，要想到這些對于ExceptionHandler和ExceptionFilter而言，我覺得ExceptionHandler比ExceptionFilter更有優勢。
