Springboot——Controller层开发、请求与响应、RESTful开发规范

野性酷女 2024-03-31 11:34 80阅读 0赞

**目录**

一、入门案例（小了解，没啥用）

1.1 创建Springboot工程

1.2 导入maven坐标

1.3 controller层代码

1.4 postman测试

二、 REST常用注解

2.1 @Controller

2.2 @RequestMapping（请求映射路径）

2.3 @ResponseBody

2.4 @ComponentScan

2.5 @RequestParam

2.6 @RequestBody

2.7 @RequestBody、@RequestParam、@PathVariable区别

2.8 @DateTimeFormat

2.9 @PathVariable

2.10 @RestController

2.11 @PostMapping

三、请求与响应

3.1 请求方式

3.1.1 Get请求普通参数传递

3.1.2 Post请求普通参数传递

四、请求参数（了解，以后常用的是传JSON）

4.1 普通参数（不同名称的映射）

4.2 POJO类型参数

4.3 嵌套POJO类型参数

4.4 数组类型参数

4.5 集合类型参数

五、请求与响应（重要，传送JSON数据）

5.1 JSON请求参数

5.1.1 JSON数据

5.1.2 JSON对象（POJO）

5.1.3 JSON对象（POJO集合参数）

5.2 日期型参数传递

5.3 响应

5.3.1 响应页面（用的很少，几乎不用）

5.3.2 响应文本数据

5.3.3 响应JSON数据

六、REST风格

6.1 RESTful 快速开发（简化）

--------------------

## 一、入门案例（小了解，没啥用） ##

### 1.1 创建Springboot工程 ###

### 1.2 导入maven坐标 ###

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>

### 1.3 controller层代码 ###

@Controller //成功spring的bean  我们这里不使用@Component
                //@Controller  这是SpringMVC声明bean的专门注解
    public class UserController {
    
    
        /**
         * 提供给外部，处理请求的操作
         * @return
         */
        @RequestMapping("/save")   //设置当前操作的访问路径
        @ResponseBody                // 因为我们要返回一个JSON数据或者说是一个字符串，我们要再加一个ResponseBody注解
                                     //简单的说就是把我们要响应的东西作为一个整体内容返回到前端
        public String save(){
            System.out.println("user save...");
    //      我们选择return一个JSON数据
            return "{'module':'springboot'}";
        }
    
    
    }

### 1.4 postman测试 ###

当然这个时候post也可以

![f1a88819dd1f4836a6d3723d85698e69.png][]

## 二、 REST常用注解 ##

springboot中常用注解在下面这篇博客当中有一部分

> [Springboot中常用注解的使用语境、方法以及常用的maven坐标\_我爱布朗熊的博客-CSDN博客\_lombok maven坐标][Springboot_maven_-CSDN_lombok maven]

####  ####

### 2.1 @Controller ###

类型：类注解

作用：设定spring的核心控制器

@Controller //成功spring的bean  我们这里不使用@Component
                //@Controller  这是SpringMVC声明bean的专门注解
    public class UserController {
    }

### 2.2 @RequestMapping（请求映射路径） ###

类型：方法注解、类注解

作用：设置当前控制器方法请求访问路径，如果设置在类上统一设置当前控制器方法请求访问路径前缀

@RequestMapping("/save")   //设置当前操作的访问路径
        public void save(){
            System.out.println("user save...");
    
        }

![296ef8e7756e49a1b06ee0a6387a0431.png][]

当然这个注解也可以放到类上面，表示这个类中的方法请求路径的前缀，一般来说一个类的请求前缀都是一个样的，所以我们就没有必要在每个方法中都重复写相同的路径，我们把这一部分相同的路径提取出来放到类上面，这样就方便了我们以后的编码，也更好的将代码业务进行分类，避免出现同一个路径对应多个方法的错误形式

@Controller //成功spring的bean  我们这里不使用@Component
                //@Controller  这是SpringMVC声明bean的专门注解
    @RequestMapping("/save")   //设置当前层的请求前缀
    public class UserController {
    }

### 2.3 @ResponseBody ###

类型：方法注解

作用：设置当前控制器方法响应内容为当前返回值，无需解析

