SpringBoot入门教程(三):员工部门管理系统(案例)

7. SpringBootWeb 案例

前面我们已经讲解了Web后端开发的基础(HTTP协议、请求响应),并且也讲解了数据库MySQL,以及通过Mybatis框架如何来完成数据库的基本操作。那接下来,我们就通过一个案例,来将前端开发、后端开发、数据库整合起来。 而这个案例呢,就是我们前面提到的Tlias智能学习辅助系统。

7.1 准备工作

7.1.1 功能需求和项目搭建

功能需求

部门管理功能开发包括:

  • 查询部门列表
  • 删除部门
  • 新增部门
  • 修改部门

员工管理功能开发包括:

  • 查询员工列表(分页、条件)
  • 删除员工
  • 新增员工
  • 修改员工

步骤:

  1. 准备数据库表(dept、emp)
  2. 创建springboot工程,引入对应的起步依赖(web、mybatis、mysql驱动、lombok)
  3. 配置文件application.properties中引入mybatis的配置信息,准备对应的实体类
  4. 准备对应的Mapper、Service(接口、实现类)、Controller基础结构

数据准备:

-- 部门管理
create table dept(
    id int unsigned primary key auto_increment comment '主键ID',
    name varchar(10) not null unique comment '部门名称',
    create_time datetime 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());

创建一个SpringBoot工程,选择引入对应的起步依赖:

springboot_anli1.png

springboot_anli2.png

创建项目工程目录结构:

springboot_anli3.png

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

#数据库连接
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.logImpl=org.apache.ibatis.logging.stdout.StdOutImpl

#开启数据库表字段 到 实体类属性的驼峰映射
mybatis.configuration.mapUnderscoreToCamelCase=true

实体类:

/*部门类*/
@Data
@AllArgsConstructor
@NoArgsConstructor
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;
}

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

数据访问层:

import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface DeptMapper {
}
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface EmpMapper {
}

业务层:

//部门业务规则
public interface DeptService {
}
// 部门业务实现类
@Slf4j
@Service
public class DeptServiceImpl implements DeptService {
}
//员工业务规则
public interface EmpService {
}
@Slf4j
@Service
public class EmpServiceImpl implements EmpService {
}

控制层:

@RestController
public class EmpController {
}
@RestController
public class DeptController {
}

项目目录结构:

springboot_anli4.png

7.1.2 开发规范

而在前后端进行交互的时候,我们需要基于当前主流的REST风格的API接口进行交互。

传统URL风格如下:

http://localhost:8080/user/getById?id=1     GET:查询id为1的用户
http://localhost:8080/user/saveUser         POST:新增用户
http://localhost:8080/user/updateUser       POST:修改用户
http://localhost:8080/user/deleteUser?id=1  GET:删除id为1的用户

我们看到,原始的传统URL呢,定义比较复杂,而且将资源的访问行为对外暴露出来了。

基于REST风格URL如下:

http://localhost:8080/users/1  GET:查询id为1的用户
http://localhost:8080/users    POST:新增用户
http://localhost:8080/users    PUT:修改用户
http://localhost:8080/users/1  DELETE:删除id为1的用户

其中总结起来,就一句话:通过URL定位要操作的资源,通过HTTP动词(请求方式)来描述具体的操作

在REST风格的URL中,通过四种请求方式,来操作数据的增删改查。

  • GET : 查询
  • POST :新增
  • PUT :修改
  • DELETE :删除

统一响应结果

前后端工程在进行交互时,使用统一响应结果 Result。

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result {
    private Integer code;//响应码,1 代表成功; 0 代表失败
    private String msg;  //响应信息 描述字符串
    private Object data; //返回的数据

    //增删改 成功响应
    public static Result success(){
        return new Result(1,"success",null);
    }
    //查询 成功响应
    public static Result success(Object data){
        return new Result(1,"success",data);
    }
    //失败响应
    public static Result error(String msg){
        return new Result(0,msg,null);
    }
}

7.1.3 前后端联调(Nginx)

下载文件:nginx-1.22.0-tlias.zip

解压到不含中文和空格的目录下:

springboot_anli5.png

springboot_anli6.png

