Spring @RequestParam @RequestBody @PathVariable 等参数绑定注解详解

引言：

由于项目中经常用到各种参数，加之昨天需要和前端和一个功能，接收数据的时候几个参数用来用去，耽误了很多时间，于是今天打算放到一起整理一下。

简介：

1. 处理request uri 部分                               注解：@PathVariable; 
2. 处理request header部分                         注解：@RequestHeader, @CookieValue;
   
3. 处理request body部分                            注解：@RequestParam,  @RequestBody;
   
4. 处理attribute类型                                   注解：@SessionAttributes, @ModelAttribute;

@PathVariable

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

示例代码：

@Controller  
@RequestMapping("/owners/{paramId}")  
public class RelativePathUriTemplateController {  
  
  @RequestMapping("/pets/{petId}")  
  public void findPet(@PathVariable String paramId, @PathVariable String petId, Model model) {      
    // implementation omitted  
  }  
}  

@RequestHeader、@CookieValue

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

示例代码：

这是一个Request 的header部分：

Host                    localhost:8080  
Accept                  text/html,application/xhtml+xml,application/xml;q=0.9  
Accept-Language         fr,en-gb;q=0.7,en;q=0.3  
Accept-Encoding         gzip,deflate  
Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7  
Keep-Alive              300  

@RequestMapping("/displayHeaderInfo.do")  
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,  
                              @RequestHeader("Keep-Alive") long keepAlive)  {  
  
  //...  
  
}  

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

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

例如有如下Cookie值：

[java]  view plain  copy

1. JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84  

参数绑定的代码：

[java]  view plain  copy

1. @RequestMapping("/displayHeaderInfo.do")  
2. public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {  
3.   
4.   //...  
5.   
6. }  

即把JSESSIONID的值绑定到参数cookie上。

@RequestParam, @RequestBody

@RequestParam 

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

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

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

示例代码：

[java]  view plain  copy

1. @Controller  
2. @RequestMapping("/pets")  
3. @SessionAttributes("pet")  
4. public class EditPetForm {   
5.   
6.     @RequestMapping(method = RequestMethod.GET)  
7.     public String setupForm(@RequestParam("petId") int petId, ModelMap model) {  
8.         Pet pet = this.clinic.loadPet(petId);  
9.         model.addAttribute("pet", pet);  
10.         return "petForm";  
11.     }  
12.   
13.     // ...  

@RequestBody

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

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

3、其实这个东西也可以接收@RequestBody String json,@RequestBody  Map<String,String> map,其实接收字符串是最原始的，不过我觉得可用性并不是很大。一般在配置文件（文末附）中搭好，json字符串是可以直接转化为map或者class的

示例代码：

public class AdminStaff  {//实体类代码

	private String mobile;
	private String password;
	private String email;
}

 var staff = new Object();//前台js伪代码
      staff.mobile = this.usermobile;
      staff.password = this.userpass;
      // this.$router.push('/')
      this.$http.post('http://localhost/huihui-admin/login', JSON.stringify(staff) ).then()

[java]  view plain  copy

1. @RequestMapping(value = "/something")  
2. public void handle(@RequestBody AdminStaff staffModel){  
3.    // 
4. }  

这里稍微解释一下， @RequestBody需要接的参数是一个string化的json，不能包含key=value这样的写法在请求url中，所有的请求参数都是一个json。这里直接使用JSON.stringify(json)这个方法来转化。

还有一点特别重要的 ，这里切记不要@RequestBody String mobile,@RequestBody String password，我也是一直null了很久爬出来的。

@SessionAttributes, @ModelAttribute

@SessionAttributes:

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

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

示例代码：

[java]  view plain  copy

1. @Controller  
2. @RequestMapping("/editPet.do")  
3. @SessionAttributes("pet")  
4. public class EditPetForm {  
5.     // ...  
6. }  

@ModelAttribute

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

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

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

1、 @SessionAttributes 启用的attribute 对象上；

2、 @ModelAttribute 用于方法上时指定的model对象；

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

用到方法上@ModelAttribute的示例代码：

[java]  view plain  copy

1. // Add one attribute  
2. // The return value of the method is added to the model under the name "account"  
3. // You can customize the name via @ModelAttribute("myAccount")  
4.   
5. @ModelAttribute  
6. public Account addAccount(@RequestParam String number) {  
7.     return accountManager.findAccount(number);  
8. }  

这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；

用在参数上的@ModelAttribute示例代码：

[java]  view plain  copy

1. @RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)  
2. public String processSubmit(@ModelAttribute Pet pet) {  
3.      
4. }  

首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。

补充讲解：

问题： 在不给定注解的情况下，参数是怎样绑定的？

若要绑定的对象时简单类型：  调用@RequestParam来处理的。  

若要绑定的对象时复杂类型：  调用@ModelAttribute来处理的。

这里的简单类型指java的原始类型(boolean, int 等)、原始类型对象（Boolean, Int等）、String、Date等.Spring可以直接String转换成目标对象的类型

原文地址：http://blog.csdn.net/walkerjong/article/details/7946109/

===============================配置文件============================

<mvc:annotation-driven>
		<mvc:message-converters register-defaults="true">
			<bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter"></bean>
			<bean class="org.springframework.http.converter.StringHttpMessageConverter"/>
			<bean class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">
				<property name="supportedMediaTypes">
					<list>
						<value>application/json;charset=UTF-8</value>
						<value>text/html;charset=UTF-8</value>
					</list>
				</property>
				<property name="features"> 
					<array> 
						<value>WriteNullStringAsEmpty</value> 
						<value>NotWriteDefaultValue</value> 
					</array> 
				</property>
				<property name="dateFormat" value="yyyy-MM-dd HH:mm:ss"/>
			</bean>
		</mvc:message-converters>
	</mvc:annotation-driven>