C#进阶--WebApi异常处理机制
其实对于C#异常处理大家都不陌生，但是对于在WeiApi上的异常处理实际上也和传统异常处理区别不大，但是却经过封装可以让异常更加友好，https://docs.microsoft.com/en-us/aspnet/web-api/overview/error-handling/exception-handling，通过微软的官方介绍，我们可以知道WeiApi可以简单概述为三种异常，接下来我们围绕这三种异常给出例子，如何封装和处理以上三种异常
异常过滤
异常过滤器实现了System.Web.Http.Filters.IExceptionFilter接口。编写异常过滤器最简单的方法是从System.Web.Http.Filters.ExceptionFilterAttribute类派生并重写OnException方法。Microsoft给出的关于异常过滤器解释，那么如何实现呢？通过阅读《Asp.NET WEB API2 框架揭秘》,我们知道每一次客户端请求API都会通过HTTP请求，服务端得到结果输出response到客户端。这个过程中，一旦服务端发生异常，会统一向客户端返回500的错误。
那么在Web API中如何定义NotImplementedException类？首先在App_Start里面新建一个类WebApiExceptionFilterAttribute.cs，继承ExceptionFilterAttribute，重写OnException方法，代码如下
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.Message + "——堆栈信息：" +
actionExecutedContext.Exception.StackTrace);
//2.返回调用方具体的异常信息
if (actionExecutedContext.Exception is NotImplementedException)
{
actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.NotImplemented);
}
else if (actionExecutedContext.Exception is TimeoutException)
{
actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.RequestTimeout);
}
//.....这里可以根据项目需要返回到客户端特定的状态码。如果找不到相应的异常，统一返回服务端错误500
else
{
actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.InternalServerError);
}
base.OnException(actionExecutedContext);
}
}
1 public class WebApiExceptionFilterAttribute : ExceptionFilterAttribute
2 {
3 //重写基类的异常处理方法
4 public override void OnException(HttpActionExecutedContext actionExecutedContext)
5 {
6 //1.异常日志记录（正式项目里面一般是用log4net记录异常日志）
7 Console.WriteLine(DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss") + "——" +
8 actionExecutedContext.Exception.GetType().ToString() + "：" + actionExecutedContext.Exception.Message + "——堆栈信息：" +
9 actionExecutedContext.Exception.StackTrace);
10
11 //2.返回调用方具体的异常信息
12 if (actionExecutedContext.Exception is NotImplementedException)
13 {
14 actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.NotImplemented);
15 }
16 else if (actionExecutedContext.Exception is TimeoutException)
17 {
18 actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.RequestTimeout);
19 }
20 //.....这里可以根据项目需要返回到客户端特定的状态码。如果找不到相应的异常，统一返回服务端错误500
21 else
22 {
23 actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.InternalServerError);
24 }
25
26 base.OnException(actionExecutedContext);
27 }
28 }
代码解析：通过判断异常的具体类型，向客户端返回不同的http状态码，示例里面写了两个，可以根据项目的实际情况加一些特定的我们想要捕获的异常，然后将对应的状态码写入http请求的response里面，对于一些我们无法判断类型的异常，统一返回服务端错误500。Microsoft也有一个代码实现，但是没有封装
注册异常过滤
- 接口级别
- 控制器级别
- 全局配置
要将过滤器应用于特定操作，请将过滤器作为属性添加到操作中：
|
1
2
3
4
5
6
7
8
|
public class ProductsController : ApiController{ [NotImplExceptionFilter] public Contact GetContact(int id) { throw new NotImplementedException("This method is not implemented"); }} |
要将过滤器应用于控制器上的所有操作，请将过滤器作为属性添加到控制器类中：
|
1
2
3
4
5
|
[NotImplExceptionFilter]public class ProductsController : ApiController{ // ...} |
要将过滤器全局应用于所有Web API控制器，请将过滤器实例添加到GlobalConfiguration.Configuration.Filters集合中。此集合中的执行筛选器适用于任何Web API控制器操作。
|
1
2
|
GlobalConfiguration.Configuration.Filters.Add( new ProductStore.NotImplExceptionFilterAttribute()); |
如果需要，甚至可以向Status Code里面写入自定义的描述信息，并且还可以向我们的Response的Content里面写入我们想要的信息。我们稍微改下OnException方法：
|
1
2
3
4
5
6
7
|
if (actionExecutedContext.Exception is NotImplementedException) { var oResponse = new HttpResponseMessage(HttpStatusCode.NotImplemented); oResponse.Content = new StringContent("方法不被支持"); oResponse.ReasonPhrase = "This Func is Not Supported"; actionExecutedContext.Response = oResponse; } |
HttpResponseException自定义异常信息
异常过滤器是针对接口控制器以及全局定义，一般返回的都是服务器级别的错误，但是有的时候我们需要定义业务异常的代码，那么如果是业务异常的情况下我们就可以使用HttpResponseException自定义异常，如下述代码：
public Product GetProduct(int id)
{
Product item = repository.Get(id);
if (item == null)
{
var resp = new HttpResponseMessage(HttpStatusCode.NotFound)
{
Content = new StringContent(string.Format("没有找到产品ID = {0}的产品", id)),
ReasonPhrase = "Product ID Not Found"
}
throw new HttpResponseException(resp);
}
return item;
}
可以看到具体的业务异常信息是通过HttpResponseMessage封装，最后由HttpResponseException抛出，Microsoft没有解释HttpResponseMessage是什么，起初笔者以为这是一个HttpResponseException的子类，但是跟踪了后发现HttpResponseMessage 继承了IDisposable接口，而IDisposable接口的主要用途是释放非托管的资源。 垃圾回收器自动释放不再使用该对象时分配给托管对象的内存。 但是，不可能预测将发生垃圾回收。 此外，垃圾回收器具有不知道如窗口句柄的非托管资源，或打开文件和流。从描述上来看使用HttpResponseMessage时就代表发生了异常并且进行一次资源管理的回收，所以笔者认为，使用HttpResponseMessage可以更清晰的描述业务中所发生的 异常，并且在返回异常的时候进行一次垃圾回收，减少程序资源浪费
HttpError
HttpError对象提供了一个一致的方式在回应主体中返回的错误信息。以下示例显示如何在响应正文中使用HttpError返回HTTP状态码404（Not Found）。通过Microsoft的解释就可以知道HttpError提供的是状态码返回，那么实际应用上更多的是将其和HttpResponseException一起使用。
public Product GetProduct(int id)
{
Product item = repository.Get(id);
if (item == null)
{
var message = string.Format("Product with id = {0} not found", id);
throw new HttpResponseException(
Request.CreateErrorResponse(HttpStatusCode.NotFound, message));
}
else
{
return item;
}
}
总结
借鉴（Microsoft官网）ASP.NET Web API中的异常处理
在一般的项目中，可以定义好一些全体的关于服务器端的异常处理，并且封装好一个HttpResponseException自定义异常的处理，无需捕获HttpResponseException异常，Api会自己处理这个异常的，并且最好为每个异常给出更加详细的HTTP状态码，可以让异常更加精细友好