/**
         * 提供给外部，处理请求的操作
         * @return
         */
        @RequestMapping("/save")   //设置当前操作的访问路径
        @ResponseBody                // 因为我们要返回一个JSON数据或者说是一个字符串，我们要再加一个ResponseBody注解
                                     //简单的说就是把我们要响应的东西作为一个整体内容返回到前端
        public String save(){
            System.out.println("user save...");
    //      我们选择return一个JSON数据
            return "{'module':'springboot'}";
        }

### 2.4 @ComponentScan ###

![dd56fa6ec52e418e81ce86d96fe14809.png][]

###  **2.5 @RequestParam** ###

作用：当请求参数与形参变量名不同，使用@RequestParam绑定参数关系

![7daa8bb56ece45c3b867ebe3201dfa1e.png][]

还有**两个参数**

*   **required：是否为必传参数**
 *   **defaultValue：参数默认值**

### 2.6 @RequestBody ###

![5c80beb913f6499883c4f127a7ee0f79.png][]

### 2.7 @RequestBody、@RequestParam、@PathVariable区别 ###

![aaa4732a0f674353b4c1174dc9cbed45.png][]

![1857454451cd495fb796a416d8f29a2e.png][]

### 2.8 @DateTimeFormat ###

![6f56b33ae8e247c8bf965d8346ef4ef3.png][]

**内部有个Converter接口，就是将传递的参数和收集的参数的类型进行转换的**

![0ad0918dbb9a4f42be0f8a0c6d773843.png][]

![c9daafe1f6d84569b21217ba73604bcc.png][]

![b8fe8b357a494d90bbfe2d4922af15ea.png][]

### 2.9 @PathVariable ###

![e7665ca59a3045f1963742ff6411db99.png][]

### 2.10 @RestController ###

**@RestController == @ResponseBody+@Controller**

### 2.11 @PostMapping ###

**@PostMapping ==@RequestMapping( method = RequestMethod.POST )**

## 三、请求与响应 ##

### 3.1 请求方式 ###

#### 3.1.1 Get请求普通参数传递 ####

/**
         * 提供给外部，处理请求的操作
         * @return
         */
        @RequestMapping("/commonParam")   //设置当前操作的访问路径
        @ResponseBody                // 因为我们要返回一个JSON数据或者说是一个字符串，我们要再加一个ResponseBody注解
                                     //简单的说就是把我们要响应的东西作为一个整体内容返回到前端
        public String save(String name){
            System.out.println("普通参数传递 name="+name);
    //      我们选择return一个JSON数据
            return "{'module':'springboot'}";
        }

#### ![76c346b08b4143f5b1427cb89b219540.png][] ####

**传递多个参数呢？**

/**
         * 提供给外部，处理请求的操作
         * @return
         */
        @RequestMapping("/commonParam")   //设置当前操作的访问路径
        @ResponseBody                // 因为我们要返回一个JSON数据或者说是一个字符串，我们要再加一个ResponseBody注解
                                     //简单的说就是把我们要响应的东西作为一个整体内容返回到前端
        public String save(String name,String age){
            System.out.println("普通参数传递 name="+name);
            System.out.println("普通参数传递 age="+age);
    //      我们选择return一个JSON数据
            return "{'module':'springboot'}";
        }

![3042d1664cd148e580cd83257fcfaebf.png][]

![9f0ff1b986bd430fb41795ea86acb4e8.png][]

#### 3.1.2 Post请求普通参数传递 ####

我们可以看下图的变化，我们**选择了POST**，然后路径中**不再有各种Params**

对于请求体编辑参数的位置我们是**选择form-data还是x-www-form-urlencoded?**

![cab6f0b64bf944f4bf0be969f11c9b92.png][]

![f0b4d98f083349e7a406548af550a4f4.png][]

![3dc06744ecc74594b8852e2fb0283403.png][]

## 四、请求参数（了解，以后常用的是传JSON） ##

**参数种类：**

*  **普通参数**
 *  **POJO类型参数**
 *  **嵌套POJO类型参数**
 *  **数组类型参数**
 *  **集合类型参数**

### 4.1 普通参数（不同名称的映射） ###

