Restful风格请求 后端接口参数接收详解

已于 2022-08-03 23:17:42 修改
阅读量1.2w 收藏 89
点赞数 33
文章标签： restful java 后端 spring boot postman
于 2022-08-03 22:20:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_66231801/article/details/126149714
版权

目录

一丶Restful风格的常用四种请求方式

1、GET [select]  

2、PUT [update]

3、POST [inser]

4、DELETE [delete]

二丶SpringBoot后端接口请求参数映射方式详解

1.映射基本类型参数 

2.映射对象类型参数

3.1 映射数组

3.2 映射Collection

3.3 映射List

3.4 映射Set

2.映射数组、集合类型参数

2.1 映射数组

2.2 映射Collection

2.3 映射List

2.4 映射Set

表单参数方式

1.映射基本类型参数

2.映射对象类型参数

3.映射数组、集合类型参数

3.1 映射数组

3.2 映射Collection

3.3 映射List

3.4 映射Set

FormData方式

请求体json方式

一丶Restful风格的常用四种请求方式

1、GET [select]  

请求会向数据库发索取数据的请求，从而来获取信息,其只是用来查询一下数据，不会修改、增加数据，不会影响资源的内容。无论进行多少次操作，结果都是一样的。

2、PUT [update]

  请求是向服务器端发送数据的，从而改变信息，其用来修改数据的内容，但是不会增加数据的种类等，无论进行多少次PUT操作，其结果并没有不同。

3、POST [inser]

请求同PUT请求类似，都是向服务器端发送数据的，但是该请求会改变数据的种类等资源.几乎目前所有的提交操作都是用POST请求的。

4、DELETE [delete]

请求是用来删除某一个资源的。

POST主要作用在一个集合资源之上的（url），而PUT主要作用在一个具体资源之上的（url/xxx）.如URL可以在客户端确定，那么可使用PUT，否则用POST。

一个URL地址，它用于描述一个网络上的资源，而HTTP中的GET，POST，PUT，DELETE就对应着对这个资源的查，改，增，删4个操作。

二丶SpringBoot后端接口请求参数映射方式详解

 在SpringBoot项目中，前端HTTP请求中的参数如何映射到Controller层的接口方法中的参数？这里针对各种方式做一个测试与总结，测试采用的SpringBoot版本号为2.2.10.RELEASE

QueryString参数传递的方式为，在请求URL中直接拼接请求参数，如URL?param1=value1&param2=value2

QueryString参数传递方式对于请求方法GET、POST、PUT、PATCH、DELETE都适用

1.映射基本类型参数 

可以在Controller的接口中声明基本类型的参数，然后用@RequestParam注解修饰，指定前端传递的参数名称 

@RestController
@RequestMapping("param")
@Slf4j
public class RequestParamTestController {
    @RequestMapping("queryString1")
    public void testQueryString1(@RequestParam("name") String name, @RequestParam("age") Integer age) {
        log.info("name:{}   age:{}", name, age);
    }
}

测试结果如下

如果请求参数名称和Controller中接口方法的参数名称一致，那么可以省略@RequestParam注解。不过一般还是建议加上

当请求参数名称和Controller中接口方法的参数名称一致时，加与不加@RequestParam的区别是：

加上@RequestParam，其属性required默认为true，那么当前端不传递对应的参数时将会抛出异常

不加@RequestParam，前端可以不传递对应参数，此时Controller接口方法中的参数接收到的值为null

2.映射对象类型参数

定义一个对象，属性名称和前端传递的参数名称一致即可

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private String name;
    private Integer age;
}

然后将Controller接口方法中的参数声明为自定义对象 

@RequestMapping("queryString2")
public void testQueryString2(User user) {
    log.info("name:{}   age:{}", user.getName(), user.getAge());
}

 测试结果如下

3.映射数组、集合类型参数

前端有2种方式针对同一个参数传递多个值：

在请求的QueryString中，拼接多个参数名称一样的参数即可，如URL?param=value1&param=value2&param=value3
在请求的QueryString中，对同一个参数赋多个值，多个值之间用,隔开，如URL?param=value1,value2,value3


3.1 映射数组

在Controller接口方法中声明数组类型参数，用@RequestParam指明前端传递的参数名称即可

