2--SpringBoot项目中员工管理、分类管理详解（一）

员工管理

新增员工

需求分析和设计

代码开发

实体类

Controller层

Service层接口

Service层实现类

Mapper层

功能测试

通过接口文档测试

代码完善

问题一

解决

问题二

解决

员工分页查询

需求分析和设计

代码开发

设计DTO类

封装PageResult

Controller层

Service层接口

Service层实现类

Mapper层

功能测试

代码完善

问题

解决

员工管理

新增员工

需求分析和设计

产品原型

本项目约定：

管理端发出的请求，统一使用 /admin 作为前缀
用户端发出的请求，统一使用 /user 作为前缀

employee表结构：

代码开发

查看接口文档

当前端提交的数据和实体类中对应的属性差别比较大时，建议使用DTO来封装数据

由于上述传入参数和实体类有较大差别，所以自定义DTO类。

实体类

进入sky-pojo模块，在com.sky.dto包下，定义EmployeeDTO

根据请求参数写出代码

package com.sky.dto;

import lombok.Data;

import java.io.Serializable;

@Data
public class EmployeeDTO implements Serializable {

    private Long id;

    private String username;

    private String name;

    private String phone;

    private String sex;

    private String idNumber;

}

Serializable是什么，为什么要实现Serializable接口？

一个对象序列化的接口，一个类只有实现了Serializable接口，它的对象才能被序列化。

Serializable是java.io包中定义的、用于实现Java类的序列化操作而提供的一个语义级别的接口。

Serializable序列化接口没有任何方法或者字段，只是用于标识可序列化的语义。

实现了Serializable接口的类可以被ObjectOutputStream转换为字节流，同时也可以通过ObjectInputStream再将其解析为对象。例如，我们可以将序列化对象写入文件后，再次从文件中读取它并反序列化成对象，也就是说，可以使用表示对象及其数据的类型信息和字节在内存中重新创建对象。

Controller层

EmployeeController中创建新增员工方法

进入到sky-server模块中，在com.sky.controller.admin包下，在EmployeeController中创建新增员工方法，接收前端提交的参数。

//新增员工
    @PostMapping
    @ApiOperation("新增员工")
    public Result save(@RequestBody EmployeeDTO employeeDTO){
        log.info("新增员工：{}",employeeDTO);
        employeeService.save(employeeDTO);
        return Result.success();
    }

Service层接口

在EmployeeService接口中声明新增员工方法

进入到sky-server模块中,com.sky.server.EmployeeService

 //新增员工
    void save(EmployeeDTO employeeDTO);

Service层实现类

在EmployeeServiceImpl中实现新增员工方法

