`

@PathVariable和@RequestParam的区别

 
阅读更多

请求路径上有个id的变量值,可以通过@PathVariable来获取  @RequestMapping(value = "/page/{id}", method = RequestMethod.GET)  
@RequestParam用来获得静态的URL请求入参     spring注解时action里用到。

简介:

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")  
  1. public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,  
  2.                               @RequestHeader("Keep-Alive"long keepAlive)  {  
  3. }  

上面的代码,把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. }  

即把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.     @RequestMapping(method = RequestMethod.GET)  
  6.  public String setupForm(@RequestParam("petId"int petId, ModelMap model) {  
  7.        Pet pet = this.clinic.loadPet(petId);  
  8.    model.addAttribute("pet", pet);  
  9.    return "petForm";  
  10.    }  

 

@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;

示例代码:

 

  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 对象;

示例代码:

 

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

分享到:
评论

相关推荐

    @PathVariable和@RequestParam的区别1

    在Web开发中,尤其是使用Spring MVC框架时,`@RequestParam`和`@PathVariable`是两种常用的注解,用于从HTTP请求中获取数据。这两个注解的主要区别在于它们处理请求参数的方式。 `@RequestParam`用于获取请求参数,...

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

    例如,你可以在一个方法中同时使用`@PathVariable`和`@RequestParam`来处理包含动态路径和请求参数的请求: ```java @GetMapping("/users/{userId}/books/{bookId}") public Book getUserBook(@PathVariable(...

    spring mvc中的@PathVariable获得请求url中的动态参数

    在Spring MVC框架中,`@PathVariable`是一个注解,它用于从URL模板中获取动态参数并将其绑定到...在实际项目中,结合其他Spring MVC注解,如`@RequestParam`和`@MatrixVariable`,可以构建出功能强大的HTTP处理逻辑。

    Spring mvc中 RequestMapping 6个基本用法小结

    在上面的例子中,我们使用两个 @PathVariable 注解将 departmentId 和 employeeId 参数绑定到方法参数中。当用户访问 /departments/23/employees/123 时,该方法将被调用,并将两个参数的值传递给方法。 6. 支持...

    Spring Boot最常用的30个注解.docx

    详细介绍了Spring Boot...1 @PathVariable 2 @RequestParam 3 @RequestBody 4 @Responsebody 六、 全局异常处理相关 1 @ControllerAdvice 2 @ExceptionHandler 七、 Spring Data JPA相关 1 @Entity 2 @Table 3 @Id ……

    springmvc-restful-pathvariable

    RESTful设计强调资源的定位和操作,其中`@PathVariable`是一个关键组件。本文将深入探讨如何使用`@PathVariable`来处理URL中的动态参数,以及如何解决在Spring MVC中可能出现的乱码问题。 首先,`@PathVariable`是...

    注解配置SpringMVC

    其中,注解配置是SpringMVC的一个核心特性,它允许开发者通过在类和方法上添加注解来替代传统的XML配置,从而实现更加简洁、易读的代码结构。本文将深入探讨SpringMVC中的注解配置及其相关知识点。 ### 1. @...

    SPRING MVC 的请求参数获取的几种方法

    在上面的代码中,我们使用 @PathVariable 注解来获取路径中传递的 id 和 str 参数。 2. 使用 @ModelAttribute 注解获取 POST 请求的 FORM 表单数据 在 SPRING MVC 中,可以使用 @ModelAttribute 注解获取 POST ...

    springMVC接收参数的几种注解.pdf

    public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) { // ... } ``` 如果参数名与 URI 模板中的变量名不一致,可以使用 `@PathVariable("name")` 指定变量名。 2. ...

    Spring注解 - 52注解 - 原稿笔记

    @JsonPropertyOrder , @JsonSerialize , @JsonSetter , @Lazy , @Order , @PathVariable , @Pointcut , @PostConstruct , @PostMapping , @PreDestroy , @Primary , @PropertySource , @Qualifier , @Repository , ...

    SpringBoot之Controller的使用详解

    在SpringBoot中,我们可以使用@PathVariable和@RequestParam来获取请求参数。 ### 使用@PathVariable @PathVariable用于获取URL中的参数。 例如: ```java @RestController public class HelloController { @...

    spring boot前后端传参的实现

    Spring Boot 框架提供了多种方式来实现前后端传参,包括使用 `@PathVariable`、`@RequestParam`、`@RequestBody` 等注解。本文将详细介绍这些注解的使用方法和示例代码。 使用 `@PathVariable` 获取 URL 参数 `@...

    SpringMvc接收前端数据的几种方式.md

    springmvc接收数据的几种方式,根据前端传递的数据类型判断用怎样的方式去接收。 @PathVariable、@RequestParam 和 @RequestBody 的使用场景。在不同情况下如何接收,以及他们之间的区别。

    SSM笔记-SpringMVC REST风格、基本标签初识

    总结,SpringMVC提供了强大的工具来构建RESTful服务,结合`@RequestMapping`及其衍生注解,可以轻松地处理HTTP请求,并通过`@PathVariable`、`@RequestParam`等获取请求参数。理解并熟练运用这些知识,能帮助开发者...

    SpringBoot前后端传值.docx

    #### 三、@PathVariable 与 @RequestParam 的区别 - **@PathVariable**:主要针对 URL 中作为路径组成部分的数据,比如 `/user/{userId}` 中的 `{userId}`。 - **@RequestParam**:主要用于接收 URL 后面的查询...

    springmvc 参数绑定例子

    本示例将深入探讨`@RequestParam`、`@CookieValue`、`@PathVariable`和`@ModelAttribute`这四个注解在参数绑定中的应用。 首先,`@RequestParam`注解用于从HTTP请求的查询参数或POST请求体中获取数据。例如,当用户...

    Restful接口案例及测试

    基于SpringMvc的restful源码及测试代码,代码为maven结构,集成springmvc、mybatis、log4j2技术。测试@PathVariable、@RequestParam、@RequestBody和没有标注的简单参数接收等get、post两种形式的服务及其测试。

    springMVC接收参数的几种注解.docx

    public void findPet(@PathVariable String ownerId, @PathVariable String petId) { // ... } ``` 如果模板变量名与参数名不同,可以通过`@PathVariable("name")`指定。 2. **@RequestHeader** - `@Request...

    Spring MVC 使用注解的示例讲解

    Spring MVC支持创建RESTful风格的API,通过@RequestMapping的HTTP方法属性(GET、POST、PUT、DELETE等)和@PathVariable、@RequestParam结合,可以轻松实现资源操作。 8. **配置** Spring MVC的配置可以通过XML或...

Global site tag (gtag.js) - Google Analytics