servlet九大內建物件之response 的contentType 幾種型別
引言: 在Http請求中,我們每天都在使用Content-type來指定不同格式的請求資訊,但是卻很少有人去全面瞭解content-type中允許的值有多少,這裡將講解Content-Type的可用值,以及在spring MVC中如何使用它們來對映請求資訊。
1. Content-Type
MediaType,即是Internet Media Type,網際網路媒體型別;也叫做MIME型別,在Http協議訊息頭中,使用Content-Type來表示具體請求中的媒體型別資訊。
[html] view plain copy
- 型別格式: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定義:
[html] view plain copy
- @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
[html] view plain copy
- @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
[html] view plain copy
- @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/* ③*/*
即匹配規則為:最明確的優先匹配。
Requests部分
Header | 解釋 | 示例 |
---|---|---|
Accept | 指定客戶端能夠接收的內容型別 | Accept: text/plain, text/html |
Accept-Charset | 瀏覽器可以接受的字元編碼集。 | Accept-Charset: iso-8859-5 |
Accept-Encoding | 指定瀏覽器可以支援的web伺服器返回內容壓縮編碼型別。 | Accept-Encoding: compress, gzip |
Accept-Language | 瀏覽器可接受的語言 | Accept-Language: en,zh |
Accept-Ranges | 可以請求網頁實體的一個或者多個子範圍欄位 | Accept-Ranges: bytes |
Authorization | HTTP授權的授權證書 | Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
Cache-Control | 指定請求和響應遵循的快取機制 | Cache-Control: no-cache |
Connection | 表示是否需要持久連線。(HTTP 1.1預設進行持久連線) | Connection: close |
Cookie | HTTP請求傳送時,會把儲存在該請求域名下的所有cookie值一起傳送給web伺服器。 | Cookie: $Version=1; Skin=new; |
Content-Length | 請求的內容長度 | Content-Length: 348 |
Content-Type | 請求的與實體對應的MIME資訊 | Content-Type: application/x-www-form-urlencoded |
Date | 請求傳送的日期和時間 | Date: Tue, 15 Nov 2010 08:12:31 GMT |
Expect | 請求的特定的伺服器行為 | Expect: 100-continue |
From | 發出請求的使用者的Email | From: [email protected] |
Host | 指定請求的伺服器的域名和埠號 | Host: www.zcmhi.com |
If-Match | 只有請求內容與實體相匹配才有效 | If-Match: “737060cd8c284d8af7ad3082f209582d” |
If-Modified-Since | 如果請求的部分在指定時間之後被修改則請求成功,未被修改則返回304程式碼 | If-Modified-Since: Sat, 29 Oct 2010 19:43:31 GMT |
If-None-Match | 如果內容未改變返回304程式碼,引數為伺服器先前傳送的Etag,與伺服器迴應的Etag比較判斷是否改變 | If-None-Match: “737060cd8c284d8af7ad3082f209582d” |
If-Range | 如果實體未改變,伺服器傳送客戶端丟失的部分,否則傳送整個實體。引數也為Etag | If-Range: “737060cd8c284d8af7ad3082f209582d” |
If-Unmodified-Since | 只在實體在指定時間之後未被修改才請求成功 | If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMT |
Max-Forwards | 限制資訊通過代理和閘道器傳送的時間 | Max-Forwards: 10 |
Pragma | 用來包含實現特定的指令 | Pragma: no-cache |
Proxy-Authorization | 連線到代理的授權證書 | Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
Range | 只請求實體的一部分,指定範圍 | Range: bytes=500-999 |
Referer | 先前網頁的地址,當前請求網頁緊隨其後,即來路 | Referer: http://www.zcmhi.com/archives/71.html |
TE | 客戶端願意接受的傳輸編碼,並通知伺服器接受接受尾加頭資訊 | TE: trailers,deflate;q=0.5 |
Upgrade | 向伺服器指定某種傳輸協議以便伺服器進行轉換(如果支援) | Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11 |
User-Agent | User-Agent的內容包含發出請求的使用者資訊 | User-Agent: Mozilla/5.0 (Linux; X11) |
Via | 通知中間閘道器或代理伺服器地址,通訊協議 | Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1) |
Warning | 關於訊息實體的警告資訊 | Warn: 199 Miscellaneous warning |
Responses 部分
Header | 解釋 | 示例 |
---|---|---|
Accept-Ranges | 表明伺服器是否支援指定範圍請求及哪種型別的分段請求 | Accept-Ranges: bytes |
Age | 從原始伺服器到代理快取形成的估算時間(以秒計,非負) | Age: 12 |
Allow | 對某網路資源的有效的請求行為,不允許則返回405 | Allow: GET, HEAD |
Cache-Control | 告訴所有的快取機制是否可以快取及哪種型別 | Cache-Control: no-cache |
Content-Encoding | web伺服器支援的返回內容壓縮編碼型別。 | Content-Encoding: gzip |
Content-Language | 響應體的語言 | Content-Language: en,zh |
Content-Length | 響應體的長度 | Content-Length: 348 |
Content-Location | 請求資源可替代的備用的另一地址 | Content-Location: /index.htm |
Content-MD5 | 返回資源的MD5校驗值 | Content-MD5: Q2hlY2sgSW50ZWdyaXR5IQ== |
Content-Range | 在整個返回體中本部分的位元組位置 | Content-Range: bytes 21010-47021/47022 |
Content-Type | 返回內容的MIME型別 | Content-Type: text/html; charset=utf-8 |
Date | 原始伺服器訊息發出的時間 | Date: Tue, 15 Nov 2010 08:12:31 GMT |
ETag | 請求變數的實體標籤的當前值 | ETag: “737060cd8c284d8af7ad3082f209582d” |
Expires | 響應過期的日期和時間 | Expires: Thu, 01 Dec 2010 16:00:00 GMT |
Last-Modified | 請求資源的最後修改時間 | Last-Modified: Tue, 15 Nov 2010 12:45:26 GMT |
Location | 用來重定向接收方到非請求URL的位置來完成請求或標識新的資源 | Location: http://www.zcmhi.com/archives/94.html |
Pragma | 包括實現特定的指令,它可應用到響應鏈上的任何接收方 | Pragma: no-cache |
Proxy-Authenticate | 它指出認證方案和可應用到代理的該URL上的引數 | Proxy-Authenticate: Basic |
refresh | 應用於重定向或一個新的資源被創造,在5秒之後重定向(由網景提出,被大部分瀏覽器支援) |
Refresh: 5; url= http://www.zcmhi.com/archives/94.html |
Retry-After | 如果實體暫時不可取,通知客戶端在指定時間之後再次嘗試 | Retry-After: 120 |
Server | web伺服器軟體名稱 | Server: Apache/1.3.27 (Unix) (Red-Hat/Linux) |
Set-Cookie | 設定Http Cookie | Set-Cookie: UserID=JohnDoe; Max-Age=3600; Version=1 |
Trailer | 指出頭域在分塊傳輸編碼的尾部存在 | Trailer: Max-Forwards |
Transfer-Encoding | 檔案傳輸編碼 | Transfer-Encoding:chunked |
Vary | 告訴下游代理是使用快取響應還是從原始伺服器請求 | Vary: * |
Via | 告知代理客戶端響應是通過哪裡傳送的 | Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1) |
Warning | 警告實體可能存在的問題 | Warning: 199 Miscellaneous warning |
WWW-Authenticate | 表明客戶端請求實體應該使用的授權方案 | WWW-Authenticate: Basic |
3.2 params的示例
[html] view plain copy
- @RequestMapping(value = "/test/{userId}", method = RequestMethod.GET, params="myParam=myValue")
- public void findUser(@PathVariable String userId) {
- // implementation omitted
- }
僅處理請求中包含了名為“myParam”,值為“myValue”的請求,起到了一個過濾的作用。
3.3 consumes/produces
[html] view plain copy
- @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中使用的各種媒體格式內容,可以基於這個格式內容來進行訪問的控制和過濾。
轉載於:
https://blog.csdn.net/blueheart20/article/details/45174399
參考資料:
1. HTTP中支援的Content-Type: http://tool.oschina.NET/commons
2. Media Type介紹。 http://www.iteye.com/topic/1127120