SpringBootWeb案例

今天的主要内容如下：

• 准备工作

• 部门管理

• 员工管理

1. 准备工作

1.1 需求&环境搭建

1.1.1 需求说明

• 查询部门列表

• 删除部门

• 新增部门

• 修改部门

• 查询员工列表(分页、条件)

• 删除员工

• 新增员工

• 修改员工

1.1.2 环境搭建

1. 准备数据库表(dept、emp)

2. 创建springboot工程，引入对应的起步依赖（web、mybatis、mysql驱动、lombok）

3. 配置文件application.properties中引入mybatis的配置信息，准备对应的实体类

4. 准备对应的Mapper、Service(接口、实现类)、Controller基础结构

• application.properties （直接把之前项目中的复制过来）

• 实体类

• DeptMapper

• EmpMapper

• DeptService

• DeptServiceImpl

• EmpService

• EmpServiceImpl

• DeptController

• EmpController

1.2 开发规范

后端开发人员：必须严格遵守提供的接口文档进行后端功能开发（保障开发的功能可以和前端对接）

• REST（Representational State Transfer），表述性状态转换，它是一种软件架构风格。

• GET ： 查询

• POST ：新增

• PUT ：修改

• DELETE ：删除

注意事项：

• REST是风格，是约定方式，约定不是规定，可以打破

• 描述模块的功能通常使用复数，也就是加s的格式来描述，表示此类资源，而非单个资源。如：users、emps、books…

1. 查看页面原型明确需求
• 根据页面原型和需求，进行表结构设计、编写接口文档(已提供)

2. 阅读接口文档

3. 思路分析

4. 功能接口开发
• 就是开发后台的业务功能，一个业务功能，我们称为一个接口

5. 功能接口测试
• 功能开发完毕后，先通过Postman进行功能接口测试，测试通过后，再和前端进行联调测试

6. 前后端联调测试
• 和前端开发人员开发好的前端工程一起测试

2. 部门管理

1. 查询部门

2. 删除部门

3. 新增部门

4. 更新部门（不讲解，自己独立完成）

2.1 查询部门

2.1.1 原型和需求

查询的部门的信息：部门ID、部门名称、修改时间

通过页面原型以及需求描述，我们可以看到，部门查询，是不需要考虑分页操作的。

2.1.2 接口文档

• 基本信息

• 请求参数
无

• 响应数据
参数格式：application/json
参数说明：

参数名	类型	是否必须	备注
code	number	必须	响应码，1 代表成功，0 代表失败
msg	string	非必须	提示信息
data	object[ ]	非必须	返回的数据
|- id	number	非必须	id
|- name	string	非必须	部门名称
|- createTime	string	非必须	创建时间
|- updateTime	string	非必须	修改时间

响应数据样例：

2.1.3 思路分析

2.1.4 功能开发

请求路径：/depts

请求方式：GET

请求参数：无

响应数据：json格式

@Slf4j注解源码：

2.1.5 功能测试

2.2 前后端联调

说明：只要按照接口文档开发功能接口，就能保证前后端程序交互

• 后端：严格遵守接口文档进行功能接口开发

• 前端：严格遵守接口文档访问功能接口

2.3 删除部门

2.3.1 需求

2.3.2 接口文档

• 基本信息

• 请求参数 参数格式：路径参数
参数说明：

参数名	类型	是否必须	备注
id	number	必须	部门ID

请求参数样例：

• 响应数据 参数格式：application/json
参数说明：

参数名	类型	是否必须	备注
code	number	必须	响应码，1 代表成功，0 代表失败
msg	string	非必须	提示信息
data	object	非必须	返回的数据

响应数据样例：

2.3.3 思路分析

接口文档规定：

• 前端请求路径：/depts/{id}

• 前端请求方式：DELETE

问题1：怎么在controller中接收请求路径中的路径参数？

问题2：如何限定请求方式是delete？

2.3.4 功能开发

