开发Controller方法时传参的三个不同的注解：@RequestBody、@PathVariable和@RequestParam注解

原创 已于 2024-02-20 16:12:09 修改 · 1.4k 阅读 · 27 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #开发语言 #spring boot

于 2023-12-25 10:42:01 首次发布
本文介绍了SpringMVC框架中常用的@RequestBody、@PathVariable和@RequestParam注解，分别用于处理POST、GET和PUT请求中的数据绑定，以及URL路径参数的映射。

1.@RequestBody 注解：

        定义：@RequestBody 注解用于从请求体中获取数据，并将其转换为指定的对象类型。它通常用于处理 POST 或 PUT 请求，其中请求体包含要创建或更新的对象数据。@RequestBody注解用于Spring MVC中的RESTful服务，用来接收HTTP请求的json/xml格式的数据，并将其转换成Java对象。当HTTP请求中包含json或xml格式的数据时，使用@RequestBody注解将请求体中的数据绑定到方法的参数上。这使得Spring MVC开发者能够很方便地将请求体的数据绑定到某个Java对象上，从而实现自动解析json/xml格式的数据。

         @RequestBody注解是Spring框架中常用的一个注解之一。它通常用于处理HTTP请求的消息体，将请求中的JSON或XML等数据绑定到Java对象上。当客户端向服务器发起请求时，请求的数据可以按照JSON或XML格式的方式放置在请求的消息体中，@RequestBody注解可以将这些数据提取出来并转化成我们所需要的Java对象，这样代码中就可以直接对这些对象进行操作。

        一般搭配Put和Post使用，因为需要把JSON和XML类型的数据放到请求体中，而后端一般会在接收的方法上用一个pojo类对象去接收它。

        实例：

        这是一个Post请求，在方法上声明@PostMapping，表示接收来自前端的Post请求。在方法的参数里使用一个user对象来接收请求体中的JSON或XML内容。

        这是一个Put请求，在方法上声明@PutMapping，表示接收来自前端的Put请求。在方法的参数里使用一个User对象来接收请求体中的JSON或XML内容。

2. @PathVariable注解：

        @PathVariable是spring3.0的一个新功能，可以用来接收请求路径中占位符的值。也就是说@PathVariable是用来映射 URL 绑定的占位符。我们可以通过 @PathVariable 可以将 URL 中占位符参数绑定到某个controller的方法的参数中，该参数可以通过URL 中的占位符拿到值。

        一般搭配Get、Delete请求使用，也就是要求只需要在URL中绑定简单的参数而无需像Post一样放在请求体中。http://localhost:8080/delect/ids

实例：

在参数ids之前加上该注解后就可以拿到URL中占位符上的，也就是前端请求过来的ids了。 注意需要两个ids相同，不然不能正常接收，也就是参数名一致。

3.@RequestParam注解：

        

        @RequestParam用于将请求参数绑定到你控制器的方法参数上。

        一般用于Get请求，也就是说要在controller方法上加上@GetMapping注解。有三个属性：value，required，defaultValue

        1）value：必须包含，且值必须与url中的参数一致。所以由此可见，之所以要配置该属性，就是为了保证controller方法上的参数可以正确识别前端发送过来的url中的参数。所以，如果你可以保证前端传过来比如一个http://localhost:8080/select?"name"=1,这里面的name和你后端方法上接收的参数一致，也就是说你后端也是同样的名字（name），那你就没有必要@RequestParam注解。(有时候我们需要通过路径后拼“？”的方式且参数不是一个单个值，而是一个数组来设置参数，那么这个时候应该把该注解加上，否则springboot框架无法正确的解析参数，也就无法正确的接收参数，而加上之后就可以用list集合来进行接收，springboot框架会帮我们解析前端传过来的参数)

        2）required：是否必需，默认为 true。即请求中必须包含该参数。

        3）defaultValue：默认值，如果设置了该值，required 将自动设为 false。适合在分页查询时，给参数page和pagesize设置默认值，比如page=1，pagesize=10：表示如果前端不传这两个值，那默认查询第一页，每页十条数据展示。

