Day66(3)-F:\硕士阶段\Java\课程资料\1、黑马程序员Java项目《苍穹外卖》企业级开发实战\sky-take-out-员工管理

苍穹外卖

员工管理

新增员工

封装前端传过来的数据

技术栈：

1. 对象属性拷贝BeanUtils.copyProperties(employeeDTO,employee);//前提是属性名一致
2. 避免硬编码employee.setStatus(StatusConstant.ENABLE);//避免硬编码
3. 加密密码设置employee.setPassword(DigestUtils.md5DigestAsHex(PasswordConstant.DEFAULT_PASSWORD.getBytes()));

对象属性拷贝

避免硬编码

加密密码设置

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

/**
 * 新增员工
 * @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);
}

/**
 * 插入员工数据
 * @param employee
 */
@Insert("insert into employee (name, username, password, phone, sex, id_number, status, 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接口文档(Swagger)；左侧-文档管理-全局参数设置-添加参数

技术栈：

1. 异常处理器，放置在server项目记得加上@ExceptionHandler注解；根据报错的message，get message然后进行信息筛选
2. 动态获取并设置登录用户的id：ThreadLocal，sky-common--context--BaseContext
3. 断点debug求值：选择对应属性或对象，右键--对表达式求值
4. 看你们都提出了会产生内存泄露问题，但是没人说明解决方法，这里帖个解决方法,重写拦截器的afterCompletion方法，并添加BaseContext.removeCurrentId()

/**
 * 处理SQL异常
 * @param ex
 * @return
 */
@ApiOperation("用户名已存在异常处理")
@ExceptionHandler
public Result exceptionHandler(SQLIntegrityConstraintViolationException ex){
    //Duplicate entry 'zhangsan' 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);
    }
}

ThreadLocal BaseContext

单独设置一个类封装

package com.sky.context;

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

}

在interceptor拦截器校验令牌后将id存入（下方53行）

package com.sky.interceptor;

import com.sky.constant.JwtClaimsConstant;
import com.sky.context.BaseContext;
import com.sky.properties.JwtProperties;
import com.sky.utils.JwtUtil;
import io.jsonwebtoken.Claims;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 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 {
        System.out.println("当前线程的id："+Thread.currentThread().getId());

        //判断当前拦截到的是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;
        }
    }
}

在serviceimpl存入（25-26行）employee类中传入mappper层，再传入数据库

/**
 * 新增员工
 * @param employeeDTO
 */
@Override
public void save(EmployeeDTO employeeDTO) {
    System.out.println("当前线程的id："+Thread.currentThread().getId());
    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(BaseContext.getCurrentId());
    employee.setUpdateUser(BaseContext.getCurrentId());

    employeeMapper.insert(employee);
}

对表达式求值

做完记得推送代码

员工分页查询

技术栈

1. pagehelper引入需要在pom.xml文件中先导入依赖；controller层接受server层的pageResult，serviceimpl层里面通过pagehelper调用查询mapper层的返回值并处理出total，得到Page类的结果，并封装为PageResult传递给controller层。
2. mapper中用xml编写的sql语句（alter+Enter）的扫描定义在yml文件里面的mybatis--mapper-locations
3. SQL模糊查询动态拼接
4. jwt令牌失效时间配置在yml文件
5. SQL查询不为空格
6. 时间日期格式规定

1.pagehelper引入需要在pom.xml文件中先导入依赖；controller层接受server层的pageResult，serviceimpl层里面通过pagehelper调用查询mapper层的返回值并处理出total，得到Page类的结果，并封装为PageResult传递给controller层。

controller

/**
 * 员工分页查询
 * @param employeePageQueryDTO
 * @return
 */
@GetMapping("/page")
@ApiOperation("员工分页查询")
public Result<PageResult> page(EmployeePageQueryDTO employeePageQueryDTO){
    //这里是query输入所以不需要@RequestBody注解；这里通过springMVC框架接受参数并封装
    log.info("员工分页查询：{}",employeePageQueryDTO);
    PageResult pageResult = employeeService.pageQuery(employeePageQueryDTO);
    return Result.success(pageResult);
}

serviceimpl

/**
 * 分页查询
 * @param employeePageQueryDTO
 * @return
 */
@Override
public PageResult pageQuery(EmployeePageQueryDTO employeePageQueryDTO) {
    //select * from employee limit 0,10
    //开始分页查询，本质是通过threadLocal，将页码和查询的每页数输入进去
    PageHelper.startPage(employeePageQueryDTO.getPage(),employeePageQueryDTO.getPageSize());
    //该插件底层基于mybatis的拦截器，动态拼接，动态计算；aop面向切面编程。

    Page<Employee> page = employeeMapper.pageQuery(employeePageQueryDTO);
    //mapper层查询返回值必须是page类（PageHelper规定的）

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

    return new PageResult(total,records);
}

2.mapper中用xml编写的sql语句的扫描定义在yml文件里面的mybatis--mapper-locations