@RequestMapping("queryString3")
public void testQueryString3(@RequestParam("name") String[] nameArray) {
    if (nameArray != null) {
        for (String name : nameArray) {
            log.info(name);
        }
    }
}

 测试结果如下

如果请求参数名称和Controller中接口方法的参数名称一致，那么可以省略@RequestParam注解。不过一般还是建议加上 

3.2 映射Collection

在Controller接口方法中声明Collection类型参数，用@RequestParam指明前端传递的参数名称即可

@RequestMapping("queryString4")
public void testQueryString4(@RequestParam("name") Collection<String> nameCollection) {
    if (nameCollection != null) {
        log.info("类型：{}", nameCollection.getClass());
        for (String name : nameCollection) {
            log.info(name);
        }
    }
}

测试结果如下

可以发现框架默认采用的实现类是LinkedHashSet。那我们继续测试传递相同value的时候是否也会采用这个实现

可以发现传递多个相同value的时候框架采用的实现类还是LinkedHashSet，所以有去重的效果

3.3 映射List

在Controller接口方法中声明List类型参数，用@RequestParam指明前端传递的参数名称即可

@RequestMapping("queryString5")
public void testQueryString5(@RequestParam("name") List<String> nameList) {
    if (nameList != null) {
        log.info("类型：{}", nameList.getClass());
        for (String name : nameList) {
            log.info(name);
        }
    }
}

测试结果如下

可以发现框架默认采用的实现类是ArrayList

3.4 映射Set

在Controller接口方法中声明Set类型参数，用@RequestParam指明前端传递的参数名称即可

@RequestMapping("queryString6")
public void testQueryString6(@RequestParam("name") Set<String> nameSet) {
    if (nameSet != null) {
        log.info("类型：{}", nameSet.getClass());
        for (String name : nameSet) {
            log.info(name);
        }
    }
}

 测试结果如下

可以发现框架默认采用的实现类是LinkedHashSet，与声明为Collection类型时一致

注意：

也可以在自定义对象中将属性声明为数组、集合类型，来接收多个值


对于映射Collection、List和Set类型参数时，即便前端提交的QueryString中的参数名称与Controller接口方法的参数名称一致，也不能省略@RequestParam注解，否则会抛出如下异常

路径参数方式

路径传参方式是将参数直接包含在URL路径中，比如URL/paramValue1/paramValue2

路径参数方式对于请求方法GET、POST、PUT、PATCH、DELETE都适用

1.映射基本类型参数
在Controller中用如下步骤接收参数：

1.在接口对应的请求路径中用{参数名}形式标出路径参数
2.在接口方法的参数上标注@PathVariable指名对应路径参数的参数名

@RequestMapping("path1/{name}/{age}")
public void testPath1(@PathVariable("name") String name, @PathVariable("age") Integer age) {
    log.info("name:{}   age:{}", name, age);
}

测试结果如下

如果接口方法上@RequestMapping中路径参数的参数名称和接口方法的参数名称相同，可以省略@PathVariable注解。但一般推荐加上

2.映射数组、集合类型参数

直接给路径参数多个值，用,隔开即可

2.1 映射数组

在Controller接口方法中声明数组类型参数，用@PathVariable指明路径参数的名称即可
 

@RequestMapping("path2/{name}/{age}")
public void testPath2(@PathVariable("name") String[] nameArray, @PathVariable("age") Integer[] ageArray) {
    for (String name : nameArray) {
        log.info(name);
    }
    for (Integer age : ageArray) {
        log.info(age.toString());
    }
}

测试结果如下

2.2 映射Collection

在Controller接口方法中声明Collection类型参数，用@PathVariable指明路径参数的名称即可

@RequestMapping("path3/{name}/{age}")
public void testPath3(@PathVariable("name") Collection<String> nameCollection, @PathVariable("age") Collection<Integer> ageCollection) {
    log.info("类型：{}", nameCollection.getClass());
    for (String name : nameCollection) {
        log.info(name);
    }
    for (Integer age : ageCollection) {
        log.info(age.toString());
    }
}

测试结果如下

 可以发现框架默认采用的类型是LinkedHashSet

2.3 映射List

在Controller接口方法中声明List类型参数，用@PathVariable指明路径参数的名称即可

