在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: <form encType=””>中默认的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的候选属性

候选属性 说明 示例
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 QWxhZLRpbjpvcGVuIHNoc2FtZQ==
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 2018 08:22:31 GMT
Expect 请求的特定的服务器行为 Expect: 100-continue
From 发出请求的用户的Email From: user@email.com
Host 指定请求的服务器的域名和端口号 Host: www.yanggb.com
If-Match 只有请求内容与实体相匹配才有效 If-Match: "737060ff8c284d8af7ad2082f209582d"
If-Modified-Since 如果请求的部分在指定时间之后被修改则请求成功,未被修改则返回304代码 If-Modified-Since: Sat, 29 Oct 2018 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 2018 19:23:11 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.yanggb.com/yanggb1.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

可以看到,Content-Type是Request Headers中的一个候选属性。

Response Headers的候选属性

候选属性 说明 示例
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 2018 08:22:22 GMT
ETag 请求变量的实体标签的当前值 ETag: "737060cd8c284d8af7ad3082f209582d"
Expires 响应过期的日期和时间 Expires: Thu, 01 Dec 2018 16:00:00 GMT
Last-Modified 请求资源的最后修改时间 Last-Modified: Tue, 15 Nov 2018 12:25:26 GMT
Location 用来重定向接收方到非请求URL的位置来完成请求或标识新的资源 Location: http://www.yanggb.com/yanggb2.html
Pragma 包括实现特定的指令,它可应用到响应链上的任何接收方 Pragma: no-cache
Proxy-Authenticate 它指出认证方案和可应用到代理的该URL上的参数 Proxy-Authenticate: Basic
refresh 应用于重定向或一个新的资源被创造,在5秒之后重定向(由网景提出,被大部分浏览器支持)
Refresh: 5; url=
http://www.yanggb.com/yanggb9.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

具体使用示例

这里通过几个具体的实例来了解怎么在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】。

 

"你是有多不会表达喜欢,才会一直说不知道。"

你要去做一个大人,不要回头,不要难过。