mybatis:
  #mapper配置文件
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.sky.entity
  configuration:
    #开启驼峰命名
    map-underscore-to-camel-case: true

3.SQL模糊查询动态拼接

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

4.jwt令牌失效时间配置在yml文件

sky:
  jwt:
    # 设置jwt签名加密时使用的秘钥
    admin-secret-key: itcast
    # 设置jwt过期时间
    admin-ttl: 7200000
    # 设置前端传递过来的令牌名称
    admin-token-name: token

5.SQL查询不为空格

为什么之前写了很多教程!= ''？

其实在MyBatis中，判断字符串是否为空，标准的写法是：

1. name != null:保证对象不为空。
2. name.trim() != "":确定不是空字符串。
3. and name like concat('%',#{name},'%')

特别注意：你的原代码写的是name != ' '（单引号里有个空格）。在SQL搜索中，我们通常不是判断是否为空字符串 ""，而是判断是否为空格。

6.时间日期格式规定

方式一（36和39行）:

package com.sky.entity;

import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;
import java.time.LocalDateTime;

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class Employee implements Serializable {

    private static final long serialVersionUID = 1L;

    private Long id;

    private String username;

    private String name;

    private String password;

    private String phone;

    private String sex;

    private String idNumber;

    private Integer status;

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

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

    private Long createUser;

    private Long updateUser;

}

方式二：在config类WebMvcConfiguration里面编写，重写extendMessageConverters

固定代码对象转换器 com.sky.json.JacksonObjectMapper

package com.sky.json;

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;

import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES;

/**
 * 对象映射器:基于jackson将Java对象转为json，或者将json转为Java对象
 * 将JSON解析为Java对象的过程称为 [从JSON反序列化Java对象]
 * 从Java对象生成JSON的过程称为 [序列化Java对象到JSON]
 */
public class JacksonObjectMapper extends ObjectMapper {

    public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
    //public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
    public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm";
    public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";

    public JacksonObjectMapper() {
        super();
        //收到未知属性时不报异常
        this.configure(FAIL_ON_UNKNOWN_PROPERTIES, false);

        //反序列化时，属性不存在的兼容处理
        this.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);

        SimpleModule simpleModule = new SimpleModule()
                .addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
                .addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
                .addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)))
                .addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
                .addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
                .addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));

        //注册功能模块 例如，可以添加自定义序列化器和反序列化器
        this.registerModule(simpleModule);
    }
}

固定格式拓展消息转换器 com.sky.config.WebMvcConfiguration

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

员工的启用和禁用

技术栈

1. 路径传参和query传参同时
2. sql规范：大小写

路径传参和query传参同时

/**
 * 启用禁用员工账号
 * @param status
 * @param id
 * @return
 */
@PostMapping("/status/{status}")
@ApiOperation("启用禁用员工账号")
public Result startOrStop(@PathVariable Integer status,Long id){//status是path参数，id为query参数
    log.info("启用禁用员工账号：{}，{}",status,id);
    employeeService.startOrStop(status,id);
    return Result.success();
}

sql规范：大小写

MySQL在Windows下默认不区分大小写

如果你是在Windows系统上运行的MySQL，它是不区分大小写的。

• 当你发送update employee set update_Time = ...时，MySQL引擎会自动把它当成update_time来处理。
• 注意：如果你的项目部署到Linux服务器上，默认情况下Linux版本的MySQL是区分大小写的，到时候可能代码可能会直接报错Unknown column 'update_Time'。

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

编辑员工

根据id查询员工-controller层

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

根据id查询员工-serviceimpl层

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

根据id查询员工-mapper层

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

技术栈

1. 对象属性拷贝
2. ThreadLocal 获取当前线程下操作者的id，通过BaseContext类

编辑员工信息-controller层

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

对象属性拷贝

编辑员工信息-serviceimpl层

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

ThreadLocal 获取当前线程下操作者的id，通过BaseContext类com.sky.context.BaseContext

package com.sky.context;

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

}

分类模块功能

已经提供代码

修改的地方10-13行：解决该页删除完没有数据，而分页查询还是停留在空页面的问题

/**
 * 分页查询
 * @param categoryPageQueryDTO
 * @return
 */
public PageResult pageQuery(CategoryPageQueryDTO categoryPageQueryDTO) {
    PageHelper.startPage(categoryPageQueryDTO.getPage(),categoryPageQueryDTO.getPageSize());
    //下一条sql进行分页，自动加入limit关键字分页
    Page<Category> page = categoryMapper.pageQuery(categoryPageQueryDTO);
    if (page.getResult().isEmpty() && categoryPageQueryDTO.getPage() > 1 && page.getTotal() > 0){
        categoryPageQueryDTO.setPage(categoryPageQueryDTO.getPage()-1);
        PageHelper.startPage(categoryPageQueryDTO.getPage(),categoryPageQueryDTO.getPageSize());
        page = categoryMapper.pageQuery(categoryPageQueryDTO);
    }
    return new PageResult(page.getTotal(), page.getResult());
}