@RequestMapping("path4/{name}/{age}")
public void testPath4(@PathVariable("name") List<String> nameList, @PathVariable("age") List<Integer> ageList) {
    log.info("类型：{}", nameList.getClass());
    for (String name : nameList) {
        log.info(name);
    }
    for (Integer age : ageList) {
        log.info(age.toString());
    }
}

测试结果如下

框架采用的实现类是ArrayList

2.4 映射Set

在Controller接口方法中声明Set类型参数，用@PathVariable指明路径参数的名称即可

@RequestMapping("path5/{name}/{age}")
public void testPath5(@PathVariable("name") Set<String> nameSet, @PathVariable("age") Set<Integer> ageSet) {
    log.info("类型：{}", nameSet.getClass());
    for (String name : nameSet) {
        log.info(name);
    }
    for (Integer age : ageSet) {
        log.info(age.toString());
    }
}

 测试结果如下

框架采用的实现类是LinkedHashSet

路径参数方式映射到Controller接口方法中的数组、Collection、List和Set类型参数时，即便路径中的参数名称和接口方法中的参数名称一致，也不能省略@PathVariable注解

表单参数方式

表单参数方式要求在请求头中携带Content-Type，值为application/x-www-form-urlencoded，并且请求体中以param:value形式携带参数，每行代表一个参数，多个参数就有多行

注意：表单参数方式不适用于GET请求，适用于POST、PUT、 PATCH、DELETE

1.映射基本类型参数

可以在Controller的接口中声明基本类型的参数，然后用@RequestParam注解修饰，指定请求体中的参数名称

@RequestMapping("form1")
public void testForm1(@RequestParam("name") String name, @RequestParam("age") Integer age) {
    log.info("name:{}   age:{}", name, age);
}

测试结果如下

2.映射对象类型参数

定义一个对象，属性名称和请求体中的参数名称一致即可

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private String name;
    private Integer age;
}

然后将Controller接口方法中的参数声明为自定义对象

@RequestMapping("form2")
public void testForm2(User user) {
    log.info("name:{}   age:{}", user.getName(), user.getAge());
}

测试结果如下

3.映射数组、集合类型参数

请求体中的参数如果想要传递多个值，有2种方式：

  • 直接给参数多个值，用,隔开即可
  • 声明多个参数名一样的参数

3.1 映射数组

在Controller接口方法中声明数组类型参数，用@RequestParam指明请求体中的参数名称即可

@RequestMapping("form3")
public void testForm3(@RequestParam("name") String[] nameArray) {
    for (String name : nameArray) {
        log.info(name);
    }
}

测试结果如下

3.2 映射Collection

在Controller接口方法中声明Collection类型参数，用@RequestParam指明请求体中的参数名称即可

@RequestMapping("form4")
public void testForm4(@RequestParam("name") Collection<String> nameCollection) {
    log.info("类型：{}", nameCollection.getClass());
    for (String name : nameCollection) {
        log.info(name);
    }
}

 测试结果如下

3.3 映射List

在Controller接口方法中声明List类型参数，用@RequestParam指明请求体中的参数名称即可

@RequestMapping("form5")
public void testForm5(@RequestParam("nameList") List<String> nameList) {
    log.info("类型：{}", nameList.getClass());
    for (String name : nameList) {
        log.info(name);
    }
}

 测试结果如下

3.4 映射Set

在Controller接口方法中声明Set类型参数，用@RequestParam指明请求体中的参数名称即可

@RequestMapping("form6")
public void testForm6(@RequestParam("name") Set<String> nameSet) {
    log.info("类型：{}", nameSet.getClass());
    for (String name : nameSet) {
        log.info(name);
    }
}

测试结果如下

也可以在自定义对象中将属性声明为数组、集合类型，来接收多个值

FormData方式

用于文件上传。要求在请求头中携带Content-Type，值为multipart/form-data。请求体中可以携带普通参数，也可以携带文件

Postman测试发现这种方式适用于GET、POST、PUT、PATCH、DELETE，但浏览器一般只能用POST表单提交进行文件上传，所以建议用POST请求

可以在Controller的接口中分别声明普通类型参数和文件类型参数，其中文件类型参数必须是MultipartFile类型，然后用@RequestParam注解修饰，指定请求体中对应的参数名称