打开任务管理器,可以看到nginx已经在后台运行。

springboot_anli7.png

打开浏览器访问:http://localhost:90

springboot_anli8.png

7.2 部门管理

7.2.1 查询部门

7.2.1.1 接口文档

基本信息

请求路径:/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"
    }
  ]
}

7.2.1.2 功能开发

DeptController

@Slf4j
@RestController
public class DeptController {
    @Autowired
    private DeptService deptService;
    @GetMapping("/depts")
    public Result list(){
        log.info("查询所有部门数据");
        List<Dept> deptList = deptService.list();
        return Result.success(deptList);
    }
}

DeptService(业务接口)

public interface DeptService {
    /*
    * 查询所有部门数据
    * @return 存储Dept对象的集合
    * */
    List<Dept> list();
}

DeptServiceImpl(业务实现类)

@Slf4j
@Service
public class DeptServiceImpl implements DeptService {
    @Autowired
    private DeptMapper deptMapper;
    @Override
    public List<Dept> list() {
        List<Dept> deptList = deptMapper.list();
        return deptList;
    }
}

DeptMapper

@Mapper
public interface DeptMapper {
    // 查询所有部门信息
    @Select("select id, name, create_time, update_time from dept")
    List<Dept> list();
}

7.2.1.3 功能测试

使用postman,发起GET请求,访问:http://localhost:8080/depts

springboot_anli9.png

7.2.1.4 前后端联调

打开浏览器,访问:http://localhost:90。测试:部门管理 - 查询部门列表。

springboot_anli10.png

7.2.2 删除部门

7.2.2.1 接口文档

基本信息

请求路径:/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
}

7.2.2.2 功能开发

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);

    // 省略...
}

7.2.2.3 功能测试

springboot_anli11.png

7.2.2.4 前后端联调

springboot_anli12.png

删除成功

springboot_anli13.png

7.2.3 新增部门

7.2.3.1 接口文档

基本信息

请求路径:/depts
请求方式:POST
接口描述:该接口用于添加部门数据    

请求参数

格式:application/json

参数说明:

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

请求参数样例:

{
    "name": "教研部"
}

响应数据

参数格式:application/json

参数说明:

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

响应数据样例:

{
    "code":1,
    "msg":"success",
    "data":null
}

问题1:如何限定请求方式是POST?

@PostMapping

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

@RequestBody:把前端传递的json数据填充到实体类中。

7.2.3.2 功能开发

DeptController

@Slf4j
@RestController
public class DeptController {
    @Autowired
    private DeptService deptService;
    @PostMapping("/depts")
    public Result add(@RequestBody Dept dept){
        // 记录日志
        log.info("新增部门:{}", dept);
        // 调用service层添加功能
        deptService.add(dept);
        // 响应
        return Result.success();
    }
    //省略...
}

DeptService

public interface DeptService {
    /**
     * 新增部门
     * @param dept 部门对象
     */
    void add(Dept dept);

    //省略...
}

DeptServiceImpl

@Slf4j
@Service
public class DeptServiceImpl implements DeptService {
    @Autowired
    private DeptMapper deptMapper;
    @Override
    public void add(Dept dept) {
        // 补全部门数据
        dept.setCreateTime(LocalDateTime.now());
        dept.setUpdateTime(LocalDateTime.now());

        // 调用持久层增加功能
        deptMapper.insert(dept);
    }

    //省略...
}

DeptMapper

@Mapper
public interface DeptMapper {
    /**
     * 插入部门
     * @param dept 部门信息
     */
    @Insert("insert into dept (name, create_time, update_time) values (#{name}, #{createTime}, #{updateTime})")
    void insert(Dept dept);

    // 省略...
}

7.2.3.3 功能测试

springboot_anli14.png

7.2.3.4 前后端联调

springboot_anli15.png

springboot_anli16.png

7.2.4 请求路径

我们完成了查询,删除,新增三个功能,在controller代码中可以看到,这三个功能对应的请求路径存在冗余。

查询url:/depts
删除url:/depts/{id}
新增url:/depts    

