`

@RequestParam @RequestBody @PathVariable 等参数绑定注解详解

 
阅读更多
引言:
接上一篇文章,对@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注解绑定它传过来的值到方法的参数上。

示例代码:

@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {

  @RequestMapping("/pets/{petId}")
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {    
    // implementation omitted
  }
}


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


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

示例代码:

这是一个Request 的header部分:

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


@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
                              @RequestHeader("Keep-Alive") long keepAlive)  {

  //...

}


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

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

例如有如下Cookie值:
引用
JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84


参数绑定的代码:

@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {

  //...

}


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

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

示例代码:

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

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

// Add one attribute
// The return value of the method is added to the model under the name "account"
// You can customize the name via @ModelAttribute("myAccount")

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



参考:http://www.cnblogs.com/qq78292959/p/3760702.html

      http://www.cnblogs.com/qq78292959/p/3760651.html
分享到:
评论

相关推荐

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

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

    Spring MVC之@RequestMapping详解

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

    springMVC的 RequestBody和 ResponseBody和RequestParam.docx

    在 Spring MVC 中,请求参数的处理非常灵活,可以使用 `@RequestParam`、`@RequestBody` 和 `@ResponseBody` 等注解进行数据绑定和响应体的控制。 #### 二、`@RequestBody` `@RequestBody` 注解通常用于控制器中的...

    SpringMVC 常用注解类视频详解

    12. `@RequestParam/@PathVariable/@ModelAttribute`的集合注解如`@RequestParams`, `@PathVariables`, `@ModelAttributes`,允许一次性处理多个参数。 13. `@RequestBody`:用于读取HTTP请求体中的JSON或XML数据,...

    SpringBoot前后端传值.docx

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

    springmvc注解详解

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

    Spring MVC 使用注解的示例讲解

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

    SpringMvc注解详解

    【SpringMvc注解详解】 SpringMvc 是 Spring 框架的一部分,主要负责处理 Web 请求。在 SpringMVC 中,注解扮演着至关重要的角色,它们简化了代码并减少了配置。以下是一些常用的 SpringMVC 注解及其详细解释: 1....

    spring3.0MVC注解

    【Spring 3.0 MVC 注解详解】 Spring 3.0 的 MVC 框架引入了丰富的注解,使得开发者可以更加简洁、直观地编写 Web 应用程序,减少了传统 XML 配置的繁琐。这些注解使得控制器、请求映射、参数绑定等关键功能变得...

    详解使用@RequestBody取POST方式的json字符串

    在Java Spring框架中,`@RequestBody`注解被用来从HTTP请求体中读取JSON格式的数据并将其绑定到方法参数上。本文将深入探讨如何使用`@RequestBody`来接收POST方式的JSON字符串。 首先,`@RequestBody`是Spring MVC...

    springMVC 注解版

    3. 如果需要,通过`@RequestBody`解析请求体,`@RequestParam`和`@PathVariable`获取参数。 4. 调用处理方法,业务逻辑处理,可能涉及到事务管理、AOP切面等。 5. 处理结果通过`@ModelAttribute`绑定到模型,或者...

    annotation-springMVC.rar_springmvc_springmvc API chm

    《SpringMVC注解详解与应用》 SpringMVC作为Java Web开发中广泛使用的轻量级框架,极大地简化了Web应用程序的构建。其中,注解的使用是SpringMVC的一大特色,它使得代码更加简洁、易读,同时也提高了开发效率。下面...

    spring mvc4中相关注解的详细讲解教程

    在本教程中,我们将深入探讨几个关键的注解,包括@Controller、@RequestMapping、@PathVariable、@RequestParam和@RequestBody,这些都是Spring MVC4中实现请求处理的关键元素。 1. **@Controller** `@Controller`...

    springmvc.docx

    - SpringMVC 使用注解简化配置,如 @Controller、@RequestMapping、@RequestParam、@PathVariable 等,使得控制器类和方法可以直接绑定请求和参数。 5. **配置 SpringMVC 访问路径** - 在 web.xml 中配置 ...

    Spring MVC传值

    可以使用`@RequestBody`注解将请求体内容映射到Java对象: ```java @PostMapping("/user") public String createUser(@RequestBody User user) { // 处理逻辑... } ``` 2. **Multipart请求**:用于上传文件...

    springMVC详解以及注解说明

    通过 @PathVariable 获取 URL 中的用户ID,通过 @RequestBody 将 JSON 数据绑定到 User 对象。 总结,Spring MVC 以其灵活性、高效性和易于扩展性,在 Java Web 开发领域有着广泛的应用。通过注解驱动的开发方式,...

    spring MVC中接口参数解析的过程详解

    首先,`@RequestParam`、`@RequestBody`和`@PathVariable`是Spring MVC中用于处理不同类型的请求参数的注解。`@RequestParam`常用于GET请求,参数直接附加在URL的查询字符串中。`@RequestBody`适用于POST请求,它将...

    详解SpringBoot Controller接收参数的几种常用方式

    总结,SpringBoot Controller可以通过`@PathVariable`、`@RequestParam`、`@RequestBody`、`@RequestHeader`和`@CookieValue`等多种方式接收不同类型的参数,以满足各种HTTP请求的需求。理解并熟练掌握这些注解的...

    详解SpringMVC @RequestBody接收Json对象字符串

    如上文提到的后端代码示例,通过@RequestMapping注解定义了请求的URL和方法类型,使用@RequestBody注解来绑定请求体中的JSON数据到一个User对象的列表。服务层(service层)通过调用userService的batchSave方法来...

Global site tag (gtag.js) - Google Analytics