WebApi异常处理解决方案

 

前言:上篇C#进阶系列——WebApi接口传参不再困惑:传参详解介绍了WebApi参数的传递,这篇来看看WebApi里面异常的处理。关于异常处理,作为程序员的我们肯定不陌生,记得在介绍 AOP 的时候,我们讲过通过AOP可以统一截获异常。那么在我们的WebApi里面一般是怎么处理异常的呢,今天这一篇,博主带着大家一起来实践下WebApi的异常处理。

WebApi系列文章

为什么说是实践?因为在http://www.asp.net里面已经明确给出WebApi的异常处理机制。光有理论还不够,今天我们还是来试一把。通过实践,我们可能发现一些更详尽的用法。

一、使用异常筛选器捕获所有异常

我们知道,一般情况下,WebApi作为服务使用,每次客户端发送http请求到我们的WebApi服务里面,服务端得到结果输出response到客户端。这个过程中,一旦服务端发生异常,会统一向客户端返回500的错误。

        [HttpGet]
public string GetAllChargingData([FromUri]TB_CHARGING obj)
{
throw new NotImplementedException("方法不被支持");
}

我们来看看http请求

而有些时候,我们客户端需要得到更加精确的错误码来判断异常类型,怎么办呢?

记得在介绍AOP的时候,我们介绍过MVC里面的IExceptionFilter接口,这个接口用于定义异常筛选器所需的方法,在WebApi里面,也有这么一个异常筛选器,下面我们通过一个实例来看看具体如何实现。

首先在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);
}
}

代码解析:通过判断异常的具体类型,向客户端返回不同的http状态码,示例里面写了两个,可以根据项目的实际情况加一些特定的我们想要捕获的异常,然后将对应的状态码写入http请求的response里面,对于一些我们无法判断类型的异常,统一返回服务端错误500。关于http的状态码,framework里面定义了一些常见的类型,我们大概看看:

 Http状态码

定义好了异常处理方法,剩下的就是如何使用了。可以根据实际情况,在不同级别使用统一的异常处理机制。

1、接口级别

        [WebApiExceptionFilter]
[HttpGet]
public string GetAllChargingData([FromUri]TB_CHARGING obj)
{
throw new NotImplementedException("方法不被支持");
}

执行到异常后,会先进到OnException方法:

执行完成之后浏览器查看:

如果需要,甚至可以向Status Code里面写入自定义的描述信息,并且还可以向我们的Response的Content里面写入我们想要的信息。我们稍微改下OnException方法:

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

看看ReasonPhrase描述信息

看看Response的描述信息

2、控制器级别

如果想要某一个或者多个控制器里面的所有接口都使用异常过滤,直接在控制器上面标注特性即可。

  • 某一个控制器上面启用异常过滤
  [WebApiExceptionFilter]
public class ChargingController : BaseApiController
{
#region Get
[HttpGet]
public string GetAllChargingData([FromUri]TB_CHARGING obj)
{
throw new NotImplementedException("方法不被支持");
}
}
  • 多个控制器上面同时启用异常过滤
    [WebApiExceptionFilter]
public class BaseApiController : ApiController
{
}
    public class ChargingController : BaseApiController
{
#region Get
[HttpGet]
public string GetAllChargingData([FromUri]TB_CHARGING obj)
{
throw new NotImplementedException("方法不被支持");
}
}

这样,所有继承BaseApiController的子类都会启用异常过滤。

3、全局配置

如果需要对整个应用程序都启用异常过滤,则需要做如下两步:

  1、在Global.asax全局配置里面添加 GlobalConfiguration.Configuration.Filters.Add(new WebApiExceptionFilterAttribute()); 这一句,如下:

void Application_Start(object sender, EventArgs e)
{
// 在应用程序启动时运行的代码
AreaRegistration.RegisterAllAreas();
GlobalConfiguration.Configure(WebApiConfig.Register);
RouteConfig.RegisterRoutes(RouteTable.Routes);
GlobalConfiguration.Configuration.Filters.Add(new WebApiExceptionFilterAttribute());
}

  2、在WebApiConfig.cs文件的Register方法里面添加  config.Filters.Add(new WebApiExceptionFilterAttribute()); 这一句,如下:

        public static void Register(HttpConfiguration config)
{
//跨域配置
config.EnableCors(new EnableCorsAttribute("*", "*", "*")); // Web API 路由
config.MapHttpAttributeRoutes(); RouteTable.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{action}/{id}",
defaults: new { id = RouteParameter.Optional }
).RouteHandler = new SessionControllerRouteHandler(); config.Filters.Add(new WebApiExceptionFilterAttribute());
}

二、HttpResponseException自定义异常信息