以上三个方法上的请求路径,存在一个共同点:都是以/depts作为开头。在Spring当中为了简化请求路径的定义,可以把公共的请求路径,直接抽取到类上,在类上加一个注解@RequestMapping,并指定请求路径"/depts"。代码参照如下:

@Slf4j
@RestController
@RequestMapping("/depts")
public class DeptController {
    @Autowired
    private DeptService deptService;
    @GetMapping("")
    public Result list(){
        log.info("查询所有部门数据");
        List<Dept> deptList = deptService.list();
        return Result.success(deptList);
    }

    @DeleteMapping("/{id}")
    public Result delete(@PathVariable Integer id){
        // 日志记录
        log.info("根据id删除部门");
        // 调用service层功能
        deptService.delete(id);
        return Result.success();
    }

    @PostMapping("")
    public Result add(@RequestBody Dept dept){
        // 记录日志
        log.info("新增部门:{}", dept);
        // 调用service层添加功能
        deptService.add(dept);
        // 响应
        return Result.success();
    }
}

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

7.3 员工管理

7.3.1 分页查询

7.3.1.1 基础分页

需求分析

我们之前做的查询功能,是将数据库中所有的数据查询出来并展示到页面上,试想如果数据库中的数据有很多(假设有十几万条)的时候,将数据全部展示出来肯定不现实,那如何解决这个问题呢?

springboot_anli17.png

要想从数据库中进行分页查询,我们要使用LIMIT关键字:

select * from emp limit 0, 10;
  1. 前端在请求服务端时,传递的参数
    • 当前页码 page
    • 每页显示条数 pageSize
  2. 后端需要响应什么数据给前端
    • 所查询到的数据列表(存储到List 集合中)
    • 总记录数

后台给前端返回的数据包含:List集合、total(总记录数),这两部分我们通常封装到PageBean对象中,并将该对象转换为json格式的数据响应给浏览器。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class PageBean {
    private Long total; // 总记录数
    private List rows; //当前页数据列表
}
接口文档
  • 基本信息

    请求路径:/emps
    请求方式:GET
    接口描述:该接口用于员工列表数据的条件分页查询
  • 请求参数

    参数格式:queryString

    参数说明:

    参数名称 是否必须 示例 备注
    page 1 分页查询的页码,如果未指定,默认为1
    pageSize 10 分页查询的每页记录数,如果未指定,默认为10

    请求数据样例:

    /emps?page=1&pageSize=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 非必须 更新时间

    响应数据案例:

    {
    "code": 1,
    "msg": "success",
    "data": {
      "total": 2,
      "rows": [
         {
          "id": 1,
          "username": "jinyong",
          "password": "123456",
          "name": "金庸",
          "gender": 1,
          "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-53B.jpg",
          "job": 2,
          "entrydate": "2015-01-01",
          "deptId": 2,
          "createTime": "2022-09-01T23:06:30",
          "updateTime": "2022-09-02T00:29:04"
        },
        {
          "id": 2,
          "username": "zhangwuji",
          "password": "123456",
          "name": "张无忌",
          "gender": 1,
          "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-53B.jpg",
          "job": 2,
          "entrydate": "2015-01-01",
          "deptId": 2,
          "createTime": "2022-09-01T23:06:30",
          "updateTime": "2022-09-02T00:29:04"
        }
      ]
    }
    }
功能开发

EmpController

@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {
    @Autowired
    private EmpService empService;
    // 条件分页查询
    @GetMapping
    public Result page(@RequestParam(defaultValue = "1") Integer page, @RequestParam(defaultValue = "10") Integer pageSize){
        // 记录日志
        log.info("分页查询,参数:{},{}", page, pageSize);
        // 调用业务层分页查询功能
        PageBean pageBean = empService.page(page, pageSize);
        return Result.success(pageBean);
    }
}

EmpService

//员工业务规则
public interface EmpService {
    /**
     * 条件分页查询
     * @param page 页码
     * @param pageSize  每页展示记录数
     * @return
     */
    PageBean page(Integer page, Integer pageSize);
}

EmpServiceImpl

