苍穹外卖项目DAY02

苍穹外卖项目Day02

1、员工管理

1.1、新增员工

1.1.1、需求分析和设计

产品原型：

接口设计：

数据库设计（employee表）：

1.1.2、代码开发

根据新增员工接口设计对应的DTO：

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

@Data
public class EmployeeDTO implements Serializable {

    private Long id;

    private String username;

    private String name;

    private String phone;

    private String sex;

    private String idNumber;

}

EmployeeController

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

EmployeeService

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

EmployeeServiceImpl

/**
 * 新增员工
 * @param employeeDTO
 */
@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
    // TODO 后期需要修改为当前登录用户的id
    employee.setCreateUser(10L);
    employee.setUpdateUser(10L);

    employeeMapper.insert(employee);
}

EmployeeMapper

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

1.1.3、功能测试

功能测试方式：

• 通过接口文档测试
• 通过前后端联调测试

注意：由于开发阶段前端和后端是并行开发的，后端完成某个功能后，此时前端对应的功能可能还没有开发完成，导致无法进行1前后端联调测试。所以在开发阶段，后端测试主要以接口文档测试为主

1、启动Application

2、在接口文档中测试

因为没有令牌token响应码为401，我们需要先复制员工登录返回的token

{
  "code": 1,
  "msg": null,
  "data": {
    "id": 1,
    "userName": "admin",
    "name": "管理员",
    "token": "eyJhbGciOiJIUzI1NiJ9.eyJlbXBJZCI6MSwiZXhwIjoxNzIzNDgxODM3fQ.EGJ7ubwtcZ6QBJb0pZjmrSzYv0lDpf1X_LvWH4ZHyYY"
  }
}

将复制的token设置成全局参数设置

再重新测试新增员工，成功！

1.1.4、代码完善

程序存在的问题：

• 录入的用户名已存在，抛出异常后没有处理

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

    employee.setCreateUser(10L);
    employee.setUpdateUser(10L);

在GLobalExceptionHandler编写处理SQL异常的情况

/**
 * 处理SQL异常
 * @param ex
 * @return
 */
@ExceptionHandler
public Result exceptionHandler(SQLIntegrityConstraintViolationException ex){
    String message  = ex.getMessage();
    if (message.contains("Duplicate entry")){
        String[] spit = message.split(" ");
        String username = spit[2];
        String msg = username + MessageConstant.ALREADY_EXISTS;
        return Result.error(msg);
    }else {
        return Result.error(MessageConstant.UNKNOWN_ERROR);
    }
}

再次测试同样的信息

返回的信息显示用户已存在，修改成功

针对第二个问题，需要通过某种方式动态获取当前登录员工的id：

员工登录成功后会生成JWT令牌并响应给前端

    //登录成功后，生成jwt令牌
        Map<String, Object> claims = new HashMap<>();
        claims.put(JwtClaimsConstant.EMP_ID, employee.getId());
        String token = JwtUtil.createJWT(
                jwtProperties.getAdminSecretKey(),
                jwtProperties.getAdminTtl(),
                claims);

后续请求中，前端会携带JWT令牌，通过JWT令牌可以解析出当前登录员工id：

//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);
    //3、通过，放行
    return true;
} catch (Exception ex) {
    //4、不通过，响应401状态码
    response.setStatus(401);
    return false;
}

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

ThreadLocal并不是一个Thread，而是Thread的局部变量。

ThreadLocal为每一个线程提供一份存储空间，具有线程隔离的效果，只有在线程内才能获取到对应的值，线程外则不能访问

在JwtTokenAdminInterceptor 中添加setCurrentId

//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;
    }

在EmployeeServiceImpl中添加getCurrentId

// TODO 后期需要修改为当前登录用户的id
employee.setCreateUser(BaseContext.getCurrentId());
employee.setUpdateUser(BaseContext.getCurrentId());

再次新增员工在数据中查看表发现创建用户变为设置全局token的用户

1.2、员工分页查询

1.2.1、需求分析和设计

业务规则：

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

接口设计：

1.2.2、代码开发

根据分页查询接口设计对应的DTO：

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

@AllArgsConstructor
@NoArgsConstructor
public class PageResult implements Serializable {

    private long total; //总记录数

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

}

员工信息分页查询后端返回的对象类型为：Result

Controller层

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

Service层

PageResult pageQuery(EmployeePageQueryDTO employeePageQueryDTO);

ServiceImpl层

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

Mapper层

Page<Employee> pageQuery(EmployeePageQueryDTO employeePageQueryDTO);

xml层

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

1.2.3、功能测试

通过接口文档进行测试，也可以进行前后端联调测试，最后操作时间字段展示有问题

1.2.4、代码完善

解决方法：

• 方式一：在属性上加入注解，对日期进行格式化（只能处理单个属性）

@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")
private LocalDateTime updateTime;

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

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

重新测试：对时间格式进行了格式化

1.3、启用禁用员工账号

1.3.1、需求分析和设计

业务规则：

• 可以对状态为“启用”的员工账号进行“禁用”操作
• 可以对状态为“禁用”的员工账号进行“启用”操作
• 状态为“禁用”的员工账号不能登录系统

1.3.2、代码开发

Controller层

@PostMapping("/status/{status}")
@ApiOperation("启用禁用员工账号")
public Result startOrStop(@PathVariable Integer status,Long id){
    log.info("启用禁用员工账号：{},{}",status,id);
    employeeService.startOrStop(status,id);
    return Result.success();
}

Service层

void startOrStop(Integer status, Long id);

Impl层

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

Mapper层

void update(Employee employee);

xml层

<update id="update" parameterType="Employee">
update sky_take_out.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>

1.3.3、功能测试

接口文档测试：

前后端联调测试：

1.4、编辑员工

1.4.1、需求分析和设计

编辑员工功能涉及到两个接口：

• 根据id查询员工信息
• 编辑员工信息

1.4.2、代码开发

Controller层

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

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

Service层

/**
 * 根据id查询员工信息
 * @param id
 * @return
 */
Employee getById(Long id);

/**
 * 编辑员工信息
 *
 * @param employeeDTO
 * @return
 */
void update(EmployeeDTO employeeDTO);

Impl层

/**
 * 根据id查询员工信息
 * @param id
 * @return
 */
@Override
public Employee getById(Long id) {
    Employee employee = employeeMapper.getById(id);
    //让前端无法看到密码
    employee.setPassword("*****");
    return employee;
}

/**
 * 编辑员工信息
 *
 * @param employeeDTO
 * @return
 */
@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);
}

Mapper层

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

1.4.3、功能测试

接口文档测试：根据id查询员工信息

接口文档测试：编辑员工信息

2、分类管理

2.1、导入分类模块功能代码

2.1.1、需求分析和设计

业务规则：

• 分类名称必须是唯一的
• 分类按照类型可以分为菜品分类和套餐分类
• 新添加的分类状态默认为“禁用”

接口设计：

• 新增分类
• 分类分页查询
• 根据id删除分类
• 修改分类
• 启用禁用分类
• 根据类型查询分类

数据库设计（category表）：

2.1.2、代码导入

如果导入不成功就在Maven中重新编译一下