我们还是看看刚刚的get请求

现在我们修改一个地方，**将发送请求时携带的params的参数名和后端接收的参数名不一致**

@RequestMapping("/commonParam")      //设置当前操作的访问路径
        @ResponseBody                          // 因为我们要返回一个JSON数据或者说是一个字符串，我们要再加一个ResponseBody注解
                                               //简单的说就是把我们要响应的东西作为一个整体内容返回到前端
        public String save(@RequestParam("name") String username, String age){
            System.out.println("普通参数传递 name="+username);
            System.out.println("普通参数传递 age="+age);
    //      我们选择return一个JSON数据
            return "{'module':'springboot'}";
        }

![6555f12908e844d8967c221242811de1.png][]

![b8a1c76922944d2482d1c36d634db2ca.png][]

### 4.2 POJO类型参数 ###

@RequestMapping("/pojoParam")
        @ResponseBody
        public String pojoParam(User user){
            System.out.println("普通参数传递 user="+user);
    
    //      我们选择return一个JSON数据
            return "{'module':'pojo param'}";
        }

![cf4683faf0f84895be123631bbd02616.png][]

![cc9a9697d2e244e189bb36bb27d40e7a.png][]

### 4.3 嵌套POJO类型参数 ###

public class User {
        private String name;
        private int age;
        private Address address;
    }

![18cab39317844329b023f0c56a3676c2.png][]

![b5a2e3e405da441e88c1c46c7b2c27b6.png][]

### **4.4 数组类型参数** ###

@RequestMapping("/arrayParam")
        @ResponseBody
        public String arrayParam(String[] likes){
            System.out.println("数组传参 like="+ Arrays.toString(likes));
    
    //      我们选择return一个JSON数据
            return "{'module':'arrays'}";
        }

![85792d82abbd4f0b85ed5f6ab4374fca.png][]

![5c7d91b3d36a4c26bcfa2e51685b89a3.png][]

### **4.5 集合类型参数** ###

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

![5b9f5c8d3fd34300b7161f3366a143aa.png][]

![8727ec34223c4dc8bb32597a1a00c1c6.png][]

## 五、请求与响应（重要，传送JSON数据） ##

### 5.1 JSON请求参数 ###

**分类：**

*   **JSON数据**
 *   **JSON对象（POJO）**
 *   **JSON数据（POJO）**

#### 5.1.1 JSON数据 ####

@RequestMapping("/listParamJson")
        @ResponseBody
        public String listParamJson(@RequestBody List<String> likes){
            System.out.println("集合参数传递 like="+ likes);
    
    //      我们选择return一个JSON数据
            return "{'module':'list param json'}";
        }

![5bd94e0f42804b9396db794c3d5a0631.png][]

![2415ceed19dc4e25b491b1587b42f51b.png][]

####  ####

#### 5.1.2 JSON对象（POJO） ####

![07143d722a7048e1854308301fd4c204.png][]

![0987a764a6ea4e019a6571eccde38e42.png][]

![2b979795064644a8b56d3519f7f97925.png][]

#### 5.1.3 JSON对象（POJO集合参数） ####

![cc2d84da95cb44dcb49e2ce8515540bb.png][]

![955bf68cebc54756872de1f4ebac04f9.png][]

### 5.2 日期型参数传递 ###

日期类型数据基于系统不同，格式也不尽相同

日期型的参数，可以直接由一个字符串转换成data

@RequestMapping("/dataParam")
        @ResponseBody
        public String dataParam(Date date){
            System.out.println("集合参数传递 date="+ date);
    
    //      我们选择return一个JSON数据
            return "{'module':'date '}";
        }

![a38c7ac78096471d961221cdb63bb1e7.png][]

![8ed053c352564caa9b3083bf1f2043be.png][]

但是当我们传递日期参数使用中行线的形式时，就会报错，就是下图中的date1形式，这怎么呢？

![363fc9867e0b44709874bb034f1532c5.png][]

将代码修改为下面这个样子就可以了

