【SpringBoot篇】5种类型参数传递&&json数据传参的操作

秒速五厘米 2024-04-17 06:38 36阅读 0赞

> ?专栏【SpringBoot】  
> ?喜欢的诗句：天行健，君子以自强不息。  
> ?音乐分享【如愿】  
> ?欢迎并且感谢大家指出小吉的问题?

#### 文章目录 ####

*  ?普通参数
 *  ?POJO参数
 *  ?嵌套pojo参数
 *  ?数组参数
 *  ?集合参数
 *  ?json数据传参
 *   *  ?json格式
     *  ?嵌套json格式
     *  ?集合格式

![在这里插入图片描述][2a728acbb1f94dae83012b1795ca71a5.png]  
当涉及到参数传递时，Spring Boot遵循HTTP协议，并支持多种参数传递方式。这些参数传递方式可以根据请求的不同部分进行分类。

*  路径参数（Path Parameters）：  
    路径参数是指在URL路径中的一部分，用于标识资源或指定操作。路径参数通常以\{\}的形式出现在URL中，如/users/\{id\}，其中id就是一个路径参数。路径参数可以在URL中动态地改变，从而实现对不同资源的操作。使用路径参数时，Spring Boot使用@PathVariable注解将路径参数绑定到方法参数上。
 *  查询参数（Query Parameters）：  
    查询参数通常作为URL的一部分，以?开始，以key=value的形式出现，多个参数之间使用&连接，如/users?id=1&name=John。查询参数主要用于筛选或过滤资源。在Spring Boot中，可以使用@RequestParam注解将查询参数绑定到方法参数上。
 *  请求体参数（Request Body Parameters）：  
    请求体参数是通过HTTP请求体中发送的数据，通常用于传递复杂结构的数据，如JSON、XML等。请求体参数可以包含多个字段，并且可以表示更为复杂的数据模型。在Spring Boot中，可以使用@RequestBody注解将请求体参数绑定到方法参数上。
 *  表单参数（Form Parameters）：  
    表单参数通常使用HTML表单提交的数据，可以通过application/x-www-form-urlencoded或multipart/form-data格式传输。表单参数与查询参数类似，但是通常用于提交数据而不是进行筛选。在Spring Boot中，可以使用@RequestParam注解将表单参数绑定到方法参数上。
 *  请求头参数（Request Header Parameters）：  
    请求头参数包含在HTTP请求的头部信息中，可以用于传递附加的元数据，如鉴权信息、用户代理等。在Spring Boot中，可以使用@RequestHeader注解将请求头参数绑定到方法参数上。

使用理论进行讲解时，我们可以了解这些参数传递方式的原理和用途。根据HTTP协议的规范和Spring Boot的设计，开发人员可以选择合适的参数传递方式来满足业务需求。这些参数传递方式在RESTful API开发中非常常见，可以用于处理各种场景下的数据传输。

## ?普通参数 ##

我们在UserController类中写入这一段代码

@RequestMapping("/commonParamDifferentname")
        @ResponseBody
        public String commonParamDifferentName(@RequestParam("name") String userName,int age){
        
            System.out.println("普通参数传递 userName ==> "+userName);
            System.out.println("普通参数传递 age ==> "+age);
            return "{'module':'common param different name'}";
        }

![在这里插入图片描述][c674aeed0e50442f97d744cedecdab52.png]

接收成功  
![在这里插入图片描述][db54d1578a5b461e9f135e5d87a2f975.png]

## ?POJO参数 ##

我们在User类中写入这一段代码

package com.example.domain;
    
    public class User {
        
        private String name;
        private int age;
    
        private Address address;
    
    
        @Override
        public String toString() {
        
            return "User{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    ", address=" + address +
                    '}';
        }
    
        public Address getAddress() {
        
            return address;
        }
    
        public void setAddress(Address address) {
        
            this.address = address;
        }
    
        public String getName() {
        
            return name;
        }
    
        public void setName(String name) {
        
            this.name = name;
        }
    
        public int getAge() {
        
            return age;
        }
    
        public void setAge(int age) {
        
            this.age = age;
        }
    }