@RequestMapping("formData1")
public void testFormData1(@RequestParam("fileName") String fileName, @RequestParam("file")MultipartFile file) {
    log.info("{}:{}", fileName, file.getSize());
}

测试结果如下

 FormData方式中的普通参数(即非文件类型参数)同样也可以利用数组、集合类型接收多个值，可以封装为自定义对象，方法与表单参数方式类似

请求体json方式

要求请求头携带Content-Type，值为application/json。请求体中的内容为json格式

 在Controller的接口方法映射这种请求参数只能通过自定义对象，自定义对象的属性名称要与请求体中json的属性名称一致，然后将自定义对象作为接口方法的参数，并标注@RequestBody注解，框架会自动将请求体的json转换为自定义对象

@RequestMapping("json1")
public void testJson1(@RequestBody User user) {
    log.info(user.toString());
}

测试结果如下

 经过PostMan测试发现，用GET方法发送这种请求也可以顺利接收到参数，但是一般浏览器不支持GET请求携带请求体数据，所以还是建议实际开发中只针对POST、PUT、PATCH、DELETE采用这种方式进行参数映射

Restful Api写法心得之二《参数接收篇》
一切都是最好的安排
10-11 3万+
前言 温馨提示：可以订阅我的微信公众号，在手机里看技术文档也很不错哦o(￣︶￣)o 本篇文章主要说下接口的数据参数到底该如何接收，我们知道一个http请求最重要的意义就是将数据在服务器上进行传入与传出，本章主要讲的也就是传入。一次请求传递参数的方式主要有 URL路径中、请求头中、请求体中还有通过cookie等，下面我们分别对几种方式进行讲解。 MediaType的选择 MediaTyp
RESTful 风格接口书写方式
exlinker的博客
08-22 2721
文章目录1 使用 RESTful 风格接口书写方式1.1 简介1.2 五种请求方式1.3 需要注意的问题1.4 对照学习2 GET 请求参数详解2.1 参数拼接于路径中2.2 以键值对形式拼接于路径中2.2.1 普通单个参数2.2.2 普通多个参数2.2.3 自定义参数名称2.2.4 可缺省参数2.2.5 默认值参数2.2.6 接收数组参数2.2.7 使用 map 接收参数2.2.8 使用对象接收参数 1 使用 RESTful 风格接口书写方式 1.1 简介 RESTful 的核心思想就是，客户端发出的数据
Restful风格的参数获取
m0_63378258的博客
12-15 1021
客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源
接口中的参数
最新发布
ny_forever的博客
08-28 556
在接口设计中，参数可以有多种类型，常见的包括路径参数（Path Parameter）、请求参数（Request Parameter）、请求体参数（Request Body Parameter）等。注解指定请求体的媒体类型，并在方法参数中定义对象，框架会自动解析请求体并映射到该对象。请求参数是一种从URL查询字符串中提取动态值的机制，常用于RESTful API中进行过滤、排序、分页等操作。路径参数是一种从URL路径中提取动态值的机制，常用于RESTful API中标识特定资源。注解定义路径参数，并使用。
restFul风格获取参数
shizaiwenyuan的博客
09-21 1542
package com.jt.controller; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; @Controller public class IndexController { /** * 关于通用页面
RESTFUL接口请求参数总结
wshten
08-14 7215
GET ： 1.路径参数 @PathVariable 2.表单参数 @RequestParam   POST： 1.JSON请求体参数   @RequestBody     PUT： 1.路径参数 @PathVariable 2.表单参数 @RequestParam   DELETE： 1.路径参数 @PathVariable 2.表单参数 @RequestParam...
Java进阶：SpringMVC中获取Restful风格的参数(从请求路径中获取参数 )
2401_83739777的博客
04-01 324
风格的请求是使用**“url+请求方式”**表示一次请求目的的，HTTP 协议里面四个表示操作方式的动词如下：GET：用于获取资源POST：用于新建资源PUT：用于更新资源DELETE：用于删除资源。
RESTful 风格（详细介绍 + 案例实现）
m0_67265919的博客
03-05 4372
这里写目录标题 RESTful 入门 一、什么是 API（应用程序接口） 二、传统模式和前后端分离模式对比 1. 传统开发模式 2. 前后端分离模式 三、RESTful 风格 1. 概念 2. 资源 3. 请求方式 4. 传统模式 URI 和 RESTful 风格对比 5. 返回值-按需求决定 6. HTTP响应状态码 7. 同一个资源具有多种表现形式(xml,json等) 8. 使用Ajax来发送各种请求方法的请求 9. 相关注解 10. RequestMapping标签的属性 四、
【Node.js】关于Node.js接口的详解和案例--restful风格接口。案例：添加商品接口，添加员工接口，删除员工接口
zhongqingtian的博客
05-10 725
【Node.js】关于Node.js接口的详解和案例--restful风格接口。案例：添加商品接口，添加员工接口，删除员工接口
Restful API 设计与实践：打造强大的后端接口
Restful API（Representational State Transfer）即表述性状态转移，是一种设计风格以及通信协议，用于在客户端与服务器之间进行交互。在Web开发中，Restful API被广泛应用于构建前后端分离的系统，提供数据的传输和...
Antd表格与后端数据接口对接技术详解
# 1. 理解Antd表格组件 ## 1.1 Antd表格的基本功能介绍 Antd表格是一个常用的前端组件，用于展示和处理大量数据。它提供了丰富的功能，包括分页、筛选、排序等，使用户可以轻松地管理和操作数据。...
请求接口参数
a560694091的博客
11-30 808
// return Vue.http.post('/aj_monitor/active', {params: params, headers: {'Content-Type': 'application/json'}})// return Vue.http.post('/aj_monitor/active', params, {emulateJSON: true})默认请求是： {'...
restful风格，restcontroller与controller
灯下尘
08-11 6080
restful风格，restcontroller与controller初步接触springmvc的时候，被要求使用restful风格，彼时一头雾水，不懂何谓restful，参阅了很多资料，慢慢的接触的也越来越多，如今spring的况且已基本运用熟练，简单谈一下我的一些看法，当然，只是我自己的浅显粗陋的见解，不对的地方还望指正。restful风格简单的理解，restful是一种url风格，或者说是规范
Spring-mvc获取请求Restful风格请求参数获取
weixin_51128948的博客
01-30 171
Spring-mvc获取请求Restful风格请求参数获取 文章目录Spring-mvc获取请求Restful风格请求参数获取
Restful接口接收数据案例
Peter_Changyb的博客
09-14 3428
1.构建工程 2. 实现FileuploadRestful类，继承Spring框架中的MultiActionController类，实现多文件接收 package com.cloud.controller; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; i...
restful里的resource类里的各种接收参数方式
u011038738的专栏
01-22 2929
一开始用的是@QueryParam来接收参数，后来学习中发现有@PathParam也可以接收，但是用法不一样，摆渡后，自己在这里做了总结： 一、@PathParam （@PathParam ，url中直接在斜杠后面添加参数值） 如，http://localhost:8181/managerinfo/rs/helloworld/user/frank 而resource里的写法是： @GET
RESTful API 名词解释：查询参数、请求体参数、响应参数、内容类型（Content-Type）、表单
宋冠巡的博客
03-27 2122
Restful API 设计 - 名词解释：查询参数、请求体参数、响应参数、内容类型（Content-Type）、表单
RESTful获取参数（javabeen）
bee_hzf的博客
04-08 416
项目场景： 通过前端传入的json数据，直接接收为javabeen 代码详情： js代码： var detailData = {}; detailData["id"]="23333"; detailData["name"]="电脑"; $.ajax({ type : "post", url : "/api/assets/test", data :JSON.stringify(detailData), traditi
Restful请求
qq_41923361的博客
07-13 2130
Restful请求 Restful请求是符合rst架构风格的网络API接口，完全承认HTTP是用于标识资源的，可以唯一标识和定位资源。Restful URL是面向资源的可以唯一标识和定位资源。对于该URL标识的资源做何种操作是由HTTP方法决定的。rest请求方法有4种，分别为：GET、POST、DELETE、PUT。 @PathVariable(“xxx”) 通过 @PathVariable 可以将URL中占位符参数{xxx}绑定到处理器类的方法形参中。 @RequestBody @RequestBody
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值