上面说的是全局的异常捕获以及处理方式,在某些情况下,我们希望以异常的方式向客户端发送相关信息,可能就需要用到我们的HttpResponseException。比如:

        [HttpGet]
public TB_CHARGING GetById(string id)
{
//从后台查询实体
var oModel = server.Find(id);
if (oModel == null)
{
var resp = new HttpResponseMessage(HttpStatusCode.NotFound)
{
Content = new StringContent(string.Format("没有找到id={0}的对象", id)),
ReasonPhrase = "object is not found"
};
throw new HttpResponseException(resp);
}
return oModel;
}

执行之后浏览器里面查看结果:

代码释疑:细心的朋友可能,发现了,这里既使用了HttpResponseMessage,又使用了HttpResponseException,那么,像这种可控的异常,我们是否可以直接以HttpResponseMessage的形式直接返回到客户端而不用抛出异常呢?这里就要谈谈这两个对象的区别了,博主的理解是HttpResonseMessage对象用来响应讯息并包含状态码及数据内容,HttpResponseException对象用来向客户端返回包含错误讯息的异常。

在网上看到一篇文章这样描述两者的区别:当呼叫 Web API 服务时发生了与预期上不同的错误时,理当应该中止程序返回错误讯息,这时对于错误的返回就该使用 HttpResponseException,而使用 HttpResponseMessage 则是代表着当客户端发送了一个工作请求而 Web API 正确的完成了这个工作,就能够使用 HttpResponseMessage 返回一个 201 的讯息,所以 HttpResponseMessage 与 HttpResponseException 在使用上根本的目标就是不同的,用 HttpResponseMessage 去返回一个例外错误也会让程序结构难以辨别且不够清晰。

三、返回HttpError

HttpError对象提供一致的方法来响应正文中返回错误的信息。准确来说,HttpError并不是一个异常,只是用来包装错误信息的一个对象。其实在某一定的程度上,HttpError和HttpResponseMessage使用比较相似,二者都可以向客户端返回http状态码和错误讯息,并且都可以包含在HttpResponseException对象中发回到客户端。但是,一般情况下,HttpError只有在向客户端返回错误讯息的时候才会使用,而HttpResponseMessage对象既可以返回错误讯息,也可返回请求正确的消息。其实关于HttpError没什么特别好讲的,我们来看一个例子就能明白:

    public HttpResponseMessage Update(dynamic obj)
{
TB_Product oModel = null;
try
{
var id = Convert.ToString(obj.id);
oModel = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_Product>(Convert.ToString(obj.dataModel)); //...复杂的业务逻辑 }
catch(Exception ex)
{
return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ex.Message);
} return Request.CreateResponse<TB_Product>(HttpStatusCode.OK, oModel); }

假如现在在执行try里面复杂业务逻辑的时候发生了异常,我们捕获到了异常然后向客户端返回HttpError对象,这个对象里面包含我们自定义的错误讯息,如果正常则返回HttpResponseMessage对象。

如果请求异常:

如果请求正常

四、总结

以上三种异常的处理方法,可以根据不同的场景选择使用。

  • 如果项目对异常处理要求并不高,只需要记录好异常日志即可,那么使用异常筛选器就能够搞定
  • 如果项目需要对不同的异常,客户端做不同的处理。而这个时候使用异常筛选器不能详尽所有的异常,可能使用HttpResponseException对象是更好的选择,定义更加精细的异常和异常描述。
  • 对于何时使用HttpError,又何时使用HttpResponseMessage,可以参考上文三里面用法。
  • 当然实际项目中很可能以上两种或者三种同时使用。

上文通过一些简单的示例介绍了下WebApi里面异常的处理机制,可能不够深入,但对于一般项目的异常处理基本够用。其实有一点博主还没有想明白,对于构造函数里面的异常该如何统一捕获呢?通过异常筛选器是捕获不到的,不知道园友们有没有什么更好的办法,不吝赐教,感谢感谢!如果本文能帮到你,不妨推荐下,您的推荐是博主继续总结的动力!

 
 
标签: WebApi