我们在UserController类中写入这一段代码

//POJO参数：请求参数与形参对象中的属性对应即可完成参数传递
        @RequestMapping("/pojoParam")
        @ResponseBody
        public String pojoParam(User user){
        
            System.out.println("pojo参数传递 user ==> "+user);
            return "{'module':'pojo param'}";
        }

![在这里插入图片描述][682def44101243b7b009684bff547f65.png]  
运行成功  
![在这里插入图片描述][2068351851ae46c08f0dc207fc73f8d0.png]

## ?嵌套pojo参数 ##

适用于下面这种,可以反复写  
![在这里插入图片描述][33116bcdfa3d42039debb03a8e017642.png]

我们在Address类中写入这一段代码

package com.example.domain;
    public class Address {
        
        private String province;
        private String city;
    
        @Override
        public String toString() {
        
            return "Address{" +
                    "province='" + province + '\'' +
                    ", city='" + city + '\'' +
                    '}';
        }
    
        public String getProvince() {
        
            return province;
        }
    
        public void setProvince(String province) {
        
            this.province = province;
        }
    
        public String getCity() {
        
            return city;
        }
    
        public void setCity(String city) {
        
            this.city = city;
        }
    }

在UserController里面写入这一段代码

@RequestMapping("/pojoContainPojoParam")
        @ResponseBody
        public String pojoContainPojoParam(User user){
        
            System.out.println("pojo嵌套pojo参数传递 user ==> "+user);
            return "{'module':'pojo contain pojo param'}";
        }

继续测试  
![在这里插入图片描述][0fbcd49da70d4daa945d9560b781b43b.png]

运行成功  
![在这里插入图片描述][f8f7fab15000407c84689606dd8e287f.png]

## ?数组参数 ##

@RequestMapping("/arrayParam")
        @ResponseBody
        public String arrayParam(String[] likes){
        
            System.out.println("数组参数传递 likes ==> "+ Arrays.toString(likes));
            return "{'module':'array param'}";
        }

![在这里插入图片描述][cbdb1adb6d1f42478c1473a833912975.png]

![在这里插入图片描述][0398cb7cba2a446483ef5d15961a39ea.png]  
运行成功  
![在这里插入图片描述][938af754f8b74f499bbbf158094d29b0.png]

## ?集合参数 ##

@RequestMapping("/listParam")
        @ResponseBody
        public String listParam(@RequestParam List<String> likes){
        
            System.out.println("集合参数传递 likes ==> "+ likes);
            return "{'module':'list param'}";
        }

![在这里插入图片描述][4c3ca7b6f46b4b03b3179826069fc36c.png]

![在这里插入图片描述][7868a8dffc2448a4abde621305ef9b47.png]  
运行成功  
![在这里插入图片描述][fbd0360dfdb542d5befb3fe0983865ce.png]

## ?json数据传参 ##

我们在SpringMvcConfig里面加入这一段代码`@EnableWebMvc`,开启json数据自动转换

![在这里插入图片描述][0a0bb0a953164eb7923cd783d13e395e.png]

### ?json格式 ###

> 我们找到上面 集合参数 的代码,把@RequestParam修改为@RequestBody

@RequestMapping("/listParamForJson")
        @ResponseBody
        public String listParamForJson(@RequestBody List<String> likes){
        
            System.out.println("list common(json)参数传递 list ==> "+likes);
            return "{'module':'list common for json param'}";
        }

![在这里插入图片描述][d102b753765e49019d64d77fe4addc7e.png]

这里选择json,在下面写入数据  
![在这里插入图片描述][42d39cbda3164e9a9ca74f70b1f2ae88.png]

发现可以运行成功  
![在这里插入图片描述][3f31ee9050f6486f9ef8715c8f4c5b74.png]

### ?嵌套json格式 ###

