注解 之 @RequestBody 学习整理

项目中最常用的接收参数的注解，往常只是会用，用的还不是很熟练，也不知道它具体是如何接收参数的，趁闲着，正好整理一下。

1 简介

@RequestBody 注解则是将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象；

2 作用

1) 该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上； 

2) 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

3 使用方式
使用@RequestBody注解时，要注意两个地方：1）请求头中的content-type; 2) 请求方式。

1) GET,POST请求方式，需要判断content-type是何种数据类型

a. content-type : multipart/form-data 
    这种格式使用@RequestBody处理不了。
b. content-type : application/x-www-form-urlencoded 
    form表单形式提交的数据格式，可以使用@RequestBody，也可以使用其他注解例如@RequestParam, @ModelAttribute进行接收。
c. content-type : 其他数据格式 
    必须使用@RequestBody进行接收。

2) PUT请求方式，需要判断content-type是何种数据类型

a. content-type : application/x-www-form-urlencoded 
必须使用@RequestBody
b. content-type : multipart/form-data 
@RequestBody处理不了
c. content-type : 其他数据格式 
必须使用@RequestBody进行接收。

备注：
content-type相关知识点参考博客：
https://blog.csdn.net/danielzhou888/article/details/72861097

4 使用案例

1）接收参数直接转换为对象，字段名称，字段类型，数据格式一定要对应上，否则会出现400等错误。

@RequestMapping(value = "user/login")
@ResponseBody
public User login(@RequestBody User user) {   
    return user;    
}

2）接收参数直接使用String接收，发送的请求参数格式要根据content-type进行传递

/**
* 单个参数
*/
@RequestMapping(value = "user/getUser")
@ResponseBody
public User getUser(@RequestBody String userId) {   
    User user = userRepository.findOne(userId);
    return user;    
}

/**
* 参数为json字符串
*/
@RequestMapping(value = "user/getUser")
@ResponseBody
public User getUser(@RequestBody String json) {   
    JSONObject obj = JSON.parseObject(json);
    User user = userRepository.findOne(json.getString("userId"));
    return user;    
}

/**
* 多个参数
*/
@RequestMapping(value = "user/getUser")
@ResponseBody
public User getUser1(@RequestBody List ids) {   
    User user = new User();
    for(ids : userId){
        User user = userRepository.findOne(userId);
    }
    return user;    
}

@RequestMapping(value = "user/getUser")
@ResponseBody
public User getUser2(@RequestBody Map<String,Object> map) {   
    User user = new User();
    for(ids : userId){
        User user = userRepository.findOne(map.get("userId"));
    }
    return user;    
}

HttpMessageConverter
1、HttpMessageConverter信息
HttpMessageConverter 是 Spring3.0 新添加的一个接口，负责将请求信息转换为一个对象（类型为 T），将对象（类型为 T）输出为响应信息

　　　　

2、HttpMessageConverter 运行原理

（1）HttpInputMessage 将请求的信息先转为 InputStream 对象，InputStream 再由 HttpMessageConverter 转换为 SpringMVC 需要的java对象；

（2）SpringMVC 返回一个 java 对象， 并通过 HttpMessageConverter 转为响应信息，接着 HttpOutputMessage 将响应的信息转换为 OutputStream，接着给出响应。

3、 HttpMessageConveter 的实现类

ByteArrayHttpMessageConverter: 负责读取二进制格式的数据和写出二进制格式的数据；  
StringHttpMessageConverter：   负责读取字符串格式的数据和写出二进制格式的数据；  
ResourceHttpMessageConverter：负责读取资源文件和写出资源文件数据；   
FormHttpMessageConverter：       负责读取form提交的数据（能读取的数据格式为 application/x-www-form-urlencoded，不能读取multipart/form-data格式数据）；负责写入application/x-www-from-urlencoded和multipart/form-data格式的数据；  
MappingJacksonHttpMessageConverter:  负责读取和写入json格式的数据；  
SouceHttpMessageConverter：                   负责读取和写入 xml 中javax.xml.transform.Source定义的数据；  
Jaxb2RootElementHttpMessageConverter:  负责读取和写入xml 标签格式的数据；  
AtomFeedHttpMessageConverter:              负责读取和写入Atom格式的数据；  
RssChannelHttpMessageConverter:           负责读取和写入RSS格式的数据；  

当使用@RequestBody和@ResponseBody注解时,RequestMappingHandlerAdapter就使用它们来进行读取或者写入相应格式的数据;
@RequestBody注解时： 根据Request对象header部分的Content-Type类型，逐一匹配合适的HttpMessageConverter来读取数据.
@ResponseBody注解时： 根据Request对象header部分的Accept属性（逗号分隔），逐一按accept中的类型，去遍历找到能处理的HttpMessageConverter；

补充：
MappingJacksonHttpMessageConverter调用了objectMapper.writeValue(OutputStream stream,Object)方法，使用@ResponseBody注解返回的对象就传入Object参数内。若返回的对象为已经格式化好的json串时，不使用@RequestBody注解，而应该这样处理：
1、response.setContentType(“application/json; charset=UTF-8”);
2、response.getWriter().print(jsonStr); 直接输出到body区，然后视图为void。

4、 SpringMVC 默认加载的 HttpMessageConverter 实现类
（1）DispatcherServlet 默认加载 HttpMessageConveter 的6个实现类，如下所示：

（2）加入 jackson jar包后，启动的时候加载 7个 HttpMessageConverter 的实现类，如下所示:

5、使用 HttpMessageConverter

（1） @ResponseBody 和 @RequestBody 示例：

（2） HttpEntity 和 ResponseEntity 示例

参考博客：
http://www.cnblogs.com/qq78292959/p/3760651.html
https://www.cnblogs.com/yufeng218/p/6623329.html