在HTTP请求中,我们每天都在使用Content-Type来指定不同格式的请求信息,但是却很少有人去全面了解Content-Type中允许的值有多少,因此这里来了解一下Content-Type的可用值,以及在Spring MVC中如何使用它们来映射请求信息。
什么是Content-Type
要知道什么是Content-Type,首先要了解什么是Internet Media Type。Internet Media Type即互联网媒体类型,也叫做MIME类型,使用两部分标识符来确定一个类型。在HTTP协议消息头中,使用Content-Type来表示具体请求中的媒体类型信息,意思就是说,Content-Type是Internet Media Type在HTTP协议中的别称。
Content-Type的格式
type/subtype(;parameter)? type
上面是Content-Type的格式,可以拆解为三个部分,分别是主类型(type)、子类型(subtype)和参数(parameter)。
主类型(type)
主类型可以是任意的字符串,比如text。如果是*号则代表所有类型。
子类型(subtype)
子类型可以是任意的字符串,比如html。如果是*号则代表所有类型。
参数(parameter)
参数是可选的,可以在Content-Type中加入一些特殊的参数,比如Accept请求头的参数,常见的有用于设置字符编码的charset参数。
Content-Type: text/html;charset:utf-8;
Content-Type中常见的媒体格式类型
以text开头的媒体格式类型:
text/html: HTML格式。
text/plain:纯文本格式。
text/xml: XML格式。
以image开头的媒体格式类型:
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: 中默认的encType,form表单数据被编码为key/value格式发送到服务器(表单默认的提交数据的格式)。
另外还有一种常见的媒体格式是上传文件之时使用的:
multipart/form-data : 需要在表单中进行文件上传时,就需要使用该格式。
以上就是我们在日常的开发中,经常会用到的若干Content-Type的内容格式。
Spring MVC中关于Content-Type类型信息的使用
在Spring MVC中,主要就是使用@RequestMapping注解来处理请求,因此首先我们来看看@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:指定请求的实际地址, 比如/yanggb/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-type中的信息对不需要的信息进行过滤,仅接受需要的数据;headers则可以使用Content-Type中的信息对请求进行过滤和判断。
Request Headers和Response Headers中的候选属性
这里列举出Request Headers(请求头)和Response Headers(响应头)中的候选属性。
Request Headers的候选属性
可以看到,Content-Type是Request Headers中的一个候选属性。
Response Headers的候选属性
具体使用示例
这里通过几个具体的实例来了解怎么在Spring MVC中使用两个Headers中的信息。
示例1:headers属性取Request Headers中的Referer属性。
@RequestMapping(value = "/yanggb2", method = RequestMethod.GET, headers="Referer=http://www.yanggb.com/yanggb1")
public void yanggb2() {
// 如果上一个页面的地址不是上面headers属性中Referer指定的地址,不会执行此方法
}
这里的headers里面可以匹配所有Headers里面可以出现的信息,不局限于Referer信息。
示例2:headers属性取Request Headers中的Accept属性。
@RequestMapping(value = "/yanggb2", headers = "Accept=application/json")
public void yanggb3(HttpServletResponse response) throws IOException {
// 表示响应的内容区数据的媒体类型为json格式,且编码为utf-8(客户端应该以utf-8解码)
response.setContentType("application/json;charset=utf-8");
// 写出响应体内容
String jsonData = "{\"username\":\"yanggb\",\"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:params属性取参数。
@RequestMapping(value = "/yanggb/{userId}", method = RequestMethod.GET, params = "yanggb1=yanggb2")
public void findUser(@PathVariable String userId) {
// 当请求中包含参数yanggb1时才会执行此方法
}
在上面的代码中,就起到了一个过滤的作用。
实例4:consumes/produces属性过滤请求。
@Controller
@RequestMapping(value = "/users", method = RequestMethod.POST, consumes="application/json", produces = "application/json")
@ResponseBody
public List<User> addUser(@RequestBody User userl) {
return List<User> users;
}
上面这个方法仅处理请求Content-Type为【application/json】类型的请求,produces标识处理请求中Accept头中包含了【application/json】的请求,同时暗示了返回的内容类型为【application/json】。