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);
- }
- }
代码解析:通过判断异常的具体类型,向客户端返回不同的http状态码,示例里面写了两个,可以根据项目的实际情况加一些特定的我们想要捕获的异常,然后将对应的状态码写入http请求的response里面,对于一些我们无法判断类型的异常,统一返回服务端错误500。Microsoft也有一个代码实现,但是没有封装
注册异常过滤
有几种方法可以注册Web API异常过滤器:
- 接口级别
- 控制器级别
- 全局配置
要将过滤器应用于特定操作,请将过滤器作为属性添加到操作中:
- public class ProductsController : ApiController
- {
- [NotImplExceptionFilter]
- public Contact GetContact(int id)
- {
- throw new NotImplementedException("This method is not implemented");
- }
- }
要将过滤器应用于控制器上的所有操作,请将过滤器作为属性添加到控制器类中:
- [NotImplExceptionFilter]
- public class ProductsController : ApiController
- {
- // ...
- }
要将过滤器全局应用于所有Web API控制器,请将过滤器实例添加到GlobalConfiguration.Configuration.Filters集合中。此集合中的执行筛选器适用于任何Web API控制器操作。
- GlobalConfiguration.Configuration.Filters.Add(
- new ProductStore.NotImplExceptionFilterAttribute());
如果需要,甚至可以向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;
- }
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状态码,可以让异常更加精细友好
C#进阶--WebApi异常处理机制的更多相关文章
- java进阶(19)--异常处理机制
一.基本概念 1.异常的作用: java将异常信息打印至控制台,供程序修改,增加其健壮性. int c=1/0; //将抛出 java.lang.ArithmeticException 2.异常 ...
- C#进阶系列——WebApi 异常处理解决方案
前言:上篇C#进阶系列——WebApi接口传参不再困惑:传参详解介绍了WebApi参数的传递,这篇来看看WebApi里面异常的处理.关于异常处理,作为程序员的我们肯定不陌生,记得在介绍 AOP 的时候 ...
- C#进阶系列——WebApi 路由机制剖析:你准备好了吗?
前言:从MVC到WebApi,路由机制一直是伴随着这些技术的一个重要组成部分. 它可以很简单:如果你仅仅只需要会用一些简单的路由,如/Home/Index,那么你只需要配置一个默认路由就能简单搞定: ...
- C#进阶系列——WebApi 异常处理解决方案(转)
出处:http://www.cnblogs.com/landeanfen/p/5363846.html 阅读目录 一.使用异常筛选器捕获所有异常 二.HttpResponseException自定义异 ...
- C#进阶系列——WebApi 路由机制剖析:你准备好了吗? 转载https://www.cnblogs.com/landeanfen/p/5501490.html
阅读目录 一.MVC和WebApi路由机制比较 1.MVC里面的路由 2.WebApi里面的路由 二.WebApi路由基础 1.默认路由 2.自定义路由 3.路由原理 三.WebApi路由过程 1.根 ...
- C#进阶系列——WebApi异常处理解决方案
阅读目录 一.使用异常筛选器捕获所有异常 二.HttpResponseException自定义异常信息 三.返回HttpError 四.总结 正文 为什么说是实践?因为在http://www.asp. ...
- WebApi 路由机制剖析
阅读目录 一.MVC和WebApi路由机制比较 1.MVC里面的路由 2.WebApi里面的路由 二.WebApi路由基础 1.默认路由 2.自定义路由 3.路由原理 三.WebApi路由过程 1.根 ...
- webapi框架搭建-webapi异常处理
webapi框架搭建系列博客 前言 上一篇我们已经完成了项目的日志管理,在项目开发中日志会经常记录程序中的异常,供后续问题排查使用.本篇讲如何在webapi里加入异常处理机制. 目的和原则 1.程序任 ...
- (转)C# WebApi 异常处理解决方案
原文地址:http://www.cnblogs.com/landeanfen/p/5363846.html 一.使用异常筛选器捕获所有异常 我们知道,一般情况下,WebApi作为服务使用,每次客户端发 ...
随机推荐
- (转)TabIndex 属性
html中的tabIndex属性可以设置键盘中的TAB键在控件中的移动顺序,即焦点的顺序. 把控件的tabIndex属性设成1到32767的一个值,就可以把这个控件加入到TAB键的序列中. 这 ...
- Js、Jquery定时执行(一次或者重复多次,取消重复)
1. 创建一个变量 var ref = ""; 2. 定时刷新调用的方法 function consoleLog(){ console.log("a"); } ...
- MVC中使用Echart后台加载数据 实现饼图、折线图、全国地图数据,单击双击事件等
@{ Layout = null; } @if (false) { <script src="~/Js/jquery-easyui-1.5/jquery.min.js"> ...
- gitlab实时备份方案(非官方命令)
gitlab自带的备份功能做不到实时备份,为了尽可能减少意外情况导致的丢失数据,自己搞了一个实时备份的功能. 备份的大头主要是两部分,数据库和代码库.数据库由DBA配置主备. 仓库经过测试,通过lsy ...
- zabbix使用mysql数据库 对表分区
zabbix删除历史数据 mysql 表自动分区.删除 ----2016年终总结 二 zabbix清理历史数据是个比较蛋疼的问题,尤其在监控数据较多时,一方面无法彻底释放历史数据空间,一方面数据库删除 ...
- JavaScript中的this基本问题
在函数中 this 到底取何值,是在函数真正被调用执行的时候确定下来的,函数定义的时候确定不了. 执行上下文环境 : **定义**:执行函数的时候,会产生一个上下文的对象,里面保存变量,函数声明和th ...
- java基础--static关键字的使用
一.static关键字的作用 使类成员完全独立于该类的任何对象.通常情况下,类成员必须通过它的类的对象访问,但是被static修饰的成员,能够被自己访问,而不必引用特定的实例. 一旦一个成员被声明为s ...
- Latex 去掉行号
本文主要讲如何去掉Latex的行号 删除\modulolinenumbers删除所有\linenumbers 删除\usepackage{lineno,hyperref} modulolinenumb ...
- 无限大地图:lightmap拆分
无缝地图涉及到地形.物件的分块加载,同样,lightmap也需要动态加载.而场景烘焙时,所有物件都是一起烘焙的,那怎么把某些物件指定烘焙到某一张lightmap贴图中?网上找了很久,也没有看到具体的实 ...
- 解析 .Net Core 注入 (1) 注册服务
在学习 Asp.Net Core 的过程中,注入可以说是无处不在,对于 .Net Core 来说,它是独立的一个程序集,没有复杂的依赖项和配置文件,所以对于学习 Asp.Net Core 源码的朋友来 ...