`

关闭 Spring MVC之@RequestParam @RequestBody @RequestHeader 等详解

 
阅读更多

引言:

接上一篇文章,对@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 plaincopy
 
  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 plaincopy
 
  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 plaincopy
 
  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 plaincopy
 
  1. JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84  

参数绑定的代码:

[java] view plaincopy
 
  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 plaincopy
 
  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 plaincopy
 
  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 plaincopy
 
  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 plaincopy
 
  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 plaincopy
 
  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对象的各属性上。

分享到:
评论

相关推荐

    Spring MVC之@RequestMapping详解

    《Spring MVC之@RequestMapping详解》 在Java Web开发中,Spring MVC框架因其强大的功能和灵活性而备受青睐。在处理HTTP请求时,@RequestMapping注解扮演着至关重要的角色,它负责将客户端的请求映射到控制器中的...

    简单捋捋@RequestParam 和 @RequestBody的使用

    Spring MVC 中@RequestParam 和@RequestBody 注解的使用详解 在 Spring MVC 中,@RequestParam 和@RequestBody 是两个常用的注解,用于处理前端传递来的参数。下面将详细介绍这两个注解的使用和区别。 一、@...

    springmvc关于@requestMapping和@requestParam的使用

    在Spring MVC框架中,`@RequestMapping` 和 `@RequestParam` 是两个非常重要的注解,它们在处理HTTP请求和参数绑定方面起着核心作用。本文将深入探讨这两个注解的使用和功能。 `@RequestMapping` 是Spring MVC用于...

    Spring MVC RequestParam.docx

    总的来说,为了处理可能出现的缺失参数情况和避免基本类型无法接受`null`值的问题,推荐在Spring MVC中使用包装类型作为`@RequestParam`和`@RequestHeader`注解的参数类型。同时,利用`required`和`defaultValue`...

    spring 支持@RequestBody注解依赖包

    首先,`@RequestBody`是Spring MVC框架的一部分,它遵循Model-View-Controller(MVC)设计模式。在MVC中,控制器负责处理来自客户端的请求,并将处理结果传递给视图进行展示。`@RequestBody`就是控制器层的一个关键...

    SpringMVC@RequestMapping(重点)@RequestParam@PathVariable示例

    在Spring MVC框架中,`@RequestMapping`、`@RequestParam`和`@PathVariable`是三个非常重要的注解,它们用于处理HTTP请求并绑定请求参数到控制器方法的参数上。接下来,我们将详细探讨这三个注解的工作原理以及如何...

    @PathVariable和@RequestParam的区别1

    当你在控制器方法的参数上使用`@RequestParam`时,Spring MVC会自动从请求的查询字符串中查找对应的参数值。 ```java @GetMapping("/example") public String example(@RequestParam("paramName") String ...

    Spring MVC打印@RequestBody、@Response日志的方法

    Spring MVC打印@RequestBody、@Response日志的方法 Spring MVC框架提供了强大的日志记录功能,对于日志记录的实现,Spring MVC提供了多种方式,本文将主要介绍如何使用RequestBodyAdvisor和ResponseBodyAdvisor来...

    spring mvc RequestParam与 ModelAttribute异同.docx

    在Spring MVC框架中,`@RequestParam` 和 `@ModelAttribute` 是两种常见的注解,用于从HTTP请求中绑定数据到控制器方法的参数。虽然它们都用于处理请求参数,但它们的作用和使用场景有所不同。 1. **`@RequestParam...

    对SpringMVC的@RequestParam的解释

    总结,`@RequestParam`是Spring MVC中用于处理HTTP请求参数的关键工具,它可以方便地将请求参数绑定到控制器方法的参数上,支持多种参数类型和处理策略,包括可选参数、默认值以及处理数组参数等。理解和熟练使用`@...

    @PathVariable和@RequestParam的区别

    @PathVariable和@RequestParam的区别

    浅析@ReponseBody和@RequestBody注解

    Spring MVC内部对@RequestBody的解析过程: 1. 首先,Spring MVC会根据HTTP请求头中的Content-Type类型选择合适的HttpMessageConverter。 2. 然后,Spring MVC会使用选择的HttpMessageConverter来将请求体中的数据...

    Spring MVC之@RequestMapping注解详解

    此外,@RequestMapping还可以与其他注解如@RequestParam、@RequestBody、@PathVariable、@RequestHeader等结合使用,以实现更精细的请求处理。例如,@RequestParam用于从请求参数中获取值,@RequestBody用于从请求体...

    Spring MVC jar包

    Spring MVC 是一个基于Java的轻量级Web应用框架,它为开发者提供了模型-视图-控制器(MVC)架构,使开发人员能够更好地组织和分离应用程序的业务逻辑、数据处理和用户界面。Spring MVC是Spring框架的一个核心组件,...

    Spring Mvc实例

    这个实例对于理解Spring MVC的工作原理和实际应用是非常有帮助的,也是Java Web开发者必备的技能之一。通过实践这个例子,你可以更深入地掌握Spring MVC的精髓,为构建更复杂的应用打下坚实的基础。

    最全最经典spring-mvc教程

    另外,Spring MVC与Spring框架的其他组件无缝集成,如Spring AOP(面向切面编程)用于实现日志、事务管理等功能,Spring JDBC和MyBatis等持久层框架用于数据库操作,以及Spring Data JPA、Hibernate等ORM工具,使得...

Global site tag (gtag.js) - Google Analytics