文档章节

springMVC--参数绑定常用的注解

北京_
 北京_
发布于 2014/11/09 16:26
字数 1136
阅读 138
收藏 8

简介:

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

示例代码

  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部分:

  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  


  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值:


  1. JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84  

参数绑定的代码:


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

示例代码:

  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;

示例代码:

 @RequestMapping(value = "/something", method = RequestMethod.PUT)  public void handle(@RequestBody String body, Writer writer) throws IOException {    

    writer.write(body); 

 }  


4、@SessionAttributes, @ModelAttribute

@SessionAttributes:

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

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

示例代码:

  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的示例代码:

  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示例代码:


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


© 著作权归作者所有

共有 人打赏支持
北京_
粉丝 9
博文 89
码字总数 31816
作品 0
海淀
程序员
Spring4.1.6 常用注解

常用的spring注解有如下几种: @Controller @Service @Autowired @RequestMapping @RequestParam @ModelAttribute @Cacheable @CacheFlush @Resource @PostConstruct @PreDestroy @Repositor......

大糊涂
2015/06/10
0
0
SpringMVC 基于注解的Controller @RequestMapping @Request

概述 继 Spring 2.0 对 Spring MVC 进行重大升级后,Spring 2.5 又为 Spring MVC 引入了注解驱动功能。现在你无须让 Controller 继承任何接口,无需在 XML 配置文件中定义请求和 Controller...

蓝狐乐队
2014/02/28
0
1
SpringMVC常用注解标签详解

1、@Controller 在SpringMVC 中,控制器Controller 负责处理由DispatcherServlet 分发的请求,它把用户请求的数据经过业务处理层处理之后封装成一个Model ,然后再把该Model 返回给对应的Vie...

Java工程师-Distance
05/20
0
0
RESTful API单元测试

下面针对该Controller编写测试用例验证正确性,具体如下。当然也可以通过浏览器插件等进行请求提交验证。 至此,我们通过引入web模块(没有做其他的任何配置),就可以轻松利用Spring MVC的功...

明理萝
06/12
0
0
Spring框架自学(四)注解注入

1、@Controller 在SpringMVC 中,控制器Controller 负责处理由DispatcherServlet 分发的请求,它把用户请求的数据经过业务处理层处理之后封装成一个Model ,然后再把该Model 返回给对应的Vie...

大二架构师
05/09
0
0

没有更多内容

加载失败,请刷新页面

加载更多

TypeScript基础入门之高级类型的字符串字面量类型

转发TypeScript基础入门之高级类型的字符串字面量类型 高级类型 字符串字面量类型 字符串字面量类型允许你指定字符串必须的固定值。 在实际应用中,字符串字面量类型可以与联合类型,类型保护...

durban
16分钟前
2
0
iOS权限授权添加

<!-- 相册 --> <key>NSPhotoLibraryUsageDescription</key> <string>App需要您的同意,才能访问相册</string> <!-- 相册写入 --> <key>NSPhotoLibraryAddUsageDescription</key> <string>App......

RainOrz
20分钟前
1
0
支配树(Dominator Tree)

MAT中的支配树 在使用MAT分析项目的内存泄漏问题时,其中有一个支配树(Dominator)视图。如果我们把Java对象之间的引用关系看做一张有向图(可以存在环)的话,对象的支配树体现了对象之间的...

akane_oimo
22分钟前
1
0
xshell官网下载及安装(免费版本)

百度搜索xshell,点击xshell官网下载链接,如图 然后点击下图的按钮 点击Latest Products,可以下载最新版本,选择要下载的版本,点击下载 选择上面红框里面的,并填写内容,submit之后会有邮...

曾大大胖
26分钟前
2
0
Android 调用系统分享文字、图片、文件,可直达微信、朋友圈、QQ、QQ空间、微博

兼容SDK 18以上的系统,直接调用系统分享功能,分享文本、图片、文件到第三方APP,如:微信、QQ、微博等 因为偷懒,可直达微信、朋友圈、QQ、QQ空间、微博的分享仅写了图片分享的,其他的文本...

她叫我小渝
28分钟前
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部