spring mvc 注解参数详解@

﹏ヽ暗。殇╰゛Y 2022-07-28 01:24 206阅读 0赞

## 引言： ##

接上一篇文章，对@RequestMapping进行地址映射讲解之后，该篇主要讲解request 数据到handler method 参数数据的绑定所用到的注解和什么情形下使用；

## 简介： ##

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注解绑定它传过来的值到方法的参数上。

示例代码：

**\[java\]**  [view plain][] [copy][view plain]

1.  @Controller  
2.  @RequestMapping("/owners/\{ownerId\}")  
3.  **public** **class** RelativePathUriTemplateController \{  
4.    
5.    @RequestMapping("/pets/\{petId\}")  
6.    **public** **void** findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) \{      
7.      // implementation omitted  
8.    \}  
9.  \}

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

### 2、 @RequestHeader、@CookieValue ###

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

示例代码：

这是一个Request 的header部分：

**\[plain\]**  [view plain][] [copy][view plain]

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

**\[java\]**  [view plain][] [copy][view plain]

1.  @RequestMapping("/displayHeaderInfo.do")  
2.  **public** **void** displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,  
3.                                @RequestHeader("Keep-Alive") **long** keepAlive)  \{  
4.    
5.    //...  
6.    
7.  \}

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

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

例如有如下Cookie值：

**\[java\]**  [view plain][] [copy][view plain]

1.  JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84

参数绑定的代码：

**\[java\]**  [view plain][] [copy][view plain]

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

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

### 3、@RequestParam, @RequestBody ###

@RequestParam

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用来指示参数是否必须绑定；

示例代码：

**\[java\]**  [view plain][] [copy][view plain]

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

@RequestBody

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

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

因为配置有FormHttpMessageConverter，所以也可以用来处理 `application/x-www-form-urlencoded`的内容，处理完的结果放在一个MultiValueMap<String, String>里，这种情况在某些特殊需求下使用，详情查看FormHttpMessageConverter api;

示例代码：

**\[java\]**  [view plain][] [copy][view plain]

1.  @RequestMapping(value = "/something", method = RequestMethod.PUT)  
2.  **public** **void** handle(@RequestBody String body, Writer writer) **throws** IOException \{  
3.    writer.write(body);  
4.  \}

### 4、@SessionAttributes, @ModelAttribute ###

@SessionAttributes:

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

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

示例代码：

**\[java\]**  [view plain][] [copy][view plain]

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

@ModelAttribute

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

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

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

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

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

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

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

**\[java\]**  [view plain][] [copy][view plain]

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][view plain]

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对象的各属性上。

### @ResponseBody ###

作用：

该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。

使用时机：

返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；

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。

原文链接：[http://blog.csdn.net/kobejayandy/article/details/12690161][http_blog.csdn.net_kobejayandy_article_details_12690161]

[view plain]: http://blog.csdn.net/walkerjong/article/details/7946109#
[http_blog.csdn.net_kobejayandy_article_details_12690161]: http://blog.csdn.net/kobejayandy/article/details/12690161