一個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。