2025.06.04

苍穹外卖开发日志Day02——员工管理

员工管理包含以下功能：
- 新增员工
- 员工分页查询
- 启用禁用员工账号
- 编辑员工

一、新增员工

1.1 新增员工——功能开发

产品原型
接口设计
数据库设计（employee表）
代码开发
- 当前端提交的数据和实体类中对应的属性差别较大时，建议使用DTO来封装数据
注意点：需要在ServiceImpl中将DTO转换为实体类，并设置其他属性

1.1.1 EmployeeDTO

@Data
public class EmployeeDTO implements Serializable {

    private Long id;

    private String username;

    private String name;

    private String phone;

    private String sex;

    private String idNumber;
}

1.1.2 EmployeeController

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

1.1.3 EmployeeServiceImpl

/*
* 新增员工
* */
@Override
public void save(EmployeeDTO employeeDTO) {
    Employee employee = new Employee();
    // 属性拷贝
    BeanUtils.copyProperties(employeeDTO, employee);
    // 设置账号状态
    employee.setStatus(StatusConstant.ENABLE);
    // 设置密码，默认123456
    employee.setPassword(DigestUtils.md5DigestAsHex(PasswordConstant.DEFAULT_PASSWORD.getBytes()));
    // TODO 设置创建时间和更新时间，创建人和更新人，后期需要改为当前登录用户id
    employee.setCreateTime(LocalDateTime.now());
    employee.setUpdateTime(LocalDateTime.now());
    employee.setCreateUser(10L);
    employee.setUpdateUser(10L);

    employeeMapper.insert(employee);
}

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

1.2 新增员工——功能测试

直接测试
- 问题：返回401，原因是未登录，所以在测试过程中jwt令牌校验不通过
- 解决方法：
  - 先使用登录接口获取jwt令牌
  - 然后添加Header全局参数
  - 最后再次测试新增员工接口，测试成功！
前后端联调测试
数据库结果

1.3 新增员工——代码完善

当前存在的问题
1. 录入的用户名已存在。抛出异常后没有处理
2. 新增员工时创建人id和修改人id设置为了固定值

解决方法

问题1：在GlobalExceptionHander中处理异常信息：

/**
 * 捕获SQL异常
    * @param ex
    * @return
    */
@ExceptionHandler
public Result exceptionHandler(SQLIntegrityConstraintViolationException ex){
    // Duplicate entry 'zhangsan' for key 'employee.idx_username'
    String message = ex.getMessage();
    if(message.contains("Duplicate entry")){
        String username = message.split(" ")[2];
        String msg = username + MessageConstant.ALREADY_EXIST;
        return Result.error(msg);
    }else {
        // 返回未知错误
        return Result.error(MessageConstant.UNKNOWN_ERROR);
    }
}

测试结果

问题2：在ServiceImpl中获取当前登录用户id

ThreadLocal并不是一个Thread，而是Thread的局部变量
ThreadLocal为每个线程提供单独一份存储空间，具有线程隔离效果，只有在线程内才能获取到对应的值，线程外不能访问
ThreadLocal常用方法：
- public void set(T value)：设置当前线程的线程局部变量的值
- public T get()：返回当前线程所对应的线程局部变量的值
- public void remove()：移除当前线程的线程局部变量
使用ThreadLocal存储当前登录用户id
工具类BaseContext.java

public class BaseContext {

    public static ThreadLocal<Long> threadLocal = new ThreadLocal<>();

    public static void setCurrentId(Long id) {
        threadLocal.set(id);
    }

    public static Long getCurrentId() {
        return threadLocal.get();
    }

    public static void removeCurrentId() {
        threadLocal.remove();
    }
}

在登录接口中设置当前登录用户id JwtTokenAdminInterceptor.java

/**
* jwt令牌校验的拦截器
*/
@Component
@Slf4j
public class JwtTokenAdminInterceptor implements HandlerInterceptor {

    @Autowired
    private JwtProperties jwtProperties;

