Asp.Net Web API 2第七课——Web API异常处理
前言
阅读本文之前,您也可以到Asp.Net Web API 2 系列导航进行查看 http://www.cnblogs.com/aehyok/p/3446289.html
本文主要来讲解Asp.Net Web API中错误和异常的处理,包括以下几点:
1.HttpResponseException——HTTP响应异常
2.Exception Filters——异常过滤器
3.Registering Exception Filters——注册异常过滤器
4.HttpError——HTTP错误
HttpResponseException——HTTP响应异常
如果一个Web API 控制器抛出一个未捕获的异常,会发生什么?在默认情况下,大多数异常都被转换为一个带有状态码500的内部服务器错误的HTTP响应。
这个HTTPResponseException类型是一个特殊的类型。这种异常会返回你在异常构造器中指定的任何HTTP状态码。例如,在以下方法中,如果这个id参数无效,那么会返回“404——未找到”。
public Product GetProduct(int id) { Product item = repository.Get(id); if (item == null) { throw new HttpResponseException(HttpStatusCode.NotFound); } return item; }
为了对响应进行更多的控制,你也可以构造整个响应消息,并用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("No product with ID = {0}", id)), ReasonPhrase = "Product ID Not Found" } throw new HttpResponseException(resp); } return item;
Exception Filters——异常过滤器
通过编写一个异常过滤器,你可以定制Web API如何处理异常。当一个控制器抛出一个未处理的异常,且这个异常不是一个HttpResponseException异常时,一个异常过滤器会被执行。HttpResponseException类型一个特殊的情况,因为它是专门设计用来返回一个HTTP响应的。
异常过滤器实现System.Web.Http.Filters.IExceptionFilter接口。编写异常过滤器最简单的方式是通过System.Web.Http.Filters.ExceptionFilterAttribute类进行派生,并重写其OnException方法。
ASP.NET Web API中的异常过滤器与Asp.Net MVC中的是极为类似的。然后,他们被声明在不同的命名空间中,且功能也是独立的。特别强调一下,Asp.Net MVC中使用的HandleErrorAttribute类不会处理Web API控制器中抛出的异常。
以下是将NotImplementedException异常转换成HTTP状态码“501 — 未实现”的一个过滤器:
using System; using System.Net; using System.Net.Http; using System.Web.Http.Filters; public class NotImplExceptionFilterAttribute : ExceptionFilterAttribute { public override void OnException(HttpActionExecutedContext context) { if (context.Exception is NotImplementedException) { context.Response = new HttpResponseMessage(HttpStatusCode.NotImplemented); } } }
HttpActionExecutedContext对象的Response属性含有将发送给客户端的HTTP响应消息。
Registering Exception Filters——注册异常过滤器
以下是注册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());
如果你用的是“ASP.NET MVC 4 Web应用程序”项目模板创建的项目,要把你的Web API配置代码被放在WebApiConfig类中,它位于App_Start文件夹:
public static class WebApiConfig { public static void Register(HttpConfiguration config) { config.Filters.Add(new ProductStore.NotImplExceptionFilterAttribute()); // Other configuration code(其它配置代码)... } }
HttpError——HTTP错误
HttpError对象为在响应正文中返回错误消息提供了相应的方式。以下示例演示了如何用HttpError在响应体中返回HTTP状态码“404 — 未找到”:
public HttpResponseMessage GetProduct(int id) { Product item = repository.Get(id); if (item == null) {var message = string.Format("Product with id = {0} not found", id); HttpError err = new HttpError(message); return Request.CreateResponse(HttpStatusCode.NotFound, err); } else { return Request.CreateResponse(HttpStatusCode.OK, item); } }
在这个例子中,如果该方法成功,它会在HTTP响应中返回产品。但如果所请求的产品未找到,则HTTP响应会在请求体中包含一个HttpError。该响应看上去大致像这样:
HTTP/1.1 404 Not Found Content-Type: application/json; charset=utf-8 Date: Thu, 09 Aug 2012 23:27:18 GMT Content-Length: 51{"Message": "Product with id = 12 not found" }
注意,在这个例子中,HttpError会被序列化成JSON。使用HttpError的一个好处是,与其它强类型模型一样,会进行同样的“content-negotiation”(暂未实现)和序列化过程。
直接替代创建HttpError对象的一种办法是,你可以使用CreateErrorResponse方法:
public HttpResponseMessage GetProduct(int id) { Product item = repository.Get(id); if (item == null) { var message = string.Format("Product with id = {0} not found", id); return Request.CreateErrorResponse(HttpStatusCode.NotFound, message); } else { return Request.CreateResponse(HttpStatusCode.OK, item); } }
CreateErrorResponse在System.Net.Http.HttpRequestMessageExtensions类中被定义为一个扩展方法。本质上,CreateErrorResponse会创建一个HttpError实例,然后创建一个包含该HttpError的HttpResponseMessage。
Adding Custom Key-Values to HttpError把自定义的键值添加到HTTPError
HttpError类实际上是一个“键-值”集合(它派生于Dictionary<string, object>),因此你可以添加自己的“键-值”对:
public HttpResponseMessage GetProduct(int id) { Product item = repository.Get(id); if (item == null) { var message = string.Format("Product with id = {0} not found", id); var err = new HttpError(message); err["error_sub_code"] = 42; return Request.CreateErrorResponse(HttpStatusCode.NotFound, err); } else { return Request.CreateResponse(HttpStatusCode.OK, item); } }
Using HttpError with HttpResponseException以HttpResponseException的方式来使用HttpError
前面的例子是从控制器动作返回一个HttpResponseMessage消息,但你也可以使用HttpResponseException来返回一个HttpError。这让你能够在正常成功情况下返回强类型模型,而在有错误时,仍返回HttpError。
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; } }
总结
感觉比MVC中的异常处理更为出色,不知道新版本的MVC中的异常处理机制如何。下一篇文章将来讲解Web API2中新增加的一个亮点机制————属性路由,貌似很牛逼的样子。
转载于:https://www.cnblogs.com/lonelyxmas/p/3609033.html
Asp.Net Web API 2第七课——Web API异常处理相关推荐
- Asp.Net Web API 2第十七课——Creating an OData Endpoint in ASP.NET Web API 2(OData终结点)...
原文:Asp.Net Web API 2第十七课--Creating an OData Endpoint in ASP.NET Web API 2(OData终结点) 前言 很久没更新博客了,加上刚过 ...
- 返璞归真 asp.net mvc (10) - asp.net mvc 4.0 新特性之 Web API
返璞归真 asp.net mvc (10) - asp.net mvc 4.0 新特性之 Web API 原文:返璞归真 asp.net mvc (10) - asp.net mvc 4.0 新特性之 ...
- android 调用 asp.net web api,从 .NET 客户端调用 Web API (C#)
从 .NET 客户端调用 Web API (C#) 11/24/2017 本文内容 此内容适用于以前版本的 .NET. 新开发应该使用 ASP.NET Core. 有关使用 Core Web API ...
- asp.net程序性能优化的七个方面
asp.net程序性能优化的七个方面 一.数据库操作 1.用完马上关闭数据库连接 访问数据库资源需要创建连接.打开连接和关闭连接几个操作.这些过程需要多次与数据库交换信息以通过身份验证,比较耗费服务器 ...
- 用ASP.NET Core 2.1 建立规范的 REST API -- 保护API和其它
预备知识: 用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识 用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识 (2) + 准备项目 建 ...
- 用ASP.NET Core 2.1 建立规范的 REST API -- 缓存和并发
本文所需的一些预备知识可以看这里: 用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识 和 用ASP.NET Core 2.0 建立规范的 REST API -- 预 ...
- 用ASP.NET Core 2.1 建立规范的 REST API -- HATEOAS
本文所需的一些预备知识可以看这里: 用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识 和 用ASP.NET Core 2.0 建立规范的 REST API -- 预 ...
- 用ASP.NET Core 2.1 建立规范的 REST API -- 翻页/排序/过滤等
本文所需的一些预备知识可以看这里: 用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识 和 用ASP.NET Core 2.0 建立规范的 REST API -- 预 ...
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
Swagger是一个描述RESTful的Web API的规范和框架.如果使用ASP.NET的话,可以用Swashbuckle来自动生成Swagger,具体参考如何使 WebAPI 自动生成漂亮又实用在 ...
最新文章
- Python地信专题 | 基于geopandas的空间数据分析-坐标参考系篇
- 群体智能,多个机器人协同搬运!
- php防止快速刷新代码(分享)_php防止网站被刷新的方法汇总
- mysql调用短信接口_短信平台接口调用方法参考
- 【程序员的自我修养——链接、装载与库】笔记
- 常用通信协议——IIC详解(全网最全)
- 百度指数 数据分析(介绍)
- vSphere配置NSX Edge网络
- 执念斩长河入CSDN的第一篇日志
- 儿童定位手表、定位器、老人健康手表的工作原理
- 最小二乘拟合二次曲线在STM32中的实现笔记
- APP后期运营小技巧
- 软件推荐:Typora -新手上路-夏凌玥
- 使用python+selenium发送QQ邮件
- 微软商店,打开就显示无法加载该页面 代码0x80131500,网上一般不说的标准解决方案
- java.io.IOException: 远程主机强迫关闭了一个现有的连接
- dell最新型的服务器,灵活设计新标准!戴尔R720服务器评测
- 存款准备金率灾后再度上调
- java万能编码转换_java编码转换的详细过程
- 【tomcat 端口占用启动失败】The Tomcat connector configured to listen on port xx failed to start
热门文章
- [Qt教程] 第37篇 网络(七)TCP(一)
- Css标题中图片居中,图片居中:任意图片在div里的上下垂直都居中!
- linux wlan进程名称,linux无线网络配置无线网卡驱动安装与wlan802.11配置
- python 类属性排序_Python实现多属性排序的方法
- 【复习资料】设计模式
- android开发启动画面,Android开发笔记——如何正确实现App启动页
- el表达式动态取值中括号内两点_中考热点:旧瓶新酒,解题新策略分析之玩转动态型热点题型...
- pytorch无法下载或下载缓慢问题
- tensorflow量化策略详解
- 机器学习 KNN算法_0 丐版(matlab实现)