随风ada
关注
@PathVariable，@RequestParam，@RequestBody注解，springboot与前端请求之间的数据类型转换
l_q_l的专栏
09-17 2002
get请求中，可以使用@pathVariable和@requestParam注解post请求中，可以使用@requestParam和@requestBody@requestParam对应前端axios的参数为params@requestBody对应前端axios的参数为data。
springboot注解 详解
专注基础架构领域
08-09 802
包含@Configuration、@EnableAutoConfiguration、@ComponentScan通常用在主类上。用于标注数据访问组件，即DAO组件。用于标注业务层组件。用于标注控制层组件(如struts中的action)，包含@Controller和@ResponseBody用于标注是控制层组件，需要返回页面时请用@Controller而不是@RestController泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。表示该方法的返回结果直接写入HTTP response bo
Controller 中使用多个@RequestBody
豪华的博客
12-10 3098
最近在Controller中想要一个方法接收多个参数并且最好还能支持校验
@Controller、@RestController、@RequestMapping、@ResponseBody、@RequestBody、@RequestParam用法详解
qq_45961915的博客
01-06 816
java json返回
springbootWeb常用注解使用
m0_63622279的博客
01-25 1698
可以通过@RequestHeader注解来获取请求标头的一些信息，如果方法参数是Map、MultiValueMap或HttpHeaders，则映射将填充所有标头名称和值。一般都是结合着@RequestMapping注解来使用，用于在参数传递的过程中，规范前端发送请求的格式，和数据的验证。若不存在，将抛出异常。注意的点:@PathVarible注解，如果方法参数为Map，则映射将填充所有路径变量名称和值。
Controller层@PathVariable使用
03-21 303
@PathVariable 映射 URL 绑定的占位符 带占位符的URL是Spring3.0新增的功能，该功能在SpringMVC 向REST目标挺进发展过程中具有里程碑的意义通过@PathVariable可以将URL中占位符参数绑定到控制器处理方法的入参中：URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。主...
@ModelAttribute注解Controller方法的入参
yh_zeng2的博客
07-15 2197
有两种用法，分别是： （1）从model中获取 @Controller public class HelloWorldController { @ModelAttribute("user") public User addAccount() { return new User("jz","123"); }
Spring Web MVC（常用的注解@RequestMapping,@RequestParam,@RequestBody等）
AZK707的博客
07-17 1804
在代码最前面写上，将方法返回的结果直接作为响应内容发送到客户端。(只返回数据，不返回页面)@RequestMapping("/路径名")通过URL进行路由映射。既是类注解，又是方法注解。访问的URL路径 = 类路径+方法路径指定请求方式：@RequestMapping（value = “/路径名”，method = RequestMethod.方法名）@RequestParam（“重命名参数”）和绑定（“绑定集合类型对象比如List”）请求Json格式数据请求URL 中的变量上传文件。
springboot 获取接口请求中的参数(@PathVariable，@RequestParam，@RequestBody)
m0_58680865的博客
05-30 6449
一、 访问请求、URI、URL、请求参数 四者的区别 一个完整的请求路径：http://www.test.com/user/031267/view?username=zhangsan&age=20 请求URL （requestURL）= http://www.test.com/user/031267/view 请求URI （requestURI）= /user/031267/view 请求参数（queryString）= username=zhangsan&age=20 二、注解区别 1、
Springboot中参数传递的三个注解的使用
潮汐先生的专栏
11-12 6113
Springboot中参数传递的三个注解的使用Springboot中参数传递的三个注解的使用@PathVariable@RequestParamGET用法POST用法@RequestBody Springboot中参数传递的三个注解的使用 本文只要介绍springboot中有关参数传递的三个注解：@PathVariable 、@RequestParam 以及 @RequestBody的使用 @PathVariable @PathVariable 注解主要是用来获取 url 参数，Spring Boot 支持
Controller
weixin_34252686的博客
11-17 160
一、简介 在SpringMVC中，控制器Controller负责处理由DispatcherServlet分发的请求，它把用户请求的数据经过业务处理层处理之后封装成一个Model，然后再把该Model返回给对应的View进行展示。在SpringMVC中提供了一个非常简便的定义Controller的方法，你无需继承特定的类或实现特定的接口，只需使用@Controller标记一个类...
Springboot中Controller用@RequestBody接收对象Postman发请求
彩色大白兔
06-16 581
在PostMan中带Body-raw-json 中发送json字符串。
在controller中，@RequestBody，，@RequestParam，@PathVriable的使用，结合PostMan
YHY的日常
10-25 1178
@RequestBody（参数列表） @requestBody接收的是前端传过来的json字符串,而不是对象 @ResponseBody （方法上的注解） 用于将Controller的方法返回的对象，通过HttpMessageConverter接口转换为指定格式的数据如：json,xml等，通过Response响应给客户端. 注意：不一定只能传递字符串，若有对应的java类，springMVC会自...
SpringBoot Controller 中使用多个@RequestBody的正确姿势
热门推荐
悟鸣的技术博客
08-27 11万+
最近遇到Controller中需要多个@RequestBody的情况，但是发现并不支持这种写法， 这样导致 1、单个字符串等包装类型都要写一个对象才可以用@RequestBody接收； 2、多个对象需要封装到一个对象里才可以用@RequestBody接收。 查阅StackOverFlow，受到一个解决方案的启发，本人改进为以下版本，并给出了详尽的注释，希望对大家有帮助。 改进后的方案支持...
controller方法中简单参数@RequestBody无法处理
m0_37539286的博客
04-29 3210
1. @RequestBody 问题 @RequestBody 只能处理自定义对象，map, List(不可以)，只能标记一个参数 2. 自定义注解@RequestSingleBody解决单个参数 自定义注解@RequestSingleBody import org.springframework.core.annotation.AliasFor; import org.springframework.web.bind.annotation.ValueConstants; import java.lang
controller参数绑定
MrwanZH的博客
12-19 271
1、如果默认不加注解，默认是@RequestParam public GeneralResult investmentAnalysis(@RequestParam(value = "queryType") String queryType, @RequestParam(value = "token") String token, InvestmentAnalysisDto dto) 2、提交j...
Controller层接收前端传参的几种方法。@RequestParam、@RequestBody、@PathVariable。及参数校验。
努力努力，努力努力的博客
08-16 1万+
后端接收前端参数，接收参数方式，及参数校验
SpringMVC controller层 @RequestParam与@RequestBody的用法
qq_43595018的博客
12-15 1251
经过上面的测试，我们发现，对于get+application/json这种形式的请求，后端不加@RequestParam和@RequestBody注解是接收不到参数的，认为没有传参。于是int等基本类型的形参就会报错，Integer封装类型的参数以及自定义Use类型自动转换为null。加@RequestParam同样看不见参数，认为没传参。加@RequestBody看得到参数，能顺利接收自定义类型User,因为它可以将User的json字符串的反序列化为User对象（测试如下）。
@RequestParam注解介绍
weixin_41962432的博客
10-08 433
@RequestParam详解 @RequestParam主要用于将请求参数区域的数据映射到控制层方法的参数上 首先我们需要知道@RequestParam注解主要有哪些参数 1。value：请求中传入参数的名称，如果不设置后台接口的value值，则会默认为该变量名。比如上图中第一个参数如果不设置value=“page”,则前端传入的参数名必须为pageNum,否则在后台接口中pageNum将接收不...
Post接口传递@RequestParam对象时如何传递
最新发布
09-30
<think>我们正在讨论的是在Spring框架中，如何在POST接口中使用@RequestParam传递对象。 根据引用[1][2][3]的信息，我们知道： - @RequestParam主要用于从请求参数中获取值，这些参数通常出现在URL的查询字符串中，或者出现在表单提交的数据中（application/x-www-form-urlencoded）。 - 在POST请求中，我们可以将参数放在URL的查询字符串中（即Params），也可以放在请求体（body）中，但要求Content-Type是application/x-www-form-urlencoded或multipart/form-data（对于文件上传）等。 - @RequestParam可以用于多个参数，每个参数对应一个@RequestParam注解。 但是，用户提到“传递@RequestParam对象”，这里可能有两种理解： 1. 传递一个对象，这个对象的各个属性分别作为请求参数（即拆分成多个键值对）。 2. 传递一个对象作为单个请求参数（比如JSON字符串），然后用@RequestParam接收这个字符串。 通常，我们更常见的是第一种情况。因此，我们将重点放在如何将对象的属性拆分成多个键值对进行传递。 具体步骤： 1. **定义对象**：首先，我们有一个Java对象，它包含多个属性。 2. **发送请求**：在客户端，我们将对象的每个属性作为一个参数名（key），属性值作为参数值（value），以键值对的形式传递。 3. **接口接收**：在Controller的方法中，我们可以使用多个@RequestParam分别接收每个属性，或者使用一个对象（该对象有对应属性）接收（不需要@RequestParam注解，但需要保证属性名一致），或者使用@ModelAttribute。 但是，这里用户特别提到使用@RequestParam，所以我们考虑两种方式： 方式一：每个属性单独使用@RequestParam ```java @PostMapping("/example") public ResponseEntity<?> exampleMethod( @RequestParam String name, @RequestParam int age, @RequestParam String email) { // 使用这些参数构建对象或进行其他操作 MyObject obj = new MyObject(name, age, email); // ... } ``` 方式二：使用一个对象接收，但不用@RequestParam（实际上不使用任何注解，或者使用@ModelAttribute） ```java @PostMapping("/example") public ResponseEntity<?> exampleMethod(MyObject myObject) { // 这样Spring会自动将请求参数绑定到MyObject对象的属性上 // 前提是MyObject有对应的setter方法或构造函数 } ``` 注意：在第二种方式中，我们并没有显式使用@RequestParam，而是利用了Spring的数据绑定机制。但是，如果用户坚持要使用@RequestParam来接收一个对象，这是不可能的，因为@RequestParam一次只能接收一个简单的值（字符串、数字等）。 因此，我们通常推荐方式二，因为它更简洁。 但是，如果客户端传递的是一个嵌套对象呢？比如对象里面还有对象属性？Spring同样支持嵌套属性的绑定，只要参数名使用点号（.）来访问嵌套属性即可。 例如，对象如下： ```java public class User { private String name; private Address address; // getters and setters } public class Address { private String city; private String street; // getters and setters } ``` 在请求中，我们可以这样传递： ``` POST /user Content-Type: application/x-www-form-urlencoded name=John&address.city=NewYork&address.street=Broadway ``` 然后在Controller中： ```java @PostMapping("/user") public ResponseEntity<?> createUser(User user) { // user对象中的address属性也会被绑定 } ``` 但是，如果用户一定要用@RequestParam来接收整个对象（比如作为JSON字符串），那么我们可以这样做： 方式三：将整个对象作为JSON字符串传递，然后使用一个@RequestParam接收这个字符串，再手动转换为对象。 ```java @PostMapping("/example") public ResponseEntity<?> exampleMethod(@RequestParam String userJson) { ObjectMapper objectMapper = new ObjectMapper(); MyObject obj = objectMapper.readValue(userJson, MyObject.class); // ... } ``` 不过这种方式需要客户端先将对象转为JSON字符串，然后作为一个参数传递，而且Content-Type还是application/x-www-form-urlencoded（或者使用multipart/form-data）。但是这种方式并不常见，而且失去了Spring自动绑定的便利。 根据引用[4]，使用Axios传递多个参数（即方式一或方式二）的例子： 使用Axios发送POST请求（方式二，即自动绑定到对象）： ```javascript let user = { name: 'John', age: 30, email: 'john@example.com' }; // 注意：这里需要将对象转换为URLSearchParams形式，或者使用qs库 let params = new URLSearchParams(); for(let key in user) { params.append(key, user[key]); } axios.post('/example', params, { headers: { 'Content-Type': 'application/x-www-form-urlencoded' } }); ``` 或者，如果我们使用方式二（自动绑定对象），也可以这样写（使用qs库）： ```javascript import qs from 'qs'; axios.post('/example', qs.stringify(user), { headers: { 'Content-Type': 'application/x-www-form-urlencoded' } }); ``` 总结： 在POST接口中传递一个对象作为@RequestParam，实际上我们通常是将对象拆分成多个参数传递，然后在接口中要么用多个@RequestParam接收，要么用一个对象（不使用@RequestParam）接收。后者更简洁，也是Spring推荐的方式。 因此，推荐的方法是： 1. 客户端将对象属性拆成键值对，以`application/x-www-form-urlencoded`格式发送。 2. 服务端Controller方法使用一个对象（如`MyObject`）作为参数，不需要任何注解（或使用`@ModelAttribute`，但通常省略）。 这样Spring MVC会自动将请求参数绑定到对象上。 如果客户端希望发送JSON格式的对象（即放在请求体中），那么我们应该使用`@RequestBody`，但这不属于@RequestParam的范畴。 注意：引用[3]提到，在POST请求中，不能同时使用多个@RequestParam和一个@RequestBody，因为@RequestBody只能有一个，且会接收整个请求体。 因此，根据用户的问题，我们主要讨论的是使用@RequestParam来接收对象属性的情况，也就是将对象拆成多个简单属性，每个属性对应一个@RequestParam参数。但更简洁的方式是直接用一个对象接收。 回答结构： 1. 解释@RequestParam在POST请求中的使用场景。 2. 给出两种实现方式（多个@RequestParam vs 一个对象参数）。 3. 提供客户端发送请求的示例（使用Axios）。 4. 提示嵌套对象的处理方式。 5. 简要说明不推荐将整个对象作为JSON字符串用单个@RequestParam接收的原因。 最后，生成相关问题。 注意：引用[1][2][3][4]主要围绕@RequestParam和@RequestBody的使用，我们在回答中会适当引用。 </think>### POST接口传递@RequestParam对象的方法详解 在Spring Boot中，POST接口使用`@RequestParam`传递对象需将对象属性拆分为多个键值对参数。以下是具体实现方法： #### 1. **基础实现：拆分对象属性** 将对象属性拆分为独立参数，每个属性对应一个`@RequestParam`： ```java @PostMapping("/user") public ResponseEntity<User> createUser( @RequestParam String name, @RequestParam int age, @RequestParam String email) { User user = new User(name, age, email); return ResponseEntity.ok(user); } ``` **客户端请求示例**（Axios）： ```javascript axios.post('/user', null, { params: { name: '张三', age: 28, email: 'zhangsan@example.com' } }); ``` - 参数通过URL查询字符串传递，如：`/user?name=张三&age=28&email=zhangsan@example.com` - 适合简单对象，属性较少时使用[^2][^4] #### 2. **进阶实现：绑定到POJO对象** 使用POJO对象接收参数（无需`@RequestParam`）： ```java @PostMapping("/user") public ResponseEntity<User> createUser(User user) { // Spring自动将参数绑定到User对象的属性 return ResponseEntity.ok(user); } ``` **对象定义**： ```java public class User { private String name; private int age; private String email; // Getter/Setter省略 } ``` **客户端请求**： ```javascript // 注意Content-Type需设为application/x-www-form-urlencoded axios.post('/user', "name=张三&age=28&email=zhangsan@example.com", { headers: {'Content-Type': 'application/x-www-form-urlencoded'} }); ``` - 要求客户端使用`x-www-form-urlencoded`格式[^2][^4] - 参数名必须与POJO属性名严格匹配 #### 3. **嵌套对象处理** 对于嵌套对象，使用**点号语法**绑定属性： ```java public class Order { private String orderId; private User user; // 嵌套对象 } ``` **Controller**: ```java @PostMapping("/order") public ResponseEntity<Order> createOrder(Order order) { ... } ``` **客户端请求**： ``` POST /order Content-Type: application/x-www-form-urlencoded orderId=O001&user.name=张三&user.age=28&user.email=zhangsan@example.com ``` #### 4. **关键注意事项** 1. **Content-Type要求** 必须使用以下格式之一： - URL查询参数（`?key=value`） - `application/x-www-form-urlencoded` - `multipart/form-data`（含文件上传时）[^2][^3] 2. **参数必要性控制** - `@RequestParam(required=false)`：允许参数缺失 - 无注解时等同于`required=false`[^2] 3. **与@RequestBody对比** | 特性 | @RequestParam | @RequestBody | |--------------------|------------------------|----------------------| | 参数位置 | URL或form-data | 请求体(JSON/XML) | | 对象接收 | 需拆分属性或POJO绑定 | 直接接收完整对象 | | Content-Type | 非JSON格式 | application/json | | 参数数量 | 支持多个独立参数 | 整个请求体仅一个参数 | 4. **日期等特殊类型** 在POJO中使用`@DateTimeFormat`注解： ```java public class Event { @DateTimeFormat(pattern="yyyy-MM-dd") private Date eventDate; } ``` #### 5. **完整客户端示例（Axios）** ```javascript // 方法1：URL查询参数 axios.post('/user?name=张三&age=28&email=zhangsan@example.com'); // 方法2：form-data格式（推荐） const params = new URLSearchParams(); params.append('name', '张三'); params.append('age', 28); params.append('email', 'zhangsan@example.com'); axios.post('/user', params, { headers: { 'Content-Type': 'application/x-www-form-urlencoded' } }); ``` > **何时选择此方式**：当需要兼容传统表单提交、文件上传，或接口需同时支持GET/POST传参时[^1][^3]。复杂嵌套对象建议改用`@RequestBody`+JSON格式[^1][^3]。 --- ### 相关问题 1. 如何在POST请求中同时使用`@RequestParam`和`@RequestBody`？ 2. `@RequestParam`接收数组或集合类型参数的方法？ 3. Spring Boot如何全局处理`@RequestParam`的参数转换？ 4. 使用`@RequestParam`时如何防范参数注入攻击？ 5. 微服务场景下`@RequestParam`和`@PathVariable`的最佳实践？
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值