Http请求中Content-Type讲解以及在Spring MVC注解中produce和consumes配置详解

引言： 在Http请求中，我们每天都在使用Content-type来指定不同格式的请求信息，但是却很少有人去全面了解content-type中允许的值有多少，这里将讲解Content-Type的可用值，以及在spring MVC中如何使用它们来映射请求信息。

1.  Content-Type

  MediaType，即是Internet Media Type，互联网媒体类型；也叫做MIME类型，在Http协议消息头中，使用Content-Type来表示具体请求中的媒体类型信息。

[html] view plaincopy

1. 类型格式：type/subtype(;parameter)? type  
2. 主类型，任意的字符串，如text，如果是*号代表所有；   
3. subtype 子类型，任意的字符串，如html，如果是*号代表所有；   
4. 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 plaincopy

1. @Target({ElementType.METHOD, ElementType.TYPE})  
2. @Retention(RetentionPolicy.RUNTIME)  
3. @Documented  
4. @Mapping  
5. public @interface RequestMapping {  
6.       String[] value() default {};  
7.       RequestMethod[] method() default {};  
8.       String[] params() default {};  
9.       String[] headers() default {};  
10.       String[] consumes() default {};  
11.       String[] produces() default {};  
12. }  

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 plaincopy

1. @RequestMapping(value = "/test", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")    
2. public void testHeaders(@PathVariable String ownerId, @PathVariable String petId) {        
3.   // implementation omitted    
4. }   

  这里的Headers里面可以匹配所有Header里面可以出现的信息，不局限在Referer信息。

  示例2

[html] view plaincopy

1. @RequestMapping(value = "/response/ContentType", headers = "Accept=application/json")    
2. public void response2(HttpServletResponse response) throws IOException {    
3.     //表示响应的内容区数据的媒体类型为json格式，且编码为utf-8(客户端应该以utf-8解码)    
4.     response.setContentType("application/json;charset=utf-8");    
5.     //写出响应体内容    
6.     String jsonData = "{\"username\":\"zhang\", \"password\":\"123\"}";    
7.     response.getWriter().write(jsonData);    
8. }    

服务器根据请求头“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/htmlAccept-Charset浏览器可以接受的字符编码集。Accept-Charset: iso-8859-5Accept-Encoding指定浏览器可以支持的web服务器返回内容压缩编码类型。Accept-Encoding: compress, gzipAccept-Language浏览器可接受的语言Accept-Language: en,zhAccept-Ranges可以请求网页实体的一个或者多个子范围字段Accept-Ranges: bytesAuthorizationHTTP授权的授权证书Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==Cache-Control指定请求和响应遵循的缓存机制Cache-Control: no-cacheConnection表示是否需要持久连接。（HTTP 1.1默认进行持久连接）Connection: closeCookieHTTP请求发送时，会把保存在该请求域名下的所有cookie值一起发送给web服务器。Cookie: $Version=1; Skin=new;Content-Length请求的内容长度Content-Length: 348Content-Type请求的与实体对应的MIME信息Content-Type: application/x-www-form-urlencodedDate请求发送的日期和时间Date: Tue, 15 Nov 2010 08:12:31 GMTExpect请求的特定的服务器行为Expect: 100-continueFrom发出请求的用户的EmailFrom: [e-mail]指定请求的服务器的域名和端口号Host: www.zcmhi.comIf-Match只有请求内容与实体相匹配才有效If-Match: “737060cd8c284d8af7ad3082f209582d”If-Modified-Since如果请求的部分在指定时间之后被修改则请求成功，未被修改则返回304代码If-Modified-Since: Sat, 29 Oct 2010 19:43:31 GMTIf-None-Match如果内容未改变返回304代码，参数为服务器先前发送的Etag，与服务器回应的Etag比较判断是否改变If-None-Match: “737060cd8c284d8af7ad3082f209582d”If-Range如果实体未改变，服务器发送客户端丢失的部分，否则发送整个实体。参数也为EtagIf-Range: “737060cd8c284d8af7ad3082f209582d”If-Unmodified-Since只在实体在指定时间之后未被修改才请求成功If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMTMax-Forwards限制信息通过代理和网关传送的时间Max-Forwards: 10Pragma用来包含实现特定的指令Pragma: no-cacheProxy-Authorization连接到代理的授权证书Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==Range只请求实体的一部分，指定范围Range: bytes=500-999Referer先前网页的地址，当前请求网页紧随其后,即来路Referer: http://www.zcmhi.com/archives/71.htmlTE客户端愿意接受的传输编码，并通知服务器接受接受尾加头信息TE: trailers,deflate;q=0.5Upgrade向服务器指定某种传输协议以便服务器进行转换（如果支持）Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11User-AgentUser-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: bytesAge从原始服务器到代理缓存形成的估算时间（以秒计，非负）Age: 12Allow对某网络资源的有效的请求行为，不允许则返回405Allow: GET, HEADCache-Control告诉所有的缓存机制是否可以缓存及哪种类型Cache-Control: no-cacheContent-Encodingweb服务器支持的返回内容压缩编码类型。Content-Encoding: gzipContent-Language响应体的语言Content-Language: en,zhContent-Length响应体的长度Content-Length: 348Content-Location请求资源可替代的备用的另一地址Content-Location: /index.htmContent-MD5返回资源的MD5校验值Content-MD5: Q2hlY2sgSW50ZWdyaXR5IQ==Content-Range在整个返回体中本部分的字节位置Content-Range: bytes 21010-47021/47022Content-Type返回内容的MIME类型Content-Type: text/html; charset=utf-8Date原始服务器消息发出的时间Date: Tue, 15 Nov 2010 08:12:31 GMTETag请求变量的实体标签的当前值ETag: “737060cd8c284d8af7ad3082f209582d”Expires响应过期的日期和时间Expires: Thu, 01 Dec 2010 16:00:00 GMTLast-Modified请求资源的最后修改时间Last-Modified: Tue, 15 Nov 2010 12:45:26 GMTLocation用来重定向接收方到非请求URL的位置来完成请求或标识新的资源Location: http://www.zcmhi.com/archives/94.htmlPragma包括实现特定的指令，它可应用到响应链上的任何接收方Pragma: no-cacheProxy-Authenticate它指出认证方案和可应用到代理的该URL上的参数Proxy-Authenticate: Basicrefresh应用于重定向或一个新的资源被创造，在5秒之后重定向（由网景提出，被大部分浏览器支持）

 

 

Refresh: 5; url=

http://www.zcmhi.com/archives/94.html

Retry-After如果实体暂时不可取，通知客户端在指定时间之后再次尝试Retry-After: 120Serverweb服务器软件名称Server: Apache/1.3.27 (Unix) (Red-Hat/Linux)Set-Cookie设置Http CookieSet-Cookie: UserID=JohnDoe; Max-Age=3600; Version=1Trailer指出头域在分块传输编码的尾部存在Trailer: Max-ForwardsTransfer-Encoding文件传输编码Transfer-Encoding:chunkedVary告诉下游代理是使用缓存响应还是从原始服务器请求Vary: *Via告知代理客户端响应是通过哪里发送的Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)Warning警告实体可能存在的问题Warning: 199 Miscellaneous warningWWW-Authenticate表明客户端请求实体应该使用的授权方案WWW-Authenticate: Basic

3.2 params的示例

[html] view plaincopy

1. @RequestMapping(value = "/test/{userId}", method = RequestMethod.GET, params="myParam=myValue")    
2. public void findUser(@PathVariable String userId) {        
3.   // implementation omitted    
4. }    

  仅处理请求中包含了名为“myParam”，值为“myValue”的请求，起到了一个过滤的作用。

3.3 consumes/produces

[html] view plaincopy

1. @Controller    
2. @RequestMapping(value = "/users", method = RequestMethod.POST, consumes="application/json", produces="application/json")    
3. @ResponseBody  
4. public List<User> addUser(@RequestBody User userl) {        
5.     // implementation omitted    
6.     return List<User> users;  
7. }    

  方法仅处理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