@Slf4j
@Service
public class EmpServiceImpl implements EmpService {
    @Autowired
    private EmpMapper empMapper;
    @Override
    public PageBean page(Integer page, Integer pageSize) {
        // 1. 获取总记录数
        Long count = empMapper.count();

        // 2.获取分页查询结果列表
        Integer start = (page - 1) * pageSize;
        List<Emp> empList = empMapper.list(start, pageSize);

        // 3. 封装PageBean对象
        PageBean pageBean = new PageBean(count, empList);
        return pageBean;
    }
}

EmpMapper

@Mapper
public interface EmpMapper {
    // 获取记录总数
    @Select("select count(*) from emp")
    public Long count();

    // 获取当前页的结果列表
    @Select("select * from emp limit #{start}, #{pageSize}")
    public List<Emp> list(Integer start, Integer pageSize);
}
功能测试

springboot_anli18.png

前后端联调

springboot_anli19.png

7.3.1.2 分页插件

通过上述的案例我们能看出,分页查询分为两步:查询总记录数获取指定页码的数据列表,这也对应着两条不同的SQL语句。

在Service当中,调用Mapper接口的两个方法,分别获取:总记录数、查询结果列表,然后在将获取的数据结果封装到PageBean对象中。这种原始方式存在“步骤固定”、“代码繁琐”的问题。

我们可以使用一些现成的分页插件完成。对于Mybatis最主流的分页插件就是PageHelper

springboot_anli20.png

代码实现

当使用了PageHelper分页插件进行分页,就无需再Mapper中进行手动分页了。 在Mapper中我们只需要进行正常的列表查询即可。在Service层中,调用Mapper的方法之前设置分页参数,在调用Mapper方法执行查询之后,解析分页结果,并将结果封装到PageBean对象中返回。\

pom.xml中引入依赖

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.4.2</version>
</dependency>

EmpMapper

@Mapper
public interface EmpMapper {
    // 使用pagehelper获取当前页的结果列表
    @Select("select * from emp")
    public List<Emp> page();

    // 省略...
}

EmpServiceImpl

@Slf4j
@Service
public class EmpServiceImpl implements EmpService {
    @Autowired
    private EmpMapper empMapper;
    @Override
    public PageBean page(Integer page, Integer pageSize) {
        // 设置分页参数
        PageHelper.startPage(page, pageSize);
        // 执行分页查询
        List<Emp> empList = empMapper.page();
        // 获取分页结果
        Page<Emp> p = (Page<Emp>) empList;
        // 封装PageBean
        PageBean pageBean = new PageBean(p.getTotal(), p.getResult());
        return pageBean;
    }
}
测试

springboot_anli21.png

springboot_anli22.png

7.3.2 分页查询(带条件)

需求分析

springboot_anli23.png

通过员工管理的页面原型我们可以看到,员工列表页面的查询,不仅仅需要考虑分页,还需要考虑查询条件。 分页查询我们已经实现了,接下来,我们需要考虑在分页查询的基础上,再加上查询条件。

我们看到页面原型及需求中描述,搜索栏的搜索条件有三个,分别是:

  • 姓名:模糊匹配
  • 性别:精确匹配
  • 入职日期:范围匹配
select *
from emp
where 
    name like concat(%, '张', %)
    and gender = 1
    and entrydate = between '2000-01-01' and '2010-01-01'
order by update_time desc;

而且上述的三个条件,都是可以传递,也可以不传递的,也就是动态的。我们需要使用前面学习的Mybatis中的动态SQL 。

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

请求url:

/emps?name=张&gender=1&begin=2007-09-01&end=2022-09-01&page=1&pageSize=10

功能开发

EmpController

@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {
    @Autowired
    private EmpService empService;
    // 条件分页查询
    @GetMapping
    public Result page(
            @RequestParam(defaultValue = "1") Integer page,
            @RequestParam(defaultValue = "10") Integer pageSize,
            String name, Short gender,
             @DateTimeFormat(pattern = "yyyy-MM-dd") LocalDate begin,
             @DateTimeFormat(pattern = "yyyy-MM-dd") LocalDate end
            ){
        // 记录日志
        log.info("分页查询,参数:{},{},{},{},{},{}", page, pageSize,name, gender, begin, end);
        // 调用业务层分页查询功能
        PageBean pageBean = empService.pageCondition(page, pageSize, name, gender, begin, end);
        // 响应
        return Result.success(pageBean);
    }

    //省略...

}

