这个案例呢,就是Tlias智能学习辅助系统。
参考接口文档完成后端功能的开 发,然后结合前端工程进行联调测试即可。
完成后的成品效果展示:
部门管理
部门管理功能开发包括:
● 查询部门列表
● 删除部门
● 新增部门
● 修改部门
员工管理
员工管理功能开发包括:
● 查询员工列表(分页、条件)
● 删除员工
● 新增员工
● 修改员工
步骤:
1.准备数据库表(dept、emp)
2.创建springboot工程,引入对应的起步依赖(web、mybatis、mysql驱动、lombok)
3.配置文件application.properties中引入mybatis的配置信息,准备对应的实体类
4.准备对应的Mapper、Service(接口、实现类)、Controller基础结构
第1步:准备数据库表
- -- 部门管理
- create table dept(
- id int unsigned primary key auto_increment comment '主键ID',
- name varchar(10) not null unique comment '部门名称',
- create_time datatime not null comment '创建时间',
- update_time datetime not null comment '修改时间'
- ) comment '部门表';
- -- 部门表测试数据
- insert into dept (id,name,create_time,update_time) values(1,'学工部',now(),now()),(2,'教研部',now(),now()),(3,'咨询部',now(),now()),(4,'就业步',now(),now()),(5,'人事部',now(),now());
-
- -- 员工管理(带约束)
- create table emp (
- id int unsigned primary key auto_increment comment 'ID',
- username varchar(20) not null unique comment '用户名',
- password varchar(32) default '123456' comment '密码',
- name varchar(10) not null comment '姓名',
- gender tinyint unsigned not null comment '性别, 说明: 1 男, 2 女',
- image varchar(300) comment '图像',
- job tinyint unsigned comment '职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师',
- entrydate date comment '入职时间',
- dept_id int unsigned comment '部门ID',
- create_time datetime not null comment '创建时间',
- update_time datetime not null comment '修改时间'
- ) comment '员工表';
- -- 员工表测试数据
- INSERT INTO emp
- (id, username, password, name, gender, image, job, entrydate,dept_id, create_time, update_time) VALUES
- (1,'jinyong','123456','金庸',1,'1.jpg',4,'2000-01-01',2,now(),now()),
- (2,'zhangwuji','123456','张无忌',1,'2.jpg',2,'2015-01-01',2,now(),now()),
- (3,'yangxiao','123456','杨逍',1,'3.jpg',2,'2008-05-01',2,now(),now()),
- (4,'weiyixiao','123456','韦一笑',1,'4.jpg',2,'2007-01-01',2,now(),now()),
- (5,'changyuchun','123456','常遇春',1,'5.jpg',2,'2012-12-05',2,now(),now()),
- (6,'xiaozhao','123456','小昭',2,'6.jpg',3,'2013-09-05',1,now(),now()),
- (7,'jixiaofu','123456','纪晓芙',2,'7.jpg',1,'2005-08-01',1,now(),now()),
- (8,'zhouzhiruo','123456','周芷若',2,'8.jpg',1,'2014-11-09',1,now(),now()),
- (9,'dingminjun','123456','丁敏君',2,'9.jpg',1,'2011-03-11',1,now(),now()),
- (10,'zhaomin','123456','赵敏',2,'10.jpg',1,'2013-09-05',1,now(),now()),
- (11,'luzhangke','123456','鹿杖客',1,'11.jpg',5,'2007-02-01',3,now(),now()),
- (12,'hebiweng','123456','鹤笔翁',1,'12.jpg',5,'2008-08-18',3,now(),now()),
- (13,'fangdongbai','123456','方东白',1,'13.jpg',5,'2012-11-01',3,now(),now()),
- (14,'zhangsanfeng','123456','张三丰',1,'14.jpg',2,'2002-08-01',2,now(),now()),
- (15,'yulianzhou','123456','俞莲舟',1,'15.jpg',2,'2011-05-01',2,now(),now()),
- (16,'songyuanqiao','123456','宋远桥',1,'16.jpg',2,'2007-01-01',2,now(),now()),
- (17,'chenyouliang','123456','陈友谅',1,'17.jpg',NULL,'2015-03-21',NULL,now(),now());
第2步:创建一个SpringBoot工程,选择引入对应的起步依赖(web、mybatis、mysql驱动、lombok) (版本选择2.7.5版本,可以创建完毕之后,在pom.xml文件中更改版本号)
生成的pom.xml文件:
- "1.0" encoding="UTF-8"?>
- <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0modelVersion>
- <parent>
- <groupId>org.springframework.bootgroupId>
- <artifactId>spring-boot-starter-parentartifactId>
- <version>2.7.5version>
- <relativePath/>
- parent>
- <groupId>com.itheimagroupId>
- <artifactId>tlias-web-managementartifactId>
- <version>0.0.1-SNAPSHOTversion>
- <name>tlias-web-managementname>
- <description>Demo project for Spring Bootdescription>
- <properties>
- <java.version>11java.version>
- properties>
- <dependencies>
- <dependency>
- <groupId>org.springframework.bootgroupId>
- <artifactId>spring-boot-starter-webartifactId>
- dependency>
- <dependency>
- <groupId>org.mybatis.spring.bootgroupId>
- <artifactId>mybatis-spring-boot-starterartifactId>
- <version>2.3.0version>
- dependency>
-
- <dependency>
- <groupId>com.mysqlgroupId>
- <artifactId>mysql-connector-jartifactId>
- <scope>runtimescope>
- dependency>
- <dependency>
- <groupId>org.projectlombokgroupId>
- <artifactId>lombokartifactId>
- <optional>trueoptional>
- dependency>
- <dependency>
- <groupId>org.springframework.bootgroupId>
- <artifactId>spring-boot-starter-testartifactId>
- <scope>testscope>
- dependency>
- dependencies>
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.springframework.bootgroupId>
- <artifactId>spring-boot-maven-pluginartifactId>
- <configuration>
- <excludes>
- <exclude>
- <groupId>org.projectlombokgroupId>
- <artifactId>lombokartifactId>
- exclude>
- excludes>
- configuration>
- plugin>
- plugins>
- build>
-
- project>
创建项目工程目录结构:
第3步:配置文件application.properties中引入mybatis的配置信息,准备对应的实体类
● application.properties (直接把之前项目中的复制过来)
- #数据库连接
- spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
- spring.datasource.url=jdbc:mysql://localhost:3306/tlias
- spring.datasource.username=root
- spring.datasource.password=1234
-
- #开启mybatis的日志输出
- mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
-
- #开启数据库表字段 到 实体类属性的驼峰映射
- mybatis.configuration.map-underscore-to-camel-case=true
● 实体类
- /*部门类*/
- @Data
- @NoArgsConstructor
- @AllArgsConstructor
- public class Dept {
- private Integer id;
- private String name;
- private LocalDateTime createTime;
- private LocalDateTime updateTime;
- }
- /*员工类*/
- @Data
- @NoArgsConstructor
- @AllArgsConstructor
- public class Emp {
- private Integer id;
- private String username;
- private String password;
- private String name;
- private Short gender;
- private String image;
- private Short job;
- private LocalDate entrydate;
- private Integer deptId;
- private LocalDateTime createTime;
- private LocalDateTime updateTime;
- }
第4步:准备对应的Mapper、Service(接口、实现类)、Controller基础结构
数据访问层:
● DeptMapper
- package com.itheima.mapper;
- import org.apache.ibatis.annotations.Mapper;
-
- @Mapper
- public interface DeptMapper {
- }
● EmpMapper
- package com.itheima.mapper;
- import org.apache.ibatis.annotations.Mapper;
-
- @Mapper
- public interface EmpMapper {
- }
业务层:
● DeptService
- package com.itheima.service;
-
- //部门业务规则
- public interface DeptService {
- }
● DeptServiceImpl
- package com.itheima.service.impl;
- import lombok.extern.slf4j.Slf4j;
- import org.springframework.stereotype.Service;
-
- //部门业务实现类
- @Slf4j
- @Service
- public class DeptServiceImpl implements DeptService {
- }
● EmpService
- package com.itheima.service;
-
- //员工业务规则
- public interface EmpService {
- }
● EmpServiceImpl
- package com.itheima.service.impl;
- import com.itheima.service.EmpService;
- import lombok.extern.slf4j.Slf4j;
- import org.springframework.stereotype.Service;
-
- //员工业务实现类
- @Slf4j
- @Service
- public class EmpServiceImpl implements EmpService {
-
- }
控制层:
● DeptController
- package com.itheima.controller;
- import org.springframework.web.bind.annotation.RestController;
-
- //部门管理控制器
- @RestController
- public class DeptController {
- }
● EmpController
- package com.itheima.controller;
- import org.springframework.web.bind.annotation.RestController;
-
- //员工管理控制器
- @RestController
- public class EmpController {
- }
项目工程结构:
我们按照前面学习的开发流程,开始完成功能开发。首先按照之前分析的需求,完成部门管理
的功能开发。
开发的部门管理功能包含:
1.查询部门
2.删除部门
3.新增部门
4.更新部门
查询的部门的信息:部门ID、部门名称、修改时间
通过页面原型以及需求描述,我们可以看到,部门查询,是不需要考虑分页操作的。
部门列表查询
● 基本信息
请求路径:/depts
请求方式:GET
接口描述:该接口用于部门列表数据查询
● 请求参数
无
● 响应数据
参数格式:application/json
参数说明:
参数名 | 类型 | 是否必须 | 备注 |
---|---|---|---|
code | number | 必须 | 响应码,1 代表成功,0 代表失败 |
msg | string | 非必须 | 提示信息 |
data | object[ ] | 非必须 | 返回的数据 |
|- id | number | 非必须 | id |
|- name | string | 非必须 | 部门名称 |
|- createTime | string | 非必须 | 创建时间 |
|- updateTime | string | 非必须 | 修改时间 |
响应数据样例:
- {
- "code": 1,
- "msg": "success",
- "data": [
- {
- "id": 1,
- "name": "学工部",
- "createTime": "2022-09-01T23:06:29",
- "updateTime": "2022-09-01T23:06:29"
- },
- {
- "id": 2,
- "name": "教研部",
- "createTime": "2022-09-01T23:06:29",
- "updateTime": "2022-09-01T23:06:29"
- }
- ]
- }
通过查看接口文档:部门列表查询
请求路径:/depts
请求方式:GET
请求参数:无
响应数据:json格式
DeptController
- @Slf4j
- @RestController
- public class DeptController {
- @Autowired
- private DeptService deptService;
-
- //@RequestMapping(value = "/depts" , method = RequestMethod.GET)
- @GetMapping("/depts")
- public Result list(){
- log.info("查询所有部门数据");
- List
deptList = deptService.list(); - return Result.success(deptList);
- }
- }
@Slf4j注解源码:
DeptService(业务接口)
- public interface DeptService {
- /**
- * 查询所有的部门数据
- * @return 存储Dept对象的集合
- */
- List
list(); - }
DeptServiceImpl(业务实现类)
- @Slf4j
- @Service
- public class DeptServiceImpl implements DeptService {
- @Autowired
- private DeptMapper deptMapper;
-
- @Override
- public List
list() { - List
deptList = deptMapper.list(); - return deptList;
- }
- }
DeptMapper
- @Mapper
- public interface DeptMapper {
- //查询所有部门数据
- @Select("select id, name, create_time, update_time from dept")
- List<Dept> list();
- }
功能开发完成后,我们就可以启动项目,然后打开postman,发起GET请求,访问 :http://localhost:8080/depts
说明:只要按照接口文档开发功能接口,就能保证前后端程序交互
● 后端:严格遵守接口文档进行功能接口开发
● 前端:严格遵守接口文档访问功能接口
点击部门列表后面操作栏的 "删除" 按钮,就可以删除该部门信息。 此时,前端只需要给服务端传递一个ID参数就可以了。 我们从接口文档中也可以看得出来。
删除部门
● 基本信息
请求路径:/depts/{id}
请求方式:DELETE
接口描述:该接口用于根据ID删除部门数据
● 请求参数
参数格式:路径参数
参数说明:
参数名 | 类型 | 是否必须 | 备注 |
id | number | 必须 | 部门ID |
请求参数样例:
/depts/1
● 响应数据
参数格式:application/json
参数说明:
参数名 | 类型 | 是否必须 | 备注 |
code | number | 必须 | 响应码,1代表成功,0代表失败 |
msg | string | 非必须 | 提示信息 |
data | object | 非必须 | 返回的数据 |
响应数据样例:
- {
- "code":1,
- "msg":"success",
- "data":null
- }
接口文档规定:
● 前端请求路径:/depts/{id}
● 前端请求方式:DELETE
问题1:怎么在controller中接收请求路径中的路径参数?
@PathVariable
问题2:如何限定请求方式是delete?
@DeleteMapping
通过查看接口文档:删除部门
请求路径:/depts/{id}
请求方式:DELETE
请求参数:路径参数 {id}
响应数据:json格式
DeptController
- @Slf4j
- @RestController
- public class DeptController {
- @Autowired
- private DeptService deptService;
-
- @DeleteMapping("/depts/{id}")
- public Result delete(@PathVariable Integer id) {
- //日志记录
- log.info("根据id删除部门");
- //调用service层功能
- deptService.delete(id);
- //响应
- return Result.success();
- }
-
- //省略...
- }
DeptService
- public interface DeptService {
-
- /**
- * 根据id删除部门
- * @param id 部门id
- */
- void delete(Integer id);
-
- //省略...
- }
DeptServiceImpl
- @Slf4j
- @Service
- public class DeptServiceImpl implements DeptService {
- @Autowired
- private DeptMapper deptMapper;
-
- @Override
- public void delete(Integer id) {
- //调用持久层删除功能
- deptMapper.deleteById(id);
- }
-
- //省略...
- }
DeptMapper
- @Mapper
- public interface DeptMapper {
- /**
- * 根据id删除部门信息
- * @param id 部门id
- */
- @Delete("delete from dept where id = #{id}")
- void deleteById(Integer id);
-
- //省略...
- }
删除功能开发完成后,重新启动项目,使用postman,发起DELETE请求:
打开浏览器,测试后端功能接口: