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

已于 2022-08-03 23:17:42 修改
阅读量1w 收藏 86
点赞数 32
文章标签： 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采用这种方式进行参数映射

独一无二超级无敌炫彩发光大河豚
关注
  • 32
    点赞
  • 踩
  • 86
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
使用apidoc管理RESTful风格Flask项目接口文档方法
09-20
A Flask REST API example
【SpringMVC+RestFul】springmvc Controller接收前端参数的方式总结
南方有乔木的博客
05-21 371
【SpringMVC+RestFul】Controller接收前端参数的方式总结 参考博客：https://www.cnblogs.com/mjs154/p/11667796.html 1普通方式-请求参数名和Controller方法的参数一致 @Controller @RequestMapping("/param") public class TestParamController { private static final Logger logger = LoggerFactor.
使用RESTful风格api命名接口时，GET方法怎么传递多个参数
最新发布
m0_57540801的博客
03-18 410
调用之后的结果显示成功。但是，还有一种情况，假如传入的参数有的是非必选项，那么应该把可能出现的url在声明时全部列出来，并且把注解配置的参数设置为非必选（required=false），如下图：调用之后结果如下：由此可见，对于RESTful风格的接口，当查询接口需要传入一个或者两个参数的时候，编码起来较为简单，但是当传入3个以上参数的手，要列举出url的所有可能性还是比较复杂的。所以，RESTful风格的接口传入参数比较复杂时，还是尽量使用POST方法比较简便。
Spring Boot构建优雅的RESTful接口过程详解
08-25
主要介绍了spring boot构建优雅的RESTful接口过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
详解Spring框架之基于Restful风格实现的SpringMVC
08-30
主要介绍了详解Spring框架之基于Restful风格实现的SpringMVC，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
详解Spring cloud使用Ribbon进行Restful请求
08-27
主要介绍了详解Spring cloud使用Ribbon进行Restful请求，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
Day74.Restful风格、四种请求方式、Restful请求方式映射、重构影院系统
a111042555的博客
06-01 2918
Restful
Restful请求之@PutMapping使用总结
m0_67266042的博客
03-05 5335
接收方法中的注解常见注解： @PathVariable（路径变量）注解的使用 带占位符的 URL 是 Spring3.0 新增的功能,该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义。 @PathVariable(“xxx”) 通过 @PathVariable 可以将URL中占位符参数{xxx}绑定到处理器类的方法形参中@PathVariable(“xxx“) @RequestMapping(value=”user/{id}/{name}”) 请求路径：http://localh
restFul接口使用个人总结
qq_46539281的博客
07-25 1663
restFul风格，写接口，就使用这四种请求方法、get查询post新增put修改delete删除注意入参和出参的规则入参xxxDto出参xxxVoentity中存放实体类。
Restful Api写法心得之二《参数接收篇》
热门推荐
一切都是最好的安排
10-11 3万+
前言 温馨提示：可以订阅我的微信公众号，在手机里看技术文档也很不错哦o(￣︶￣)o 本篇文章主要说下接口的数据参数到底该如何接收，我们知道一个http请求最重要的意义就是将数据在服务器上进行传入与传出，本章主要讲的也就是传入。一次请求传递参数的方式主要有 URL路径中、请求头中、请求体中还有通过cookie等，下面我们分别对几种方式进行讲解。 MediaType的选择 MediaTyp
SpringBoot后端接口中的参数说明，收藏版本
Fish_Vast的博客
05-05 2249
    输入和输出参数对于后端接口而言是毋庸置疑的重要，但是对于刚入门的小伙伴而言，应该大部分在接口参数方面有过一定量的卡壳，哈哈，因为本人亦是如此！此篇博文就是针对基于SpringBoot框架后端接口中所出现的参数进行说明描述，这是本人对于一定量项目后的笔记和经验汇总，建议码住哦！毕竟是本人大脑输出的干货呀~ 目录1. Controller层输入参数的对比情况1.1. 类参数1.2. Map参数2. Mybatis的输入和输出参数对比情况2.1. parameterType：输入参数类型2.2. resu
Python利用Django如何写restful api接口详解
09-20
主要给大家介绍了关于Python利用Django如何写restful api接口的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
spring-boot-api:spring-boot 通用APP后端api接口 restful api接口 前后分离后端接口
05-01
Spring Boot restful api 形式接口 适用于APP后端接口服务 前后端分离项目提供接口服务 集成jpa（Java持久层API）ORM jpa的curd 原生curd MySQL分页 阿里数据库连接池druid 封装腾讯云CMQ相关接口 redis相关接口API jwt 权限认证 http等请求相关接口 定时任务 restful api标准，状态码返回，post、get，delete、update等方法调用规范化 restful api调用全局异常输出 logback日志输出，日志分割，打包 常用util封装 使用方法： clone项目到本地后，idea打开，直接启动DriverApplication即可
vue 调用 RESTful风格接口操作
10-14
主要介绍了vue 调用 RESTful风格接口操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
基于python Flask/Flask-Restful快速构建可用可靠的对外HTTP并符合Restful风格的接口.zip
03-03
基于python Flask/Flask-Restful快速构建可用可靠的对外HTTP并符合Restful风格的接口.zip 该项目能让你基于Flask与Flask-Restful之上构建一个良好Restful风格的API，让你快速构建一个能用于生产中的API，并提供良好的Metrics! 项目的特性 基于Flask/Flask-Restful ORM使用SQLAlchemy 具有metrics功能，可以方便通过decorator的方式让你随心监控某些API的运行指标 可部署在兼容uwsgi协议上的容器中（有uwsgi与gevent等的实现版本，gevent基于协程），当然也可以使用PyPy达到更高的性能 基于JWT(JSON Web Tokens)授权访问的机制（更多方式可以自己添加）保护API
restful接口示例代码
04-25
restful接口示例代码restful接口示例代码restful接口示例代码restful接口示例代码
后端接口调试软件
12-13
这是一款非常实用的后端接口调试工具，方便快捷，包含restful风格的接口测试请求。
restful风格请求，token鉴权实例
01-14
基于restful风格做的设计实例，即可jwt做token效验，实现增删查改,同时搭配自定义注解，方便过滤token验证
Ajax 请求后端接口是什么
05-13
在使用 Ajax 请求后端接口时，需要指定请求的 URL、请求方法、请求参数等信息，并且需要设置回调函数来处理接口的响应数据。后端接口可以是一个 RESTful API，也可以是一个简单的 HTTP 接口，只要能够通过 HTTP 协议...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值