com.sky.server.impl.EmployeeServiceImpl中创建方法

 @Override//非必须的注解，可以覆盖掉
    public void save(EmployeeDTO employeeDTO) {
        Employee employee=new Employee();
        //对象属性拷贝
        BeanUtils.copyProperties(employeeDTO,employee);

        //设置账号的状态，默认正常状态 1表示正常 0表示锁定
        employee.setStatus(StatusConstant.ENABLE);

        //设置密码，默认密码123456
        employee.setPassword(DigestUtils.md5DigestAsHex(PasswordConstant.DEFAULT_PASSWORD.getBytes()));

        //设置当前记录的创建时间和修改时间
        employee.setCreateTime(LocalDateTime.now());
        employee.setUpdateTime(LocalDateTime.now());

        //设置当前记录创建人id和修改人id
        employee.setCreateUser(10L);//目前写个假数据，后期修改
        employee.setUpdateUser(10L);

        employeeMapper.insert(employee);//后续步骤定义

将Employee中未拷贝的数据进行赋值

在sky-common模块com.sky.constants包下已定义StatusConstant.java

Mapper层

在EmployeeMapper中声明insert方法

com.sky.EmployeeMapper中添加方法

//插入员工数据
    @Insert("insert into employee (name, username, password, phone, sex, id_number, " +
            "create_time, update_time, create_user, update_user,status) " +
            "values " +
            "(#{name},#{username},#{password},#{phone},#{sex},#{idNumber},#{createTime}," +
            "#{updateTime},#{createUser},#{updateUser},#{status})")
    void insert(Employee employee);

功能测试

通过接口文档测试

启动服务：访问http://localhost:8080/doc.html，进入新增员工接口

输入如下数据

401报错

在idea中看到JWT校验：null

解决办法：

通过员工登录获取令牌

打开全局参数设置

在文件中定义的令牌名为token

选择新增参数，参数名称为token

点击确定

重新新增员工

返回响应码200，则成功添加

代码完善

目前程序存在的两个主要问题：

录入的用户名已存，抛出的异常后没有处理
新增员工时，创建人id和修改人id设置为固定值

问题一

当以相同的username新增员工，报错显示500

在idea中查看，控制台显示

查看数据库创建时的表，看到username唯一，而刚输入的数据中username已存在

解决

通过全局异常处理器来处理。

进入到sky-server模块，com.sky.hander包下，GlobalExceptionHandler.java添加方法

  //处理SQL异常
    public Result exceptionHandler(SQLIntegrityConstraintViolationException ex){
        //报错信息为：Duplicate entry 'aaa' for key 'employee.idx_username'
        String message=ex.getMessage();
        if(message.contains("Duplicate entry")){
            String[] split=message.split(" ");
            String username=split[2];
            String msg=username+ MessageConstant.ALREADY_EXISTS;
            return Result.error(msg);
        }else{
            return Result.error(MessageConstant.UNKNOWN_ERROR);
        }
    }

进入到sky-common模块，在MessageConstant.java添加

public static final String ALREADY_EXISTS = "已存在";

问题二

新增员工时，创建人id和修改人id设置为固定值

解决

通过某种方式动态获取当前登录员工的id

思考：解析出登录员工id后，如何传递给Service的save方法？

通过ThreadLocal进行传递。

在拦截器中解析出当前登录员工id，并放入线程局部变量中：

在sky-server模块中，拦截器：

 //2、校验令牌
        try {
            //.................
            Claims claims = JwtUtil.parseJWT(jwtProperties.getAdminSecretKey(), token);
            Long empId = Long.valueOf(claims.get(JwtClaimsConstant.EMP_ID).toString());
            log.info("当前员工id：", empId);
            /将用户id存储到ThreadLocal
            BaseContext.setCurrentId(empId);
            
            //3、通过，放行
            return true;
        } catch (Exception ex) {
            //......................
        }

在Service中获取线程局部变量中的值：

/**
     * 新增员工
     *
     * @param employeeDTO
     */
    public void save(EmployeeDTO employeeDTO) {
        //.............................

        //设置当前记录创建人id和修改人id
        employee.setCreateUser(BaseContext.getCurrentId());//目前写个假数据，后期修改
        employee.setUpdateUser(BaseContext.getCurrentId());

        employeeMapper.insert(employee);
    }

员工分页查询

需求分析和设计

业务规则：

根据页码展示员工信息
每页展示10条数据
分页查询时可以根据需要，输入员工姓名进行查询

代码开发

注意事项：

请求参数类型为Query，不是json格式提交，在路径后直接拼接。/admin/employee/page?name=zhangsan
返回数据中records数组中使用Employee实体类对属性进行封装。

设计DTO类

根据请求参数进行封装，在sky-pojo模块中

package com.sky.dto;

import lombok.Data;

import java.io.Serializable;

@Data
public class EmployeePageQueryDTO implements Serializable {

    //员工姓名
    private String name;

    //页码
    private int page;

    //每页显示记录数
    private int pageSize;

}

封装PageResult

后面所有的分页查询，统一都封装为PageResult对象。

在sky-common模块

package com.sky.result;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;
import java.util.List;

/**
 * 封装分页查询结果
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class PageResult implements Serializable {

    private long total; //总记录数

    private List records; //当前页数据集合

}

员工信息分页查询后端返回的对象类型为: Result<PageResult>

Controller层

在sky-server模块中，com.sky.controller.admin.EmployeeController中添加分页查询方法。

//员工分页查询
    @GetMapping("/page")
    @ApiOperation("员工分页查询")
    public Result<PageResult> page(EmployeePageQueryDTO employeePageQueryDTO){
        log.info("员工分页查询，参数为：{}",employeePageQueryDTO);
        PageResult pageResult=employeeService.pageQuery(employeePageQueryDTO);
        return Result.success(pageResult);
    }

Service层接口

在EmployeeService接口中声明pageQuery方法：

 //分页查询
    PageResult pageQuery(EmployeePageQueryDTO employeePageQueryDTO);

Service层实现类

在EmployeeServiceImpl中实现pageQuery方法：

//分页查询
    @Override
    public PageResult pageQuery(EmployeePageQueryDTO employeePageQueryDTO) {
        //select*from employee limit 0,10
        //开始分页查询
        PageHelper.startPage(employeePageQueryDTO.getPage(), employeePageQueryDTO.getPageSize());
        Page<Employee> page=employeeMapper.pageQuery(employeePageQueryDTO);

        long total=page.getResult();
        List<Employee> records=page.getResult();

        return new PageResult(total,records);
    }

Mapper层

在 EmployeeMapper 中声明 pageQuery 方法：

//分页查询
    Page<Employee> pageQuery(EmployeePageQueryDTO employeePageQueryDTO);

在 src/main/resources/mapper/EmployeeMapper.xml 中编写SQL：

 <select id="pageQuery" resultType="com.sky.entity.Employee">
        select *from employee
        <where>
            <if test="name!=null and name!=' ">
                and name like concat('%',#{name},'%')
            </if>
        </where>
        order by create_time desc
    </select>

功能测试

代码完善

问题

操作时间字段显示有问题

解决

方式一

在属性上加上注解，对日期进行格式化

但这种方式，需要在每个时间属性上都要加上该注解，使用较麻烦，不能全局处理。

方式二

在WebMvcConfiguration中扩展SpringMVC的消息转换器，统一对日期类型进行格式处理

/**
     * 扩展Spring MVC框架的消息转化器
     * @param converters
     */
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        log.info("扩展消息转换器...");
        //创建一个消息转换器对象
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        //需要为消息转换器设置一个对象转换器，对象转换器可以将Java对象序列化为json数据
        converter.setObjectMapper(new JacksonObjectMapper());
        //将自己的消息转化器加入容器中
        converters.add(0,converter);
    }

运行测试