@RequestMapping("/dateParam")
        @ResponseBody
        public String dateParam(Date date, @DateTimeFormat(pattern = "yyyy-MM-dd") Date date1){
            System.out.println("集合参数传递 date="+ date);
            System.out.println("集合参数传递 date="+ date1);
    
    //      我们选择return一个JSON数据
            return "{'module':'date '}";
        }

![2705808218f1425f89ed6f07768fe741.png][]

![4408eaa7fff840a885230641c3b074a7.png][]

### 5.3 响应 ###

简单来说，将我们的处理结果返回给我们的用户（也可以说是前端，前端接收到页面后再渲染页面）

*  **响应页面**
 *   **响应数据 （文本数据、JSON数据）**

#### 5.3.1 响应页面（用的很少，几乎不用） ####

响应页面非常的简单，**将页面名称当做字符串返回**

![0ce38c9dd9a54bd994e19ff385cd8092.png][]

![30b017bd48cd41fb99c584dcf9abc356.png][]

#### 5.3.2 响应文本数据 ####

![c8420e3312204729a9a2adb9dd9148ec.png][]

#### 5.3.3 响应JSON数据 ####

![85a34ef29c684bc7ac4b979f920a7e0e.png][]

![a436d959d4014b8c8c7aa125815897be.png][]

![9374cf360a484796a8c4858b23af3168.png][]

![54e9650f05e44e48884b590a63105412.png][]

## 六、REST风格 ##

**REST ：表现形式状态转换**

![44a58b1fd1c549f791b87ec6a9070b16.png][]

**优点：**

**隐藏资源的访问行为，无法通过地址得知资源是何种操作**

**书写简化**

![bf30f02130004b7387ea7dfe6faf6e63.png][]

### 6.1 RESTful 快速开发（简化） ###

**这是之前的代码**

![64544b9f697e488c817a681304fc12fe.png][]

**现在的代码（很清晰）**

![d976d6e4aaba427b802d9736b58e4f9c.png][]

