引言: 在Http請求中染簇,我們每天都在使用Content-type來指定不同格式的請求信息,但是卻很少有人去全面了解content-type中允許的值有多少进苍,這里將講解Content-Type的可用值充尉,以及在Spring MVC中如何使用它們來映射請求信息锤悄。
1.? Content-Type
MediaType,即是Internet Media Type翎苫,互聯(lián)網媒體類型权埠;也叫做MIME類型,在Http協(xié)議消息頭中煎谍,使用Content-Type來表示具體請求中的媒體類型信息攘蔽。
[html]view plaincopy
類型格式:type/subtype(;parameter)??type
主類型,任意的字符串呐粘,如text秩彤,如果是*號代表所有;
subtype?子類型事哭,任意的字符串漫雷,如html,如果是*號代表所有鳍咱;
parameter?可選降盹,一些參數(shù),如Accept請求頭的q參數(shù)谤辜,?Content-Type的?charset參數(shù)蓄坏。
例如: 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數(shù)據(jù)格式
application/atom+xml? :Atom XML聚合格式
application/json??? : JSON數(shù)據(jù)格式
application/pdf?????? :pdf格式
application/msword? : Word文檔格式
application/octet-stream : 二進制流數(shù)據(jù)(如常見的文件下載)
application/x-www-form-urlencoded : 中默認的encType,form表單數(shù)據(jù)被編碼為key/value格式發(fā)送到服務器(表單默認的提交數(shù)據(jù)的格式)
另外一種常見的媒體格式是上傳文件之時使用的:
multipart/form-data : 需要在表單中進行文件上傳時丑念,就需要使用該格式
以上就是我們在日常的開發(fā)中涡戳,經常會用到的若干content-type的內容格式。
2.?? Spring MVC中關于關于Content-Type類型信息的使用
首先我們來看看RequestMapping中的Class定義:
[html]view plaincopy
@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中必須包含某些參數(shù)值是尼夺,才讓該方法處理
headers: 指定request中必須包含某些指定的header值,才能讓該方法處理請求
其中炒瘸,consumes淤堵, produces使用content-typ信息進行過濾信息;headers中可以使用content-type進行過濾和判斷顷扩。
3. 使用示例
3.1 headers
[html]view plaincopy
@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里面可以出現(xiàn)的信息粘勒,不局限在Referer信息。
示例2
[html]view plaincopy
@RequestMapping(value="/response/ContentType",headers="Accept=application/json")
public?void?response2(HttpServletResponse?response)?throws?IOException?{
//表示響應的內容區(qū)數(shù)據(jù)的媒體類型為json格式屎即,且編碼為utf-8(客戶端應該以utf-8解碼)
response.setContentType("application/json;charset=utf-8");
//寫出響應體內容
StringjsonData=?"{\"username\":\"zhang\",?\"password\":\"123\"}";
response.getWriter().write(jsonData);
}
服務器根據(jù)請求頭“Accept=application/json”生產json數(shù)據(jù)庙睡。
當你有如下Accept頭,將遵守如下規(guī)則進行應用:
①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
參數(shù)為媒體類型的質量因子技俐,越大則優(yōu)先權越高(從0到1)
③Accept:*/*,text/*,text/html
將按照如下順序進行produces的匹配 ①text/html ②text/* ③*/*
即匹配規(guī)則為:最明確的優(yōu)先匹配乘陪。
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
AuthorizationHTTP授權的授權證書Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Cache-Control指定請求和響應遵循的緩存機制Cache-Control: no-cache
Connection表示是否需要持久連接啡邑。(HTTP 1.1默認進行持久連接)Connection: close
CookieHTTP請求發(fā)送時,會把保存在該請求域名下的所有cookie值一起發(fā)送給web服務器井赌。Cookie: $Version=1; Skin=new;
Content-Length請求的內容長度Content-Length: 348
Content-Type請求的與實體對應的MIME信息Content-Type: application/x-www-form-urlencoded
Date請求發(fā)送的日期和時間Date: Tue, 15 Nov?2010 08:12:31 GMT
Expect請求的特定的服務器行為Expect: 100-continue
From發(fā)出請求的用戶的EmailFrom: user@email.com
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代碼,參數(shù)為服務器先前發(fā)送的Etag仇穗,與服務器回應的Etag比較判斷是否改變If-None-Match: “737060cd8c284d8af7ad3082f209582d”
If-Range如果實體未改變流部,服務器發(fā)送客戶端丟失的部分,否則發(fā)送整個實體纹坐。參數(shù)也為EtagIf-Range: “737060cd8c284d8af7ad3082f209582d”
If-Unmodified-Since只在實體在指定時間之后未被修改才請求成功If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMT
Max-Forwards限制信息通過代理和網關傳送的時間Max-Forwards: 10
Pragma用來包含實現(xiàn)特定的指令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向服務器指定某種傳輸協(xié)議以便服務器進行轉換(如果支持)Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11
User-AgentUser-Agent的內容包含發(fā)出請求的用戶信息User-Agent: Mozilla/5.0 (Linux; X11)
Via通知中間網關或代理服務器地址果漾,通信協(xié)議Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)
Warning關于消息實體的警告信息Warn: 199 Miscellaneous warning
Header解釋示例
Accept-Ranges表明服務器是否支持指定范圍請求及哪種類型的分段請求Accept-Ranges: bytes
Age從原始服務器到代理緩存形成的估算時間(以秒計,非負)Age: 12
Allow對某網絡資源的有效的請求行為谷誓,不允許則返回405Allow: GET, HEAD
Cache-Control告訴所有的緩存機制是否可以緩存及哪種類型Cache-Control: no-cache
Content-Encodingweb服務器支持的返回內容壓縮編碼類型绒障。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在整個返回體中本部分的字節(jié)位置Content-Range: bytes 21010-47021/47022
Content-Type返回內容的MIME類型Content-Type: text/html; charset=utf-8
Date原始服務器消息發(fā)出的時間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包括實現(xiàn)特定的指令,它可應用到響應鏈上的任何接收方Pragma: no-cache
Proxy-Authenticate它指出認證方案和可應用到代理的該URL上的參數(shù)Proxy-Authenticate: Basic
refresh應用于重定向或一個新的資源被創(chuàng)造捍歪,在5秒之后重定向(由網景提出户辱,被大部分瀏覽器支持)Refresh: 5; url=
http://www.zcmhi.com/archives/94.html
Retry-After如果實體暫時不可取鸵钝,通知客戶端在指定時間之后再次嘗試Retry-After: 120
Serverweb服務器軟件名稱Server: Apache/1.3.27 (Unix) (Red-Hat/Linux)
Set-Cookie設置Http CookieSet-Cookie: UserID=JohnDoe; Max-Age=3600; Version=1
Trailer指出頭域在分塊傳輸編碼的尾部存在Trailer: Max-Forwards
Transfer-Encoding文件傳輸編碼Transfer-Encoding:chunked
Vary告訴下游代理是使用緩存響應還是從原始服務器請求Vary: *
Via告知代理客戶端響應是通過哪里發(fā)送的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 plaincopy
@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 plaincopy
@Controller
@RequestMapping(value="/users",method=RequestMethod.POST,consumes="application/json",produces="application/json")
@ResponseBody
public?ListaddUser(@RequestBody?User?userl)?{
//?implementation?omitted
return?Listusers;
}
方法僅處理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