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

一、Header

- Request Header

- Response Header

二、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);    
    }    

四、参数绑定

- 注解方式绑定参数

- 非注解的绑定参数

@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,从字面意思得知，只可以上传二进制数据，通常用来上传文件，由于没有键值，所以，一次只能上传一个文件。