引言: 在Http請求中,我們每天都在使用Content-type來指定不同格式的請求信息,但是卻很少有人去全面了解content-type中允許的值有多少,這里將講解Content-Type的可用值,以及在spring MVC中如何使用它們來映射請求信息。
1. Content-Type
MediaType,即是Internet Media Type,互聯網媒體類型;也叫做MIME類型,在Http協議消息頭中,使用Content-Type來表示具體請求中的媒體類型信息。
類型格式:type/subtype(;parameter)? type 主類型,任意的字符串,如text,如果是*號代表所有; subtype 子類型,任意的字符串,如html,如果是*號代表所有; parameter 可選,一些參數,如Accept請求頭的q參數, Content-Type的 charset參數。
例如: Content-Type: text/html;charset:utf-8;
常見的媒體格式類型如下:
- text/html : HTML格式
- text/plain :純文本格式
- text/xml : XML格式
- image/gif :gif圖片格式
- image/jpeg :jpg圖片格式
- image/png:png圖片格式
以application開頭的媒體格式類型:
- application/xhtml+xml :XHTML格式
- application/xml : XML數據格式
- application/atom+xml :Atom XML聚合格式
- application/json : JSON數據格式
- application/pdf :pdf格式
- application/msword : Word文檔格式
- application/octet-stream : 二進制流數據(如常見的文件下載)
- application/x-www-form-urlencoded : <form encType=””>中默認的encType,form表單數據被編碼為key/value格式發送到服務器(表單默認的提交數據的格式)
另外一種常見的媒體格式是上傳文件之時使用的:
multipart/form-data : 需要在表單中進行文件上傳時,就需要使用該格式
以上就是我們在日常的開發中,經常會用到的若干content-type的內容格式。
2. Spring MVC中關於關於Content-Type類型信息的使用
首先我們來看看RequestMapping中的Class定義:
@Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Mapping public @interface RequestMapping { String[] value() default {}; RequestMethod[] method() default {}; String[] params() default {}; String[] headers() default {}; String[] consumes() default {}; String[] produces() default {}; }
value: 指定請求的實際地址, 比如 /action/info之類。
method: 指定請求的method類型, GET、POST、PUT、DELETE等
consumes: 指定處理請求的提交內容類型(Content-Type),例如application/json, text/html;
produces: 指定返回的內容類型,僅當request請求頭中的(Accept)類型中包含該指定類型才返回
params: 指定request中必須包含某些參數值是,才讓該方法處理
headers: 指定request中必須包含某些指定的header值,才能讓該方法處理請求
其中,consumes, produces使用content-typ信息進行過濾信息;headers中可以使用content-type進行過濾和判斷。
3. 使用示例
3.1 headers
@RequestMapping(value = "/test", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/") public void testHeaders(@PathVariable String ownerId, @PathVariable String petId) { // implementation omitted }
這里的Headers里面可以匹配所有Header里面可以出現的信息,不局限在Referer信息。
示例2
@RequestMapping(value = "/response/ContentType", headers = "Accept=application/json") public void response2(HttpServletResponse response) throws IOException { //表示響應的內容區數據的媒體類型為json格式,且編碼為utf-8(客戶端應該以utf-8解碼) response.setContentType("application/json;charset=utf-8"); //寫出響應體內容 String jsonData = "{\"username\":\"zhang\", \"password\":\"123\"}"; response.getWriter().write(jsonData); }
服務器根據請求頭“Accept=application/json”生產json數據。
當你有如下Accept頭,將遵守如下規則進行應用:
①Accept:text/html,application/xml,application/json
將按照如下順序進行produces的匹配 ①text/html ②application/xml ③application/json
②Accept:application/xml;q=0.5,application/json;q=0.9,text/html
將按照如下順序進行produces的匹配 ①text/html ②application/json ③application/xml
參數為媒體類型的質量因子,越大則優先權越高(從0到1)
③Accept:*/*,text/*,text/html
將按照如下順序進行produces的匹配 ①text/html ②text/* ③*/*
即匹配規則為:最明確的優先匹配。
3.2 params的示例
@RequestMapping(value = "/test/{userId}", method = RequestMethod.GET, params="myParam=myValue") public void findUser(@PathVariable String userId) { // implementation omitted }
僅處理請求中包含了名為“myParam”,值為“myValue”的請求,起到了一個過濾的作用。
3.3 consumes/produces
@Controller @RequestMapping(value = "/users", method = RequestMethod.POST, consumes="application/json", produces="application/json") @ResponseBody public List<User> addUser(@RequestBody User userl) { // implementation omitted return List<User> users; }
方法僅處理request Content-Type為“application/json”類型的請求. produces標識==>處理request請求中Accept頭中包含了"application/json"的請求,同時暗示了返回的內容類型為application/json;
4. 總結
在本文中,首先介紹了Content-Type主要支持的格式內容,然后基於@RequestMapping標注的內容介紹了主要的使用方法,其中,headers, consumes,produces,都是使用Content-Type中使用的各種媒體格式內容,可以基於這個格式內容來進行訪問的控制和過濾。
參考資料:
1. HTTP中支持的Content-Type: http://tool.oschina.net/commons
2. Media Type介紹。 http://www.iteye.com/topic/1127120
————————————————
版權聲明:本文為CSDN博主「bladestone」的原創文章,遵循 CC 4.0 BY-SA 版權協議,轉載請附上原文出處鏈接及本聲明。
原文鏈接:https://blog.csdn.net/blueheart20/article/details/45174399