SpringMVC 请求数据封装转换

简介：

handler method 参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为四类：（主要讲解常用类型）

A、处理requet uri 部分（这里指uri template中variable，不含queryString部分）的注解：   @PathVariable;

B、处理request header部分的注解：   @RequestHeader, @CookieValue;

C、处理request body部分的注解：@RequestParam,  @RequestBody;

D、处理attribute类型是注解： @SessionAttributes, @ModelAttribute;

1、@PathVariable

当使用@RequestMapping URI template 样式映射时， 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。

示例代码：

上面代码把URI template 中变量 ownerId的值和petId的值，绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，

需要在@PathVariable("name")指定uri template中的名称。

2、@RequestHeader、@CookieValue

@RequestHeader 注解，可以把Request请求header部分的值绑定到方法的参数上。

 

示例代码：

 

这是一个Request 的header部分：

上面的代码，把request header部分的 Accept-Encoding的值，绑定到参数encoding上了， Keep-Alive header的值绑定到参数keepAlive上。

@CookieValue 跟@RequestHeader类似，可以把Request header中关于cookie的值绑定到方法的参数上。

3、@SessionAttributes, @ModelAttribute

@SessionAttributes:

该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。

该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；

示例代码：

@ModelAttribute

 

该注解有两个用法，一个是用于方法上，一个是用于参数上；

 

用于方法上时：  通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；

 

用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：

 

A） @SessionAttributes 启用的attribute 对象上；

 

B） @ModelAttribute 用于方法上时指定的model对象；

 

C） 上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。

这俩标签和在一起用的时候会有出错的可能,主要是springMVC解析流程上的问题，可以参考这篇文章：

http://blog.csdn.net/qwe6112071/article/details/51049138

4、@RequestParam, @RequestBody

@RequestParam涉及三个参数：

 

参数	说明
value	参数名
required	是否必须，一旦使用了@RequestParam注解，默认为true，如果不存在对应请求参数会出现异常：HTTP Status 400 - Required String parameter 'userName' is not present
defaultValue	默认参数值

A、常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String--> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；

B、用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；

C、该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；

示例代码：

@RequestBody

 

该注解常用来处理Content-Type不是application/x-www-form-urlencoded编码的内容，例如application/json, application/xml等；

 

它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body，然后绑定到相应的bean上的。

 

因为配置有FormHttpMessageConverter，所以也可以用来处理 application/x-www-form-urlencoded的内容，不过需要处理的比较特殊，可以自己测试下。

5、复杂对象和集合类型入参绑定

1. 对于普通的对象参数绑定，我们只需要对象成员变量名与请求参数名一一对应即可完成绑定。
   直接看图就能明白（有点类似于struts）
   
   
   
   
   
   
2. 数组类型参数绑定
   数组参数分为普通类型数组和复杂对象数组两种，但由于没有复杂对象数组的构造方法，springMVC只能绑定普通类型数组。 
   普通类型数组是指Integer、Stirng、Long等基本数据类型的包装类。
   
3. 集合类型参数绑定
   对于list、Set、Map等的参数绑定，如果我们尝试直接绑定，是会失败的，必须将其作为一个具体类对象的成员属性，这个时候我们也可称这个具体类对象为一个包装类。
   
   

6、格式化数据输入输出（json、xml等参数解析）

Spring3.0的重要接口：HttpMessageConveter为我们提供了强大的数据转换功能，将我们的请求数据转换为一个Java对象，或将java对象转化为特定格式输出等。比如我们常见的从前端注册表单获取json数据并转化为User对象，或前端获取用户信息，后端输出User对象转换为json格式传输给前端等。

springMVC为我们提供了众多的HttpMessageConveter实现类，其中我们可能用得最多的三个实现类是：

实现类	功能
FormHttpMessageConverter	从请求和响应读取/编写表单数据。默认情况下，它读取媒体类型 application/x-www-form-urlencoded 并将数据写入MultiValueMap<String,String>
MarshallingHttpMessageConverter	使用 Spring 的 marshaller/un-marshaller 读取/编写 XML 数据。它转换媒体类型为 application/xml
MappingJacksonHttpMessageConverter	使用 Jackson 的 ObjectMapper 读取/编写 JSON 数据。它转换媒体类型为application/json

springMVC里实现装配器有两种方式：

1. 直接springMVC的启动xml注册org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter来装配messageConverters，可以自定义支持类型，如下所示：
   
2. 直接启用注解<mvc:annotation-driven />，一般我们都是这种方式，比如json解析，直接使用maven将Jackson jar包导入即可，springMVC默认会帮我们实现以下7个转换器，：
   
   - ByteArrayHttpMessageConverter 
   - StringHttpMessageConverter 
   - ResourceHttpMessageConverter 
   - SourceHttpMessageConverter 
   - XmlAwareFormHttpMessageConverter 
   - Jaxb2RootElementHttpMessageConverter 
   - MappingJacksonHttpMessageConverter
   
   通过以上两种方法，我们即可完成我们的转换器注册。 
   但我们想要在控制层完成数据的输入输出转换，需要通过下列途径： 
   1. 使用@RequestBody和@ResponseBody对处理方法进行标注。其中@RequestBody通过合适的HttpMessageConverter将HTTP请求正文转换为我们需要的对象内容。而@ResponseBody则将我们的对象内容通过合适的HttpMessageConverter转换后作为HTTP响应的正文输出。 
   2. 使用HttpEntity、ResponseEntity作为处理方法的入参或返回值