    /**
    * 校验jwt
    *
    * @param request
    * @param response
    * @param handler
    * @return
    * @throws Exception
    */
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //判断当前拦截到的是Controller的方法还是其他资源
        if (!(handler instanceof HandlerMethod)) {
            //当前拦截到的不是动态方法，直接放行
            return true;
        }

        //1、从请求头中获取令牌
        String token = request.getHeader(jwtProperties.getAdminTokenName());

        //2、校验令牌
        try {
            log.info("jwt校验:{}", token);
            Claims claims = JwtUtil.parseJWT(jwtProperties.getAdminSecretKey(), token);
            Long empId = Long.valueOf(claims.get(JwtClaimsConstant.EMP_ID).toString());
            log.info("当前员工id：", empId);
            BaseContext.setCurrentId(empId);
            //3、通过，放行
            return true;
        } catch (Exception ex) {
            //4、不通过，响应401状态码
            response.setStatus(401);
            return false;
        }
    }
}

EmployeeServiceImpl.java

/*
* 新增员工
* */
@Override
public void save(EmployeeDTO employeeDTO) {
    Employee employee = new Employee();
    // 属性拷贝
    BeanUtils.copyProperties(employeeDTO, employee);
    // 设置账号状态
    employee.setStatus(StatusConstant.ENABLE);
    // 设置密码，默认123456
    employee.setPassword(DigestUtils.md5DigestAsHex(PasswordConstant.DEFAULT_PASSWORD.getBytes()));
    // 设置创建时间和更新时间，创建人和更新人，后期需要改为当前登录用户id
    employee.setCreateTime(LocalDateTime.now());
    employee.setUpdateTime(LocalDateTime.now());

    employee.setCreateUser(BaseContext.getCurrentId());
    employee.setUpdateUser(BaseContext.getCurrentId());

    employeeMapper.insert(employee);
}

二、员工分页查询

2.1 员工分页查询——功能开发

产品原型
接口设计
注意点：
- 分页查询需要使用PageHelper插件进行分页处理
- PageHelper.startPage方法底层也是使用ThreadLocal来存储分页信息，然后直接拼接在SQL语句中，所以SQL语句中不需要使用limit关键字
- 测试时需要注意token有效期

2.1.1 EmployeePageQueryDTO

@Data
public class EmployeePageQueryDTO implements Serializable {

    //员工姓名
    private String name;

    //页码
    private int page;

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

2.1.2 PageResult

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

    private long total; //总记录数

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

}

2.1.3 EmployeeController

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

2.1.4 EmployeeServiceImpl

/**
 * 员工分页查询
 * @param employeePageQueryDTO
 * @return
 */
@Override
public PageResult pageQuery(EmployeePageQueryDTO employeePageQueryDTO) {
    PageHelper.startPage(employeePageQueryDTO.getPage(), employeePageQueryDTO.getPageSize());
    Page<Employee> page = employeeMapper.pageQuery(employeePageQueryDTO);
    long total = page.getTotal();
    List<Employee> records = page.getResult();
    return new PageResult(total, records);
}

2.1.5 EmployeeMapper

/**
 * 员工分页查询
 * @param employeePageQueryDTO
 * @return
 */
Page<Employee> pageQuery(EmployeePageQueryDTO employeePageQueryDTO);

2.1.6 EmployeeMapper.xml

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

2.2 员工分页查询——功能测试

直接测试

2.3 员工分页查询——代码完善

当前存在的问题
- 查询结果中时间格式有问题

解决方法

方法一：在实体类中使用@JsonFormat注解进行格式化

Employee.java

1 2	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8") private LocalDateTime createTime;

方法二：在WebMvcConfiguration中扩展Spring MVC的消息转换器，统一对日期进行格式化处理

WebMvcConfiguration.java

/**
 * 扩展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);
}

最终效果

三、启用禁用员工账号

3.1 启用禁用员工账号——功能开发

产品原型
业务规则
- 可以对状态为“启用”的员工账号进行“禁用”操作
- 可以对状态为“禁用”的员工账号进行“启用”操作
- 状态为“禁用”的员工账号不能登录系统
接口设计
注意点
- ServiceImpl中传递Employee对象给Mapper
- Mapper中使用xml文件进行动态SQL拼接，这样不仅可以用来更新status，还可以更新其他属性

3.1.1 EmployeeController

/**
 * 启用禁用员工账号
 *
 * @param status
 * @param ids
 * @return
 */
