Spring请求响应Header以及参数绑定

---

一、Header

- Request Header

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: 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代码，参数为服务器先前发送的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

- Response Header

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

二、Content-Type参数

在Http协议消息头中，使用Content-Type来表示具体请求中的媒体类型信息。

常见的媒体格式类型：

• 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 ： 需要在表单中进行文件上传时，就需要使用该格式

三、RequestMapping映射注解

    @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进行过滤和判断。

举例：

    @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);    
    }    

四、参数绑定

- 注解方式绑定参数

注解	参数位置	具体内容
PathVariable	url	url中的占位符参数
RequestParam	url body	url中QueryString部分参数 body中application/x-www-form-urlencoded或multipart/form-data编码方式的参数
RequestPart	body	multipart/form-data编码方式的参数
RequestBody	body	application/json, application/xml等编码方式的参数
RequestHeader	header	header中的参数
CookieValue	cookie	header中cookie部分的参数
SessionAttributes	session	注解只用作用在类上，作用是将指定的 Model 的键值对保存在 session 中。可以让其他请求共用 session 中的键值对
ModelAttribute	model	用于方法上时： 通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model； 用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于： 1.@SessionAttributes 启用的attribute 对象上； 2.@ModelAttribute 用于方法上时指定的model对象； 3.上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中

- 非注解的绑定参数

@Data
public class UserInfo {

    @ApiModelProperty(value = "用户ID")
    @NotNull(message = "用户ID不能为空")
    private Long id;

    @ApiModelProperty(value = "用户名称")
    @NotBlank(message = "用户名称不能为空")
    private String username;
}

下面几种类型，能自动将对应参数（根据参数名称）绑定到简单（或复杂）对象上：

1. url中的占位符参数

       @GetMapping("/test/{id}/{username}")
       public String test(UserInfo userInfo){
           return "test";
       }
   

   

2. url中QueryString部分参数

       @GetMapping("/test")
       public String test(@Validated UserInfo userInfo){
           return "test";
       }
   

   

3. application/x-www-form-urlencoded方式编码的参数

       @PostMapping("/test")
       public String test(@Validated UserInfo userInfo){
           return "test";
       }
   

   

4. multipart/form-data方式编码的参数

       @PostMapping("/test")
       public String test(@Validated UserInfo userInfo, MultipartFile file){
           return "test";
       }
   

   

无注解的情况能自动将上面4中类型的参数绑定到一个简单（或复杂）对象上。

五、特别注意事项

1. GET理论上市可以往请求体(body)设置参数的，但不建议使用。

   其实在一般的情况下，GET请求是不可以用@RequestBody等来接收参数的。

   这里的一般情况指的是请求由浏览器发出，我们都知道，Http请求包含请求头和请求体，如果发出的请求中请求体为空，那么使用@RequestBody注解来获取参数肯定是徒劳的，所以在这种情况下，GET与@ReqestBody配合使用是有问题的。

   那么在什么情况下可以配合使用呢？需要两个条件：一是请求方式为GET，二是请求参数写入请求体中。例如：

   1. 像Postman这样的测试工具就可以实现GET请求往请求体写入参数。
   2. 由于目前微服务的运用越来越多，接口时常需要被上层的服务调用而非页面直接访问。所以一般像这样的情况在实际的开发中会变得常见。

2. 请求体的默认编码方式为application/x-www-form-urlencoded

3. multipart/form-data与x-www-form-urlencoded区别

   1. multipart/form-data：既可以上传文件等二进制数据，也可以上传表单键值对，只是最后会转化为一条信息；
   2. x-www-form-urlencoded：只能上传键值对，并且键值对都是间隔分开的。

六、Postman中body各种方式的区别

1、form-data

对应http请求中的multipart/form-data,它会将表单的数据处理为一条消息，以标签为单元，用分隔符分开。既可以上传键值对，也可以上传文件。

当上传的字段是文件时，会有Content-Type来表名文件类型；content-disposition，用来说明字段的一些信息；

由于有boundary隔离，所以multipart/form-data既可以上传文件，也可以上传键值对，它采用了键值对的方式，所以可以上传多个文件。

2、x-www-form-urlencoded

对应http请求中的application/x-www-from-urlencoded,会将表单内的数据转换为键值对。

3、raw

可以上传任意格式的文本，可以上传text、json、xml、html等。

4、binary

对应http请求中的application/octet-stream,从字面意思得知，只可以上传二进制数据，通常用来上传文件，由于没有键值，所以，一次只能上传一个文件。