WebApi异常的更多相关文章

  1. WebAPI异常捕捉处理,结合log4net日志(webapi框架)

    一:异常捕捉处理 首先,在我们需要区分controller的类型.是全部基层controller,还是Apicontroller.(当然一般API框架,用的都是Apicontroller).两者异常处 ...

  2. MVC与WebApi中的异常过滤器

    一.MVC的异常过滤器   1.自定义MVC异常过滤器 创建一个类,继承HandleErrorAttribute即可,如果不需要作为特性使用直接实现IExceptionFilter接口即可, 注意,该 ...

  3. webapi框架搭建-webapi异常处理

    webapi框架搭建系列博客 前言 上一篇我们已经完成了项目的日志管理,在项目开发中日志会经常记录程序中的异常,供后续问题排查使用.本篇讲如何在webapi里加入异常处理机制. 目的和原则 1.程序任 ...

  4. WebApi 异常处理解决方案

    1.继承ExceptionFilterAttribute类,重写OnException方法 public class WebApiExceptionFilterAttribute : Exceptio ...

  5. Web API系列(三)统一异常处理

    前面讲了webapi的安全验证和参数安全,不清楚的朋友,可以看看前面的文章,<Web API系列(二)接口安全和参数校验>,本文主要介绍Web API异常结果的处理.作为内部或者是对外提供 ...

  6. Magicodes.WeiChat——版本发布历史

    购买地址:https://item.taobao.com/item.htm?id=520205558575 您可以在新标签页打开此图,以查看原始图片. Magicodes.WeiChat为湖南心莱信息 ...

  7. Web API统一异常处理 【转载】

    前面讲了webapi的安全验证和参数安全,不清楚的朋友,可以看看前面的文章,<Web API系列(二)接口安全和参数校验>,本文主要介绍Web API异常结果的处理.作为内部或者是对外提供 ...

  8. Redis总结(五)缓存雪崩和缓存穿透等问题 Web API系列(三)统一异常处理 C#总结(一)AutoResetEvent的使用介绍(用AutoResetEvent实现同步) C#总结(二)事件Event 介绍总结 C#总结(三)DataGridView增加全选列 Web API系列(二)接口安全和参数校验 RabbitMQ学习系列(六): RabbitMQ 高可用集群

    Redis总结(五)缓存雪崩和缓存穿透等问题   前面讲过一些redis 缓存的使用和数据持久化.感兴趣的朋友可以看看之前的文章,http://www.cnblogs.com/zhangweizhon ...

  9. .NET WebAPI 用ExceptionFilterAttribute实现错误(异常)日志的记录(log4net做写库操作)

    好吧,还是那个社区APP,非管理系统,用户行为日志感觉不是很必要的,但是,错误日志咱还是得记录则个.总不能上线后报bug了让自己手足无措吧,虽然不管有木有错误日志报bug都是件很头疼的事... 我们知 ...

随机推荐

  1. 【开发手记一】老生常谈:简简单单配置ZED板开发环境

    说明:整理之前项目博客,此系列之前发表于与非网 http://www.openhw.org/module/forum/thread-552476-1-1.html 在拿到开发板和配套教材之前,我们小组 ...

  2. Swift - 发送消息(文本,图片,文件等)给微信好友或分享到朋友圈

    通过调用微信提供的API接口,我们可以很方便的在应用中发送消息给微信好友,或者分享到朋友圈.在微信开发平台(https://open.weixin.qq.com)里,提供了详细的说明文档和样例.但由于 ...

  3. 几个前端博客 good

    http://www.cnblogs.com/JustinYoung/archive/2011/02/24/fresh-free-html-templates-2010.html http://www ...

  4. treeview树形菜单,递归

    我使用的是递归是实现无限级树形菜单: using System; using System.Collections; using System.Configuration; using System. ...

  5. Oracle SQL语句执行过程

    前言 QQ群讨论的时候有人遇到这样的问题:where子句中无法访问Oracle自定义的字段别名.这篇 博客就是就这一问题做一个探讨,并发散下思维,谈谈SQL语句的执行顺序问题. 问题呈现 直接给出SQ ...

  6. Android菜鸟的成长笔记(2)——第一个Android应用

    原文:Android菜鸟的成长笔记(2)--第一个Android应用 上一篇:Android菜鸟的成长笔记(1)--Anddroid环境搭建从入门到精通 在上一篇Android菜鸟的成长笔记(1)中我 ...

  7. 在ListView中实现排序

    此处介绍的情境是: (1)使用table布局ListView. (2)ListView的数据源是List<T>. (3)排序字段2个(帖子的回复次数和浏览次数),都是int类型. 基本思路 ...

  8. eclipse不能进入debug

    首先说明一下.我肯定是以debug模式启动的.断点程序肯定能走到. 可是一点页面,程序就跳到class文件,而不是Java文件. 解决的方法是:window---preferences---tomca ...

  9. 4.锁--无锁编程以及CAS

    无锁编程以及CAS 无锁编程 / lock-free / 非堵塞同步 无锁编程,即不使用锁的情况下实现多线程之间的变量同步,也就是在没有线程被堵塞的情况下实现变量的同步,所以也叫非堵塞同步(Non-b ...

  10. poj 1743 男人八题之后缀数组求最长不可重叠最长重复子串

    Musical Theme Time Limit: 1000MS   Memory Limit: 30000K Total Submissions: 14874   Accepted: 5118 De ...