@PostMapping("/status/{status}")
@ApiOperation("启用禁用员工账号")
public Result status(@PathVariable Integer status, @RequestParam List<Long> ids) {
    log.info("启用禁用员工账号：{}，{}", status, ids);
    employeeService.status(status, ids);
    return Result.success();
}

3.1.2 EmployeeServiceImpl

/**
 * 启用禁用员工账号
  * @param status
  * @param id
  */
@Override
public void startOrStop(Integer status, Long id) {
    /*Employee employee = new Employee();
    employee.setStatus(status);
    employee.setId(id);*/

    Employee employee = Employee.builder()
                                .status(status)
                                .id(id)
                                .build();
    employeeMapper.update(employee);
}

3.1.3 EmployeeMapper

/**
 * 根据主键修改属性
  * @param employee
  */
void update(Employee employee);

3.1.4 EmployeeMapper.xml

<update id="update" parameterType="Employee">
    update employee
    <set>
        <if test="name != null">name = #{name},</if>
        <if test="username != null">username = #{username},</if>
        <if test="password != null">password = #{password},</if>
        <if test="phone != null">phone = #{phone},</if>
        <if test="sex != null">sex = #{sex},</if>
        <if test="idNumber != null">id_Number = #{idNumber},</if>
        <if test="updateTime != null">update_Time = #{updateTime},</if>
        <if test="updateUser != null">update_User = #{updateUser},</if>
        <if test="status != null">status = #{status},</if>
    </set>
    where id = #{id}
</update>

3.2 启用禁用员工账号——功能测试

直接测试
- 在进行测试时使用body传递参数时一直报错404
- 原因是使用Apifox测试时，路径参数需要在Path中传递，不能在body中传递
最终测试效果

四、编辑员工

4.1 编辑员工——功能开发

产品原型
需求分析：编辑员工涉及到两个接口
- 根据id查询员工信息
- 编辑员工信息
接口设计
注意点
- 在查询员工信息时需要将密码设置为******，防止泄露用户隐私，设置之后前端接收到的数据就是：

4.1.1 EmployeeController

/**
 * 根据id查询员工
 * @param id
 * @return
 */
@GetMapping("/{id}")
@ApiOperation("根据id查询员工信息")
public Result<Employee> getById(@PathVariable Long id) {
    log.info("查询员工的id：{}", id);
    Employee employee = employeeService.getById(id);
    return Result.success(employee);
}

/**
 * 修改员工信息
 * @param employeeDTO
 * @return
 */
@PutMapping
@ApiOperation("编辑员工信息")
public Result update(@RequestBody EmployeeDTO employeeDTO) {
    log.info("编辑员工信息：{}", employeeDTO);
    employeeService.update(employeeDTO);
    return Result.success();
}

4.1.2 EmployeeServiceImpl

/**
 * 根据id查询员工
 * @param id
 * @return
 */
@Override
public Employee getById(Long id) {
    Employee employee = employeeMapper.getById(id);
    employee.setPassword("******");
    return employee;
}

/**
 * 编辑员工信息
 * @param employeeDTO
 */
@Override
public void update(EmployeeDTO employeeDTO) {
    Employee employee = new Employee();
    BeanUtils.copyProperties(employeeDTO, employee);
    employee.setUpdateTime(LocalDateTime.now());
    employee.setUpdateUser(BaseContext.getCurrentId());

    employeeMapper.update(employee);
}

4.1.3 EmployeeMapper

/**
 * 根据id查询员工
 * @param id
 * @return
 */
@Select("select * from employee where id = #{id}")
Employee getById(Long id);

// 修改员工依然使用上面的update方法即可

4.2 编辑员工——功能测试

直接测试
- 查询员工信息
- 编辑员工信息