`

注解@PathVariable,@RequestParam ,@RequestBody

 
阅读更多
简介
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是用来获得请求url中的动态参数.
当使用@RequestMapping URI template 样式映射时, 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。
示例代码:
@Controller  
@RequestMapping("/owners/{ownerId}")  
public class RelativePathUriTemplateController {  
  
  @RequestMapping("/pets/{petId}")  
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
    // implementation omitted   
  }  
}  


2、 @RequestHeader、@CookieValue
@RequestHeader 注解,可以把Request请求header部分的值绑定到方法的参数上。
@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。
例如有如下Cookie值:
JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84
参数绑定的代码:
@RequestMapping("/displayHeaderInfo.do")  
public void displayHeaderInfo(@CookieValue("JSESSIONID") String 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用来指示参数是否必须绑定;
示例代码:
@Controller  
@RequestMapping("/pets")  
@SessionAttributes("pet")  
public class EditPetForm {  
    @RequestMapping(method = RequestMethod.GET)  
 public String setupForm(@RequestParam("petId") int petId, ModelMap model) {  
       Pet pet = this.clinic.loadPet(petId);  
   model.addAttribute("pet", pet);  
   return "petForm";  
   }

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

4、@SessionAttributes, @ModelAttribute
@SessionAttributes:
该注解用来绑定HttpSession中的attribute对象的值,便于在方法中的参数里使用。
该注解有value、types两个属性,可以通过名字和类型指定要使用的attribute 对象;
示例代码:
@Controller  
@RequestMapping("/editPet.do")  
@SessionAttributes("pet")  
public class EditPetForm {  
    // ...  
}  



@ModelAttribute
该注解有两个用法,一个是用于方法上,一个是用于参数上;
用于方法上时:  通常用来在处理@RequestMapping之前,为请求绑定需要从后台查询的model;
用于参数上时: 用来通过名称对应,把相应名称的值绑定到注解的参数bean上;要绑定的值来源于:
A) @SessionAttributes 启用的attribute 对象上;
B) @ModelAttribute 用于方法上时指定的model对象;
C) 上述两种情况都没有时,new一个需要绑定的bean对象,然后把request中按名称对应的方式把值绑定到bean中。

用到方法上@ModelAttribute的示例代码:
@ModelAttribute  
public Account addAccount(@RequestParam String number) {  
    return accountManager.findAccount(number);  
}  


这种方式实际的效果就是在调用@RequestMapping的方法之前,为request对象的model里put(“account”, Account);

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

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

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

分享到:
评论

相关推荐

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

    详细介绍了Spring Boot最常用的30个注解,包含概念、原理...3 @RequestBody 4 @Responsebody 六、 全局异常处理相关 1 @ControllerAdvice 2 @ExceptionHandler 七、 Spring Data JPA相关 1 @Entity 2 @Table 3 @Id ……

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

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

    注解配置SpringMVC

    `@RequestBody` 注解用于将请求体中的JSON或XML数据转换为Java对象,而`@ResponseBody`则将方法的返回值转换为HTTP响应体的输出内容。 ```java @PostMapping("/save") public @ResponseBody User saveUser(@Request...

    Spring 注解学习手札(二) 控制层梳理

    六、@RequestBody和@ResponseBody注解 这两个注解配合使用,可以将HTTP请求体中的数据自动转换为Java对象,或者将方法返回的对象转换为HTTP响应体。@RequestBody用于接收POST请求中的JSON或XML数据,而@ResponseBody...

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

    public void saveUser(@RequestBody User user) { // ... } ``` 这里,`User` 类会自动映射请求体中的 JSON 数据。 5. **@SessionAttributes 和 @ModelAttribute** `@SessionAttributes` 注解用于声明需要在 ...

    spring boot前后端传参的实现

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

    Spring MVC之@RequestMapping详解

    本文将深入探讨@RequestMapping的使用方式,以及其在处理RESTful API时如何与各种参数绑定注解(@RequestParam、@RequestBody、@RequestHeader、@PathVariable)配合工作,并简要提及HttpMessageConverter的概念。...

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

    - `@RequestBody` 注解用于从请求体中获取内容,通常用于处理`Content-Type: application/json`或`Content-Type: application/xml`的数据。Spring MVC会尝试使用配置的`HttpMessageConverter`来将请求体解析为Java...

    Spring MVC 使用注解的示例讲解

    Spring MVC支持使用注解直接将请求参数绑定到方法参数上,如@RequestParam、@PathVariable、@RequestBody等。例如: ```java @GetMapping("/user/{id}") public User getUser(@PathVariable Long id) { // 根据...

    springmvc_加注解例子

    总结,本示例"springmvc_加注解例子"主要展示了Spring MVC的注解驱动开发,包括`@Controller`、`@RequestMapping`、`@RequestParam`、`@PathVariable`、`@RequestBody`、`@ResponseBody`等注解的使用,以及模型数据...

    springmvc注解详解

    `@RequestBody` 注解用于将请求体的内容映射到方法参数上,通常用于接收 JSON 或 XML 数据。Spring MVC 自动将请求体的内容转换为指定的对象类型。 ### 7. `@ResponseBody` `@ResponseBody` 注解用于将方法返回的...

    Spring 注解 小例子

    8. `@PathVariable`, `@RequestParam`, `@RequestHeader`, `@RequestBody` 这些注解用于从HTTP请求中提取数据。`@PathVariable`用于从URL路径变量中获取值,`@RequestParam`用于从查询参数中获取,`@RequestHeader`...

    SpringBoot前后端传值.docx

    - `application/json` 或 `application/xml`:必须使用 `@RequestBody` 来处理,URL 中的参数仍可用 `@RequestParam` 接收。 #### 实际运用 - **参数传值**:当使用 form 表单参数或 URL 参数时,可以直接使用...

    springMVC详解以及注解说明

    5. **@PathVariable, @RequestParam, @RequestHeader, @RequestBody**: 这些注解用于从HTTP请求中提取参数。`@PathVariable`用于获取URL路径变量,`@RequestParam`获取查询参数,`@RequestHeader`获取HTTP头部信息...

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

    public User updateUser(@PathVariable Long id, @RequestBody User updatedUser) { // 更新用户信息 } @DeleteMapping("/users/{id}") public void deleteUser(@PathVariable Long id) { // 删除用户 } } ...

    springMVC注解实现

    `@GetMapping`用于获取用户列表,而`@PostMapping`用于创建新用户,其中`@RequestBody`注解用于将请求体中的JSON转换为Java对象。 4. **@PathVariable**: 用于获取URL路径中的动态部分。例如: ```java @...

    基于注解的springMVC简单的例子

    `@RequestBody`和`@ResponseBody`用于将HTTP请求体或响应体直接映射为Java对象。`@ModelAttribute`还可以配合`@InitBinder`进行数据绑定的自定义。 **总结** 基于注解的SpringMVC大大简化了Web应用的开发,通过...

    SpringCloud Feign参数问题及解决方法

    注:参数前使用了@RequestBody注解的,都以POST方式消费服务,@RequestBody注解的参数,需要POST方式才能传递数据。 2. Feign多参数的问题 在使用Feign时,如果服务提供者需要多个参数,可以使用@PathVariable或@...

    Postman使用详解(文档+视频+postman请求导出文件+后台java工程演示资源).rar

    3、重点配置环境变量和全局参数、配置自增或时间戳随机参数、请求Cookies设置、Get和Post请求后端用什么注解介绍(@RequestParam、@PathVariable、@RequestBody,详细介绍postman发送{}、[] 格式数据,后端10多种...

    springboot2教程之新建个REST API接口(源代码).zip

    在Spring Boot中,可以使用`@RequestParam`、`@PathVariable`、`@RequestBody`等注解来获取请求中的数据。例如,接收一个POST请求并更新用户信息: ```java @PostMapping("/users/{id}") public ResponseEntity...

Global site tag (gtag.js) - Google Analytics