[f1a88819dd1f4836a6d3723d85698e69.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/7f45b5693c18411da41393ee668a6a34.png
[Springboot_maven_-CSDN_lombok maven]: https://blog.csdn.net/weixin_51351637/article/details/124545020?csdn_share_tail=%7B%22type%22%3A%22blog%22%2C%22rType%22%3A%22article%22%2C%22rId%22%3A%22124545020%22%2C%22source%22%3A%22weixin_51351637%22%7D
[296ef8e7756e49a1b06ee0a6387a0431.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/930fc0f1911144afa7246454dfa790cd.png
[dd56fa6ec52e418e81ce86d96fe14809.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/d1914bbb950b4a258f96e50108c3a6ec.png
[7daa8bb56ece45c3b867ebe3201dfa1e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/8576e89f04004592a3974ee0ca2f601b.png
[5c80beb913f6499883c4f127a7ee0f79.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/3b5060e07a4f423688b26e2f0fe9190d.png
[aaa4732a0f674353b4c1174dc9cbed45.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/105eb56fe2854ea9888a76b21d297c10.png
[1857454451cd495fb796a416d8f29a2e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/f0afb6eb14fc407494e0645ca6edbefa.png
[6f56b33ae8e247c8bf965d8346ef4ef3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/50eb8031c2a141568953d39091ec3043.png
[0ad0918dbb9a4f42be0f8a0c6d773843.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/a34a9a99660b4c3ca9aebd93550ba461.png
[c9daafe1f6d84569b21217ba73604bcc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/282b29158f084fae98f25c74d18a441b.png
[b8fe8b357a494d90bbfe2d4922af15ea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/8f772555982941ce9188e95e64d379c6.png
[e7665ca59a3045f1963742ff6411db99.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/13addbcdfefa474181ca1d124253f965.png
[76c346b08b4143f5b1427cb89b219540.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/6162c1ef55ef4860a2f752e3b4b450f0.png
[3042d1664cd148e580cd83257fcfaebf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/69926e21546f41028047b8bd70cc37de.png
[9f0ff1b986bd430fb41795ea86acb4e8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/f0320847ef8246ae859880ebb9e43465.png
[cab6f0b64bf944f4bf0be969f11c9b92.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/c48a46287fc149918aa3261cc398db5e.png
[f0b4d98f083349e7a406548af550a4f4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/c8ed2437fc4f41bfaae22125b36c6eb3.png
[3dc06744ecc74594b8852e2fb0283403.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/8165b7924fae489c9bec9fec997ed1aa.png
[6555f12908e844d8967c221242811de1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/d703ab38a6a240448a9b5f1a745956c4.png
[b8a1c76922944d2482d1c36d634db2ca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/dc8629315626409295c1598f3d8efe78.png
[cf4683faf0f84895be123631bbd02616.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/c67a016f7b284c7cb85263427e7413b4.png
[cc9a9697d2e244e189bb36bb27d40e7a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/b384826a40724360866eee0496df1deb.png
[18cab39317844329b023f0c56a3676c2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/52354975051b4f9b914270aac6a15da8.png
[b5a2e3e405da441e88c1c46c7b2c27b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/fc70711db1034bfe8a331d1e18b2c871.png
[85792d82abbd4f0b85ed5f6ab4374fca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/4199875d03c742368b95d308895c2a1b.png
[5c7d91b3d36a4c26bcfa2e51685b89a3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e81d6566f6c148eb9178614a28d23659.png
[5b9f5c8d3fd34300b7161f3366a143aa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/090703d5317e491fbbfd7df573fe946b.png
[8727ec34223c4dc8bb32597a1a00c1c6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e2bf1d41734c49f29e6e50d17bbb71d7.png
[5bd94e0f42804b9396db794c3d5a0631.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/ceef7c7174be4cd193c74bcab0cfdbb5.png
[2415ceed19dc4e25b491b1587b42f51b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/79157390cae343939e45af08c3bf8b94.png
[07143d722a7048e1854308301fd4c204.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/78e90b3744374f10b8ff09ca9986f804.png
[0987a764a6ea4e019a6571eccde38e42.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e41fa06850de4993b3feaf244804620b.png
[2b979795064644a8b56d3519f7f97925.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/9ba3fff1c09c4300b97259e811918658.png
[cc2d84da95cb44dcb49e2ce8515540bb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/467ee360b2024529a7a7a4283d7a8f90.png
[955bf68cebc54756872de1f4ebac04f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/d253b93a8bbc4b7ab4125774685e4669.png
[a38c7ac78096471d961221cdb63bb1e7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/8e2b01b31c2a4683948ef998d1318347.png
[8ed053c352564caa9b3083bf1f2043be.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/ca0f9a2a49f54968be63ad675afa3070.png
[363fc9867e0b44709874bb034f1532c5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/5a682b426cbb436ca220e63dfc26107d.png
[2705808218f1425f89ed6f07768fe741.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/350ca26502f74685885ad96fcf1d906c.png
[4408eaa7fff840a885230641c3b074a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/16cf92f2c34f4cac93e6a3f1d3b10512.png
[0ce38c9dd9a54bd994e19ff385cd8092.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/8aef6c4779da4d0897522dc58088a169.png
[30b017bd48cd41fb99c584dcf9abc356.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/a4d3281c701a4b3088ba307499a0fb51.png
[c8420e3312204729a9a2adb9dd9148ec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/3d278d8e34d042e59185e641135cc7d7.png
[85a34ef29c684bc7ac4b979f920a7e0e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/2da49a22cdda436c8da01465b8832da0.png
[a436d959d4014b8c8c7aa125815897be.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/bfa28cbcb8d94ff9a72e0d71fd600b55.png
[9374cf360a484796a8c4858b23af3168.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/1a71ca3e94254dc2bc61dd86cdeb1b4e.png
[54e9650f05e44e48884b590a63105412.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/1c6a3065bddc4986b23bfde344e1b005.png
[44a58b1fd1c549f791b87ec6a9070b16.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/e41d5b3e54584f008d8e1bd936725afe.png
[bf30f02130004b7387ea7dfe6faf6e63.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/46bf06ee832342b3957312b8af567846.png
[64544b9f697e488c817a681304fc12fe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/98b8bb414e4d4affa023ef366f612abd.png
[d976d6e4aaba427b802d9736b58e4f9c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/eb0e1c897cc449e0b1cf9f7aa660a1c1.png