请求路径：/depts/{id}

请求方式：DELETE

请求参数：路径参数 {id}

响应数据：json格式

2.3.5 功能测试

2.3.6 前后端联调

2.4 新增部门

2.4.1 需求

2.4.2 接口文档

• 基本信息

• 请求参数
格式：application/json
参数说明：

参数名	类型	是否必须	备注
name	string	必须	部门名称

请求参数样例：

• 响应数据
参数格式：application/json
参数说明：

参数名	类型	是否必须	备注
code	number	必须	响应码，1 代表成功，0 代表失败
msg	string	非必须	提示信息
data	object	非必须	返回的数据

响应数据样例：

2.4.3 思路分析

接口文档规定：

• 前端请求路径：/depts

• 前端请求方式：POST

• 前端请求参数 (Json格式)：{ "name": "教研部" }

问题1：如何限定请求方式是POST？

问题2：怎么在controller中接收json格式的请求参数？

2.4.4 功能开发

请求路径：/depts

请求方式：POST

请求参数：json格式

响应数据：json格式

2.4.5 功能测试

2.4.6 前后端联调

2.4.7 请求路径

以上三个方法上的请求路径，存在一个共同点：都是以/depts作为开头。（重复了）

优化前后的对比：

注意事项：一个完整的请求路径，应该是类上@RequestMapping的value属性 + 方法上的 @RequestMapping的value属性

3. 员工管理

1. 分页查询（今天完成）

2. 带条件的分页查询（今天完成）

3. 删除员工（今天完成）

4. 新增员工（后续完成）

5. 修改员工（后续完成）

3.1 分页查询

3.1.1 基础分页

3.1.1.1 需求分析

使用分页解决这个问题。每次只展示一页的数据，比如：一页展示10条数据，如果还想看其他的数据，可以通过点击页码进行查询。

查询第1页数据的SQL语句是：

查询第2页数据的SQL语句是：

查询第3页的数据的SQL语句是：

观察以上SQL语句，发现： 开始索引一直在改变 ， 每页显示条数是固定的

开始索引的计算公式： 开始索引 = (当前页码 - 1) * 每页显示条数

1. 前端在请求服务端时，传递的参数
• 当前页码 page
• 每页显示条数 pageSize

2. 后端需要响应什么数据给前端
• 所查询到的数据列表（存储到List 集合中）
• 总记录数

后台给前端返回的数据包含：List集合(数据列表)、total(总记录数)

而这两部分我们通常封装到PageBean对象中，并将该对象转换为json格式的数据响应回给浏览器。

3.1.1.2 接口文档

• 基本信息

• 请求参数
参数格式：queryString
参数说明：

参数名称	是否必须	示例	备注
name	否	张	姓名
gender	否	1	性别 , 1 男 , 2 女
begin	否	2010-01-01	范围匹配的开始时间(入职日期)
end	否	2020-01-01	范围匹配的结束时间(入职日期)
page	是	1	分页查询的页码，如果未指定，默认为1
pageSize	是	10	分页查询的每页记录数，如果未指定，默认为10

请求数据样例：

• 响应数据
参数格式：application/json
参数说明：

名称	类型	是否必须	默认值	备注	其他信息
code	number	必须	ㅤ	响应码, 1 成功 , 0 失败	ㅤ
msg	string	非必须	ㅤ	提示信息	ㅤ
data	object	必须	ㅤ	返回的数据	ㅤ
|- total	number	必须	ㅤ	总记录数	ㅤ
|- rows	object []	必须	ㅤ	数据列表	item 类型: object
|- id	number	非必须	ㅤ	id	ㅤ
|- username	string	非必须	ㅤ	用户名	ㅤ
|- name	string	非必须	ㅤ	姓名	ㅤ
|- password	string	非必须	ㅤ	密码	ㅤ
|- entrydate	string	非必须	ㅤ	入职日期	ㅤ
|- gender	number	非必须	ㅤ	性别 , 1 男 ; 2 女	ㅤ
|- image	string	非必须	ㅤ	图像	ㅤ
|- job	number	非必须	ㅤ	职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师	ㅤ
|- deptId	number	非必须	ㅤ	部门id	ㅤ
|- createTime	string	非必须	ㅤ	创建时间	ㅤ
|- updateTime	string	非必须	ㅤ	更新时间	ㅤ

