Web API 方法的返回类型、格式器、过滤器

一、Action方法的返回类型

a) 操作方法的返回类型有四种：void、简单或复杂类型、HttpResponseMessage类型、IHttpActionResult类型。

b) 如果返回类型为void，请求结束后HTTP状态码为204(No Content)，如果返回类型为复杂类型，则对象会被转化为Json字符串后传输。

c) 从图示的Web API的大致交互过程可以看到，Controll返回的是HttpResponseMessage类型，然后转换为HttpResponse提供给调用端。同时也可以自己手动设置在代码中返回一个HttpResponseMessage，并设置HTTP状态。

 

 

d) IHttpActionResult

WebAPI 2可以返回IHttpActionResult对象，与MVC的ActionResult类似。实现IHttpActionResult的类有：

返回这些类型是，就不用像HttpResponseMessage那样自己指定HTTP状态码了。

二、Web API Request\Response 数据格式

a) 媒体类型(又名MIME类型)指定数据的格式，例如type/subtype， text/html, text/xml, application/json, image/jpeg 等。在HTTP请求,请求中指定MIME类型的方法是是在头部中使用Accept和Content-Type属性。Accept头部属性指定客户期望的响应数据的格式,Content-Type头部属性指定请求体中的数据的格式,这样接收器可以解析它转换成适当的格式。

三、媒体格式器

a) 媒体格式器的作用便是根据使用Accept和Content-Type属性，来序列化请求或响应数据，以便使Web API可以理解这些数据格式。

WebAPI内置了一些媒体类型格式器：

使用GlobalConfiguration.Configuration.Formatters可以取得MediaTypeFormatterCollection，这里包含所有这些格式器的集合。还可以Add\Remove格式器。

b) JsonMediaTypeFormatter内部使用第三方开源库Json.NET来执行序列化。模式按照PascalCase编写Json属性名，如果想使用camelCase格式，可以在WebApiConfig中配置：

 

另外，给Formatter集合添加BsonMediaTypeFormatter可以支持BSON（二进制的JSON）的格式化。

四、媒体过滤器

a)与MVC中的过滤器类似，提供AOP的能力，可用于日志记录、异常处理、性能测量、身份认证和授权等。过滤器都实现System.Web.Http.Filters.IFilter接口，可用于创建过滤器的重要接口和类有：

b)假如要创建日志记录类，可以使用Action方法过滤器，有两种方式，实现IActionFilter或者继承ActionFilterAttribute类。

​如果采用实现IActionFilter的方式，因为是要创建类似LogAttribute这样的特性，还需要继承Attribute类。然后实现IActionFilter.ExecuteActionFilterAsync方法。Trace.Wrieline默写写入了输出窗口。

如果采用继承ActionFilterAttribute的方式，可以重写OnActionExecuting、OnActionExecuted方法并记录日志。 

 

 

 

学习资料：www.yuanjiaocheng.net (猿教程) 作者：卿文刚