EmpService

public interface EmpService {
    /**
     *
     * @param page 页码
     * @param pageSize 每页展示记录数
     * @param name  姓名
     * @param gender    性别
     * @param begin 开始时间
     * @param end   结束时间
     * @return
     */
    PageBean pageCondition(Integer page, Integer pageSize, String name, Short gender, LocalDate begin, LocalDate end);
}

EmpServiceImpl

@Slf4j
@Service
public class EmpServiceImpl implements EmpService {
    @Autowired
    private EmpMapper empMapper;
    @Override
    public PageBean pageCondition(Integer page, Integer pageSize, String name, Short gender, LocalDate begin, LocalDate end) {
        // 设置分页参数
        PageHelper.startPage(page, pageSize);
        // 执行条件分页查询
        List<Emp> empList = empMapper.pageCondition(name, gender, begin, end);
        // 获取查询结果
        Page<Emp> p = (Page<Emp>) empList;
        // 封装PageBean
        PageBean pageBean = new PageBean(p.getTotal(), p.getResult());
        return pageBean;

    }
    // 省略...
}

EmpMapper

@Mapper
public interface EmpMapper {
    public List<Emp> pageCondition(String name, Short gender, LocalDate begin, LocalDate end);
}

EmpMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ayanokouji.mapper.EmpMapper">
<!--    条件分页查询-->
    <select id="pageCondition" resultType="com.ayanokouji.pojo.Emp">
        select * from emp
        <where>
            <if test="name != null and name != ''">
                name like concat('%',#{name},'%')
            </if>
            <if test="gender != null">
                and gender = #{gender}
            </if>
            <if test="begin != null and end != null">
                and entrydate between #{begin} and #{end}
            </if>
        </where>
        order by update_time desc
    </select>
</mapper>

功能测试

springboot_anli24.png

控制台打印结果:

springboot_anli25.png

前后端联调

springboot_anli26.png

7.3.3 删除员工

接口文档

  • 基本信息

    请求路径:/emps/{ids}
    请求方式:DELETE
    接口描述:该接口用于批量删除员工的数据信息
  • 请求参数

    参数格式:路径参数

    参数说明:

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

    请求参数样例:

    /emps/1,2,3
  • 响应数据

    参数格式:application/json

    参数说明:

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

    响应数据样例

    {
      "code":1,
      "msg":"success",
      "data":null
    }

功能开发

EmpController

@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {
    @Autowired
    private EmpService empService;
    @DeleteMapping("/{ids}")
    public Result delete(@PathVariable List<Integer> ids){
        empService.delete(ids);
        return Result.success();
    }

    // 省略...
}

EmpService

public interface EmpService {
    /**
     *  批量删除
     * @param ids  id集合
     */
    void delete(List<Integer> ids);

    // 省略...
}

EmpServiceImpl

@Slf4j
@Service
public class EmpServiceImpl implements EmpService {
    @Autowired
    private EmpMapper empMapper;
    @Override
    public void delete(List<Integer> ids) {
        empMapper.delete(ids);
    }

    // 省略
}

EmpMapper

@Mapper
public interface EmpMapper {
    public void delete(List<Integer> ids);

    // 省略...
}

EmpMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ayanokouji.mapper.EmpMapper">
    <delete id="delete">
        delete from emp where id in
        <foreach collection="ids" item="id" open="(" close=")" separator=",">
            #{id}
        </foreach>
    </delete>
    // 省略...
</mapper>

功能测试

springboot_anli27.png

前后端联调

springboot_anli28.png

springboot_anli29.png

7.3.4 新增员工

接口文档

  • 基本信息

    请求路径:/emps
    请求方式:POST
    接口描述:该接口用于添加员工信息
  • 请求参数

    参数格式:application/json

    参数说明:

    名称 类型 是否必须 备注
    username string 必须 用户名
    name string 必须 姓名
    gender number 必须 性别, 说明: 1 男, 2 女
    image string 非必须 图像
    deptId number 非必须 部门id
    entrydate string 非必须 入职日期
    job number 非必须 职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师

    请求数据样例:

    {
    "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-03-07-37-38222.jpg",
    "username": "linpingzhi",
    "name": "林平之",
    "gender": 1,
    "job": 1,
    "entrydate": "2022-09-18",
    "deptId": 1
    }
  • 响应数据

    参数格式:application/json

    参数说明:

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

    响应数据样例:

    {
      "code":1,
      "msg":"success",
      "data":null
    }

功能开发

EmpController

@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {
    @Autowired
    private EmpService empService;
    // 新增
    @PostMapping
    public Result save(@RequestBody Emp emp){
        // 记录日志
        log.info("新增员工,emp:{}", emp);
        // 调用业务层服务
        empService.save(emp);
        // 响应
        return Result.success();
    }
    // 省略...
}

EmpService

public interface EmpService {
    /**
     *  新增员工
     * @param emp
     */
    void save(Emp emp);
    // 省略...
}

EmpServiceImpl

@Slf4j
@Service
public class EmpServiceImpl implements EmpService {
    @Autowired
    private EmpMapper empMapper;
    @Override
    public void save(Emp emp) {
        emp.setCreateTime(LocalDateTime.now());
        emp.setUpdateTime(LocalDateTime.now());

        empMapper.insert(emp);
    }
    // 省略...
}

EmpMapper

@Mapper
public interface EmpMapper {
    @Insert("insert into emp(username, name, gender, image, job, entrydate, dept_id, create_time, update_time) " +
            "values (#{username}, #{name}, #{gender}, #{image}, #{job}, #{entrydate}, #{deptId}, #{createTime}, #{updateTime});" )
    public void insert(Emp emp);

    // 省略...
}

功能测试

springboot_anli30.png

前后端联调

springboot_anli31.png

springboot_anli32.png

7.3.5 修改员工

在进行修改员工信息的时候,我们首先先要根据员工的ID查询员工的信息用于页面回显展示,然后用户修改员工数据之后,点击保存按钮,就可以将修改的数据提交到服务端,保存到数据库。 因此,该操作分为两步:根据ID查询员工信息保存修改的员工信息

7.3.5.1 查询回显

接口文档
  • 基本信息

    请求路径:/emps/{id}
    请求方式:GET
    接口描述:该接口用于根据主键ID查询员工的信息
  • 请求参数

    参数格式:路径参数

    参数说明:

    参数名 类型 是否必须 备注
    id number 必须 员工ID

    请求参数样例:

    /emps/1
  • 响应数据

    参数格式:application/json

    参数说明:

    名称 类型 是否必须 默认值 备注
    code number 必须 响应码, 1 成功 , 0 失败
    msg string 非必须 提示信息
    data 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 非必须 更新时间

    响应数据样例:

    {
    "code": 1,
    "msg": "success",
    "data": {
      "id": 2,
      "username": "zhangwuji",
      "password": "123456",
      "name": "张无忌",
      "gender": 1,
      "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-53B.jpg",
      "job": 2,
      "entrydate": "2015-01-01",
      "deptId": 2,
      "createTime": "2022-09-01T23:06:30",
      "updateTime": "2022-09-02T00:29:04"
    }
    }
功能开发

EmpController

@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {
    @Autowired
    private EmpService empService;
    // 根据id查询
    @GetMapping("/{id}")
    public Result getById(@PathVariable Integer id){
        Emp emp = empService.getById(id);
        return Result.success(emp);
    }

    // 省略...
}

EmpService

public interface EmpService {
    /**
     * 根据id查询员工信息
     * @param id 员工id
     * @return
     */
    public Emp getById(Integer id);

    // 省略...
}

EmpServiceImpl

@Slf4j
@Service
public class EmpServiceImpl implements EmpService {
    @Autowired
    private EmpMapper empMapper;
    @Override
    public Emp getById(Integer id) {
        Emp emp = empMapper.findById(id);
        return emp;
    }
    // 省略...
}

EmpMapper

@Mapper
public interface EmpMapper {
    @Select("select id, username, password, name, gender, image, job, entrydate, dept_id, create_time, update_time " +
            "from emp where id = #{id}")
    public Emp findById(Integer id);
    // 省略
}
功能测试

springboot_anli33.png

7.3.5.2 修改员工

接口文档
  • 请求方式:

    请求路径:/emps
    请求方式:POST
    接口描述:该接口用于修改员工数据
  • 请求参数:

    参数格式:application/json

    参数说明:

    名称 类型 是否必须 备注
    id number 必须 id
    username string 必须 用户名
    name string 必须 姓名
    gender number 必须 性别, 说明: 1 男, 2 女
    image string 非必须 图像
    deptId number 非必须 部门id
    entrydate string 非必须 入职日期
    job number 非必须 职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师

    请求数据样例:

    {
    "id": 1,
    "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-03-07-37-38222.jpg",
    "username": "linpingzhi",
    "name": "林平之",
    "gender": 1,
    "job": 1,
    "entrydate": "2022-09-18",
    "deptId": 1
    }
  • 响应数据

    参数格式:application/json

    参数说明:

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

    响应数据样例:

    {
      "code":1,
      "msg":"success",
      "data":null
    }
功能实现

EmpController

@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {
    @Autowired
    private EmpService empService;

    @PutMapping
    public Result update(@RequestBody Emp emp){
        empService.update(emp);
        return Result.success();
    }
    // 省略....
}

EmpService

public interface EmpService {
    /**
     *  更新员工
     * @param emp 员工信息
     */
    public void update(Emp emp);
    //省略...
}

EmpServiceImpl

@Slf4j
@Service
public class EmpServiceImpl implements EmpService {
    @Autowired
    private EmpMapper empMapper;
    @Override
    public void update(Emp emp) {
        emp.setUpdateTime(LocalDateTime.now());
        empMapper.update(emp);
    }
    // 省略...
}

EmpMapper

@Mapper
public interface EmpMapper {
    public void update(Emp emp);
    // 省略...
}

EmpMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ayanokouji.mapper.EmpMapper">
    <update id="update">
        update emp
        <set>
            <if test="username != null and username != ''">
                username = #{username},
            </if>
            <if test="password != null and password != ''">
                password = #{password},
            </if>
            <if test="name != null and name != ''">
                name = #{name},
            </if>
            <if test="gender != null">
                gender = #{gender},
            </if>
            <if test="image != null and image != ''">
                image = #{image},
            </if>
            <if test="job != null">
                job = #{job},
            </if>
            <if test="entrydate != null">
                entrydate = #{entrydate},
            </if>
            <if test="deptId != null">
                dept_id = #{deptId},
            </if>
            <if test="updateTime != null">
                update_time = #{updateTime}
            </if>
        </set>
        where id = #{id}
    </update>
    <!--    省略-->
</mapper>
功能测试

springboot_anli34.png

前后端联调

springboot_anli35.png

暂无评论

发送评论 编辑评论


				
|´・ω・)ノ
ヾ(≧∇≦*)ゝ
(☆ω☆)
(╯‵□′)╯︵┴─┴
 ̄﹃ ̄
(/ω\)
∠( ᐛ 」∠)_
(๑•̀ㅁ•́ฅ)
→_→
୧(๑•̀⌄•́๑)૭
٩(ˊᗜˋ*)و
(ノ°ο°)ノ
(´இ皿இ`)
⌇●﹏●⌇
(ฅ´ω`ฅ)
(╯°A°)╯︵○○○
φ( ̄∇ ̄o)
ヾ(´・ ・`。)ノ"
( ง ᵒ̌皿ᵒ̌)ง⁼³₌₃
(ó﹏ò。)
Σ(っ °Д °;)っ
( ,,´・ω・)ノ"(´っω・`。)
╮(╯▽╰)╭
o(*////▽////*)q
>﹏<
( ๑´•ω•) "(ㆆᴗㆆ)
😂
😀
😅
😊
🙂
🙃
😌
😍
😘
😜
😝
😏
😒
🙄
😳
😡
😔
😫
😱
😭
💩
👻
🙌
🖕
👍
👫
👬
👭
🌚
🌝
🙈
💊
😶
🙏
🍦
🍉
😣
Source: github.com/k4yt3x/flowerhd
颜文字
Emoji
小恐龙
花!
上一篇
下一篇