响应数据样例：

3.1.1.3 思路分析

3.1.1.4 功能开发

请求路径：/emps

请求方式：GET

请求参数：跟随在请求路径后的参数字符串。 例：/emps?page=1&pageSize=10

响应数据：json格式

@RequestParam(defaultValue="默认值") //设置请求参数默认值

3.1.1.5 功能测试

3.1.1.6 前后端联调

3.1.2 分页插件

3.1.2.1 介绍

在Mapper接口中定义两个方法执行两条不同的SQL语句：

1. 查询总记录数

2. 指定页码的数据列表

在Service当中，调用Mapper接口的两个方法，分别获取：总记录数、查询结果列表，然后在将获取的数据结果封装到PageBean对象中。

大家思考下：在未来开发其他项目，只要涉及到分页查询功能(例：订单、用户、支付、商品)，都必须按照以上操作完成功能开发

PageHelper是Mybatis的一款功能强大、方便易用的分页插件，支持任何形式的单标、多表的分页查询。

官网：https://pagehelper.github.io/

在执行empMapper.list()方法时，就是执行：select * from emp 语句，怎么能够实现分页操作呢？

分页插件帮我们完成了以下操作：

1. 先获取到要执行的SQL语句：select * from emp

2. 把SQL语句中的字段列表，变为：count(*)

3. 执行SQL语句：select count(*) from emp //获取到总记录数

4. 再对要执行的SQL语句：select * from emp 进行改造，在末尾添加 limit ? , ?

5. 执行改造后的SQL语句：select * from emp limit ? , ?

3.1.2.2 代码实现

3.1.2.3 测试

后端程序SQL输出：

3.2 分页查询(带条件)

3.2.1 需求

• 姓名：模糊匹配

• 性别：精确匹配

• 入职日期：范围匹配

3.2.2 思路分析

3.2.3 功能开发

请求路径：/emps

请求方式：GET

请求参数：

参数名称	是否必须	示例	备注
name	否	张	姓名
gender	否	1	性别 , 1 男 , 2 女
begin	否	2010-01-01	范围匹配的开始时间(入职日期)
end	否	2020-01-01	范围匹配的结束时间(入职日期)
page	是	1	分页查询的页码，如果未指定，默认为1
pageSize	是	10	分页查询的每页记录数，如果未指定，默认为10

3.2.4 功能测试

控制台SQL语句：

3.2.5 前后端联调

3.3 删除员工

3.3.1 需求

3.3.2 接口文档

• 基本信息

• 请求参数
参数格式：路径参数
参数说明：

参数名	类型	示例	是否必须	备注
ids	数组 array	1,2,3	必须	员工的id数组

请求参数样例：

• 响应数据
参数格式：application/json
参数说明：

参数名	类型	是否必须	备注
code	number	必须	响应码，1 代表成功，0 代表失败
msg	string	非必须	提示信息
data	object	非必须	返回的数据

响应数据样例：

3.3.3 思路分析

接口文档规定：

• 前端请求路径：/emps/{ids}

• 前端请求方式：DELETE

问题1：怎么在controller中接收请求路径中的路径参数？

问题2：如何限定请求方式是delete？

问题3：在Mapper接口中，执行delete操作的SQL语句时，条件中的id值是不确定的是动态的，怎么实现呢？

3.3.4 功能开发

请求路径：/emps/{ids}

请求方式：DELETE

请求参数：路径参数 {ids}

响应数据：json格式

3.3.5 功能测试

控制台SQL语句：

3.3.6 前后端联调