@RequestMapping("/pojoParamForJson")
        @ResponseBody
        public String pojoParamForJson(@RequestBody User user){
        
            System.out.println("pojo(json)参数传递 user ==> "+user);
            return "{'module':'pojo for json param'}";
        }

![在这里插入图片描述][c6983ab188a64d18b5c3aac60a81bdbd.png]  
运行成功

![在这里插入图片描述][a8e5bc074fbc4f40974d0acc1b8ecb5d.png]

### ?集合格式 ###

@RequestMapping("/listPojoParamForJson")
        @ResponseBody
        public String listPojoParamForJson(@RequestBody List<User> list){
        
            System.out.println("list pojo(json)参数传递 list ==> "+list);
            return "{'module':'list pojo for json param'}";
        }

> 如果报错,重启一下就好了  
> ![在这里插入图片描述][20f56ae9f1aa4081a552c7891ed49c5d.png]

![在这里插入图片描述][6f2cd52255a6421a952f15506a0c100a.png]  
运行成功  
![在这里插入图片描述][62acc9742db1480faddce56133b3dfc5.png]

![在这里插入图片描述][ccfdeddf28dc45ddbe66174d666cbd97.png]

[2a728acbb1f94dae83012b1795ca71a5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/8902a225429a4db0b94833e5c6174844.png
[c674aeed0e50442f97d744cedecdab52.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/14ad45df08504d498601320465460ba8.png
[db54d1578a5b461e9f135e5d87a2f975.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/86bf0ef912c54ce3af9ee3410ad98cac.png
[682def44101243b7b009684bff547f65.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/8022a9fb957045f0ab34f44a56891a7d.png
[2068351851ae46c08f0dc207fc73f8d0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/60d75e0ae7de4d68bfd34d1d5902e902.png
[33116bcdfa3d42039debb03a8e017642.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/d83199d4a470428b9a96f9a6aa21838e.png
[0fbcd49da70d4daa945d9560b781b43b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/05c4655e69e44c988b0df0eb32d59a21.png
[f8f7fab15000407c84689606dd8e287f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/957243a466974347b7c7a49a9fa72c6a.png
[cbdb1adb6d1f42478c1473a833912975.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/7229bc0a669b4e1f838383d4da2c757b.png
[0398cb7cba2a446483ef5d15961a39ea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/929fe1603af34aa0a1aab2041439e00c.png
[938af754f8b74f499bbbf158094d29b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/0a56b0e585cf46ad833cb734fc850855.png
[4c3ca7b6f46b4b03b3179826069fc36c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/1a28da3c70fc48eb86853b9014efc532.png
[7868a8dffc2448a4abde621305ef9b47.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/87fd21b6aba64248a3efdeeaef67831b.png
[fbd0360dfdb542d5befb3fe0983865ce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/8853bc252c7945be9c3ac6cc25eb4b44.png
[0a0bb0a953164eb7923cd783d13e395e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/884d98eb351341fca186078bc31664be.png
[d102b753765e49019d64d77fe4addc7e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/a6477ca9b74f43cfb539acd987479147.png
[42d39cbda3164e9a9ca74f70b1f2ae88.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/ef5f899311834bbe911fe586267e752d.png
[3f31ee9050f6486f9ef8715c8f4c5b74.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/d1f3b80c68fa4121a2edac9432f7e2da.png
[c6983ab188a64d18b5c3aac60a81bdbd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/0650998a91084a6e93827e2db9de6c94.png
[a8e5bc074fbc4f40974d0acc1b8ecb5d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/aa82ae2d0c4c4deb99b02811ac183061.png
[20f56ae9f1aa4081a552c7891ed49c5d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/182d28a89d554d46b058ad1cde8332be.png
[6f2cd52255a6421a952f15506a0c100a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/4bcb5a7891ff4eaba40d0aa394a1b132.png
[62acc9742db1480faddce56133b3dfc5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/a9fe4ba55d40478d8d7f6dabcf63a404.png
[ccfdeddf28dc45ddbe66174d666cbd97.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/44417f1374384685b351cb3fd0478f1b.png