当前位置:首页 » 《关注互联网》 » 正文

详细分析Java中的@RequestParam和@RequestBody

14 人参与  2024年05月10日 18:00  分类 : 《关注互联网》  评论

点击全文阅读


目录

前言1. 基本知识2. 使用场景2.1 @RequestParam注解2.2 @RequestBody注解 3. 接口测试3.1 @RequestBody注解3.2 @RequestBody注解 4. 总结

前言

该知识点主要来源于SpringMVC:SpringMVC从入门到精通(全)

慢慢作为一名全栈,偶尔看项目使用@RequestParam或者@RequestBody,对此需要做一个深度的总结,防止混淆

1. 基本知识

@RequestParam注解用于从HTTP请求中提取查询参数或表单参数。

其中一些常用的属性参数包括namedefaultValuerequired

下面是对这三个属性参数的详细解释:

name属性:用于指定要提取的查询参数或表单参数的名称defaultValue属性:用于设置参数的默认值。(请求中没有提供相应的参数,将使用默认值)required属性:用于指定参数是否是必需的
设置为 true,则请求中必须包含相应的参数
设置为 false,则参数是可选的
@GetMapping("/example")public String exampleMethod(@RequestParam(name = "param",  defaultValue = "default", required = true) String param) {    // Method implementation}

@RequestBody注解用于从请求体中获取数据。

主要用于处理HTTP请求的请求体,通常用于接收JSON或XML格式的数据。

接收JSON数据: 通常用于接收通过POST请求发送的JSON数据

@PostMapping("/example")public String exampleMethod(@RequestBody ExampleDto exampleDto) {    // Method implementation}

其中自定义的对象如下:( 通常与自定义的Java对象结合使用,Spring将尝试将请求体映射到该对象。)

public class ExampleDto {    private String field1;    private int field2;        // Getters and setters}

其他数据格式: 除了JSON,@RequestBody也可以处理其他格式的数据,例如XML

@PostMapping("/example")public String exampleMethod(@RequestBody String xmlData) {    // Method implementation}

使用@RequestParam注解时更加灵活地处理查询参数或表单参数。

可以根据具体的需求,指定参数名、设置默认值以及确定参数是否是必需的

2. 使用场景

主要分析以下两种注解的常用形式,以及接口测试中是如何测试的

2.1 @RequestParam注解

处理查询参数:(处理HTTP GET请求中的查询参数)
当客户端通过URL传递参数时,可以使用@RequestParam将这些参数映射到方法的参数中。
@GetMapping("/search")public ResponseEntity<String> search(@RequestParam(name = "query") String query) {    // Method implementation}
处理表单参数:(通常用于处理HTTP POST请求中的表单数据)
当客户端通过表单提交数据时,可以使用@RequestParam将表单参数映射到方法的参数中。
@PostMapping("/submitForm")public ResponseEntity<String> submitForm(@RequestParam(name = "username") String username,                                         @RequestParam(name = "password") String password) {    // Method implementation}
设置默认值
使用@RequestParam可以为参数设置默认值,当请求中没有提供相应的参数时,将使用默认值。
@GetMapping("/example")public ResponseEntity<String> example(@RequestParam(name = "param", defaultValue = "default") String param) {    // Method implementation}
接收多个参数
@RequestParam允许接收多个参数,并将它们映射到方法的多个参数中。可以通过多次使用该注解来处理多个参数。
@GetMapping("/multipleParams")public ResponseEntity<String> multipleParams(@RequestParam(name = "param1") String param1,                                            @RequestParam(name = "param2") int param2) {    // Method implementation}

2.2 @RequestBody注解

处理非表单数据
@RequestBody适用于处理非表单格式的数据,例如JSON、XML等。当请求的数据不是通过表单提交,而是通过请求体中的结构化数据传递时,可以使用该注解。
// createObject方法接收的是一个自定义对象 MyObject,该对象的数据可以通过请求体中的JSON数据进行填充@PostMapping("/create")public ResponseEntity<String> createObject(@RequestBody MyObject myObject) {    // Method implementation}
接收复杂对象:(自动将请求体中的数据映射为方法参数所需的对象,无需手动解析)
当需要接收复杂的Java对象或自定义的数据结构时,使用@RequestBody更为方便
//updateObject方法接收的是一个包含更新数据的自定义请求对象 UpdateObjectRequest@PostMapping("/update")public ResponseEntity<String> updateObject(@RequestBody UpdateObjectRequest request) {    // Method implementation}
处理RESTful API请求:(@RequestBody使得处理这种情况变得更加简便)
需要从请求体中获取数据进行资源的创建、更新或其他操作
//updateResource方法接收的是路径中的资源标识符以及请求体中的数据@PutMapping("/update/{id}")public ResponseEntity<String> updateResource(@PathVariable Long id, @RequestBody ResourceData data) {    // Method implementation}
支持多种数据格式:(后端服务可以根据实际需求选择最适合的数据格式)
@RequestBody不限于特定的数据格式,因此可以支持多种数据格式的传递,包括JSON、XML等
//processData方法可以接收不同格式的数据对象,根据实际请求体中的数据格式进行处理@PostMapping("/process")public ResponseEntity<String> processData(@RequestBody DataObject data) {    // Method implementation}

3. 接口测试

3.1 @RequestBody注解

POST获取的接口都是带有参数的,此处的参数为String
测试代码如下:

在这里插入图片描述

对应的接口测试可以选择 Params 或者 Body 中的 x-www-form-urlencoded

在这里插入图片描述

或者如下图:
(由于删除功能此处做了逻辑删除,博主在后台改了属性又恢复回来了!)
对应的逻辑删除可看这篇文章:详细讲解MybatisPlus实现逻辑删除

在这里插入图片描述

3.2 @RequestBody注解

代码示例如下:

在这里插入图片描述

对于Apipost的测试软件,大致如下界面:

在这里插入图片描述

对于PostMan的测试接口界面如下,截图如下,对应需要选择raw中的Json格式,才可测试成功:(由于是下载Excel,对应会有乱码, 但是返回值为200)

在这里插入图片描述

4. 总结

@RequestParam适用于处理HTTP请求中的查询参数和表单参数,以及在需要设置默认值、接收多个参数的情况下使用。这使得在Spring MVC应用中,处理简单的参数传递变得更加方便。

@RequestBody注解适用于接收请求体中的结构化数据,特别是在处理非表单数据、接收复杂对象、处理RESTful API请求以及支持多种数据格式的情况下。
(一般用于处理非 Content-Type: application/x-www-form-urlencoded编码格式的数据,比如:application/jsonapplication/xml等类型的数据)

注意:前端使用$.ajax的话,一定要指定 contentType: "application/json;charset=utf-8;",默认为 application/x-www-form-urlencoded


点击全文阅读


本文链接:http://zhangshiyu.com/post/106520.html

<< 上一篇 下一篇 >>

  • 评论(0)
  • 赞助本站

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。

最新文章

  • 神秘人的冷宫废后新帝他是我裙下臣云渺沈烬全书在线
  • 被绝色小姨子陷害,我快顶不住了章节目录_陈精苏若熙无法释怀_小说后续在线阅读_无删减免费完结_
  • 家宴过后,我捉奸了庶妹和我老公无广告_庶妹老公侍卫TOP10_小说后续在线阅读_无删减免费完结_
  • 寝室六个人,她们背着我建五人群必读文_太天真申请书冷笑最新阅读_小说后续在线阅读_无删减免费完结_
  • 开局获得狐仙传承结局+番外_江帆赵雪隐藏剧情_小说后续在线阅读_无删减免费完结_
  • 刀锈春根生,白骨犹温完结全文_卫舟棠棠知意一口气完结_小说后续在线阅读_无删减免费完结_
  • 夫君立筷子定我灾星罪名,我改嫁冷宫皇子后他追悔莫及好评_赵荀孟如安青瑶精心编著_小说后续在线阅读_无删减免费完结_
  • 邻居低素质,而我没素质独家番外_老太太赖皮欣欣超长版_小说后续在线阅读_无删减免费完结_
  • 重生后我转嫁首富瘸腿独子,总裁前夫却疯了一口气看完_妹妹傅云琛沈明辉独家番外_小说后续在线阅读_无删减免费完结_
  • 我拒绝给系花捐款后,全系同学悔疯了在线阅读_小说后续在线阅读_无删减免费完结_
  • 我让位给女友的透视眼竹马,他却说如果能重生再也不来了。虐心反转_玉石林若女友推荐_小说后续在线阅读_无删减免费完结_
  • 相国独子的丫鬟砸坏我的玉佩后,我当场拒婚阅读_玉佩陈郡谢氏全新_小说后续在线阅读_无删减免费完结_

    关于我们 | 我要投稿 | 免责申明

    Copyright © 2020-2022 ZhangShiYu.com Rights Reserved.豫ICP备2022013469号-1