Web Api 2 (二) 之 Action Result
一个Web Api Controller 的Action可以返回如下的类型,针对不同的返回类型,Web Api使用不同的机制来创建 HTTP response
-
void
返回Http状态值204(Not Content) -
HttpResponseMessage
直接转换为response message返回 -
IHttpActionResult
调用IHttpActionResult的ExecuteAsync方法创建HttpResponseMessage,然后将其转换为Http response message 后返回 -
其它类型(如IEnumerable <T>)
将返回内容序列化后写入响应体(response body),同时返回Http 状态值200(OK)
#### HttpResponseMessage
使用HttpResponseMessage可以对响应信息(response message)进行更多的控制(可以对响应头部中的字段进行定制),例如,下面的例子设置Cache-Control 头部:
public HttpResponseMessage Get()
{
HttpResponseMessage response = Request.CreateResponse(HttpStatusCode.OK, "hello,world");
response.Content = new StringContent("This is a test");
response.Headers.CacheControl = new System.Net.Http.Headers.CacheControlHeaderValue
{
MaxAge = TimeSpan.FromMinutes(10)
};
return response;
}
在浏览器中通过F12可以查看到设置的信息:Cache-Control:max-age = 600.
设置响应头信息,让浏览器提示文件(这里设置的是图片)下载而不是直接打开:
public HttpResponseMessage GetImg()
{
using (Stream sr = new FileStream(file_path, FileMode.Open,FileAccess.Read))
{
byte[] buff = new byte[sr.Length];
int count = sr.Read(buff, 0, buff.Length);
HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
response.Content = new ByteArrayContent(buff);
response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("image/jpeg");//设置文件的Content-Type(MIME)
var content_disposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment");//设置Disposition-type为attachment(附件)
content_disposition.FileName = file_name;//设置文件的默认名称
response.Content.Headers.ContentDisposition = content_disposition;
return response;
}
}
#### IHttpActionResult
Web Api 2 中加入了IHttpActionResult,本质上定义了一个IHttpResponseMessage的工厂,使用IHttpActionResult有一下优点:
- 简化了Controller的单元测试
- 将创建Http Response的通用逻辑放入单独的类中
- 隐藏底层构建response的细节,使得Action的意图更加的清晰
IHttpActionResult 接口中只定义了一个ExecuteAsync,这个方法可以异步的创建HttpResponseMessage的实例。当一个Action返回一个IHttpActionResult时,Web Api会调用ExecuteAsync异步方法创建HttpResponseMessage实例,然后将创建好的实例转换为 HTTP response message.通常情况下,使用System.Web.Http.Results命名空间下预定义实现的IHttpActionResultResult已经足够了,如果预定的这些不足以实现应用的需求时,我们也可以定制IHttpActionResult.
其它返回类型
对于其它的返回类型,Web Api 使用Media Formater对返回类型进行序列化,然后将序列化的结果写入响应体中,并返回状态码200.
此时,你不能直接的返回一个HTTP状态码(如404),但是你可以抛出一个HttpResponseException类型的异常
public Product GetProduct(int Id){
Product item = responsitory.Get(id);
if(item == null){
throw new HttpResponseException(HttpStatusCode.NotFound);
}
return item;
}
这里有一点要说明的是,HttpResponseException并不能适应所有的场合,必要时可以使用**exception filter**来自定义Web Api的异常处理机制,当控制器(Controller)中的方法抛出任何非***HttpResponseException***的异常时Exception Filter会被执行.
自定义Exception Filter需要实现定System.Web.Filters.IExceptionFilter
接口 ,一个更简单的办法是继承System.Web.Http.Filters.ExceptionFilterAttribute
,然后重写它的OnException( HttpActionExecutedContext context)
方法。然后将可以像使用普通的特性(Attribute)一样的使用Exception Filter,可以在Action、Controller、全局三个层次上来注册Exception Filter。