某马瑞吉外卖单体架构项目完整开发文档，基于 Spring Boot 2.7.11 + JDK 11。预计 5 月 20 日前更新完成，有需要的胖友记得一键三连，关注主页 “瑞吉外卖” 专栏获取最新文章。
相关资料：https://pan.baidu.com/s/1rO1Vytcp67mcw-PDe_7uIg?pwd=x548
提取码：x548

1.问题分析

前面我们已经完成了后台系统的员工管理功能开发，在新增员工时需要设置创建时间（create_time）、创建人（create_user）、修改时间（update_time）、修改人（update_user）等字段，在编辑员工时需要设置修改世纪那和修改人等字段。显然，这些字段属于公共字段，也就是很多表格中都有这些字段，如下：

那能不能对于这些公共字段在某个地方统一处理，来简化开发呢？答案就是使用 MyBatis Plus 提供的公共字段自动填充功能。

2.代码实现

MyBatis Plus 公共字段自动填充，也就是在插入或者更新的时候为指定字段赋予指定的值，使用它的好处就是可以统一对这些字段进行处理，避免了重复代码。

实现步骤如下：

1. 在实体类的属性上加入 @TableField 注解，指定自动填充的策略；
2. 按照框架要求编写元数据对象处理器，在此类中统一为公共字段赋值，此类需要实现 MetaObjectHandler 接口。

修改后的 Employee 实体类如下：

@Data
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;
    // 状态，0：禁用，1：启用
    private Integer status;
    
    // 创建时间(插入时自动填充)
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;
    // 更新时间（插入和更新时自动填充）
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;
    // 创建人（插入时自动填充）
    @TableField(fill = FieldFill.INSERT)
    private Long createUser;
    // 更新人（插入和更新时自动填充）
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Long updateUser;
}

接下来按照框架的要求编写元数据对象处理器，我们可以在之前创建的 handler 包下创建一个 MyMetaObjectHandler 类实现 MetaObjectHandler 接口。

完整代码如下：

package cn.javgo.reggie_take_out.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;

/**
 * 自定义元对象处理器
 * @author: JavGo
 * @description: TODO
 * @date: 2023/5/17 16:36
 */
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    /**
     * 插入时填充
     * @param metaObject 元对象,该对象中封装了需要被填充的字段的值
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("createUser", 1L);
        metaObject.setValue("updateUser", 1L);
    }

    /**
     * 更新时填充
     * @param metaObject 元对象
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        metaObject.setValue("updateTime",LocalDateTime.now());
        metaObject.setValue("updateUser",1L);
    }
}

上面我们就已经完成了公共字段自动填充功能的代码开发，但是还有一个问题没有解决，就是我们在自动填充 createUser 和 updateUser 时设置的用户 id 如何获取呢？（上面我们暂时都写为了 1L）

对于获取用户 id，容易想到的是用户登录成功后我们将用户 id 存入了 HttpSession 中，现在我从 HttpSession 中获取不就行了？注意，我们在 MyMetaObjectHandler 类中是不能获得 HttpSession 对象的，所以我们需要通过其他方式来获取登录用户 id。可以使用 ThreadLocal 来解决此问题，它是 JDK 中提供的一个类。

在学习 ThreadLocal 之前，我们需要先确认一个事情，就是客户端发送的每次 http 请求，对应的在服务端都会分配一个新的线程来处理，在处理过程中涉及到下面类中的方法都属于相同的一个线程（以更新为例）：

1. LoginCheckFilter 的 doFilter 方法；
2. EmployeeController 的 update 方法；
3. MyMetaObjectHandler 的 updateFill 方法。

我们可以在上面的三个方法中分别加入下面代码片段 (获取当前线程 id) ：

long threadId = Thread.currentThread().getId();
log.info("当前线程id：{}",threadId);

注意：需要在类上添加 @Slf4j 注解。

执行编辑员工功能进行验证，通过观察控制台输出可以发现，一次请求对应的线程 id 是相同的：

什么是 ThreadLocal？ThreadLocal 并不是一个 Thread，而是 Thread 的局部变量。当使用 ThreadLocal 维护变量时，ThreadLocal 为每个使用该变量的线程提供独立的变量副本，所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。ThreadLocal 为每个线程提供单独一份存储空间，具有线程隔离的效果，只有在线程内才能获取到对应的值，线程外则不能访问。

ThreadLocal 常用方法：

方法	说明
public void set(T value)	设置当前线程的线程局部变量的值
public T get()	返回当前线程所对应的线程局部变量的值

我们可以在 LoginCheckFilter 的 doFilter 方法中获取当前登录用户 id，并调用 ThreadLocal 的 set 方法来设置当前线程的线程局部变量的值 (用户 id)，然后在 MyMetaObjectHandler 的 updateFill 方法中调用 ThreadLocal 的 get 方法来获得当前线程所对应的线程局部变量的值 (用户 id)。

OK，简单分析后的实现步骤如下：

1. 编写 BaseContext 工具类，基于 ThreadLocal 封装的工具类；
2. 在 LoginCheckFilter 的 doFilter 方法中调用 BaseContext 来设置当前登录用户的 id；
3. 在 MyMetaObjectHandler 的方法中调用 BaseContext 获取登录用户的 id。

common/BaseContext.java 工具类完整代码如下：

package cn.javgo.reggie_take_out.common;

/**
 * 基于 ThreadLocal 封装的工具类，用于保存和获取当前线程中的登录用户 id
 */
public class BaseContext {
    private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();

    /**
     * 设置当前线程中的登录用户 id
     * @param id 用户 id
     */
    public static void setCurrentId(Long id){
        threadLocal.set(id);
    }

    /**
     * 获取当前线程中的登录用户 id
     * @return 用户 id
     */
    public static Long getCurrentId(){
        return threadLocal.get();
    }
}

修改后的 LoginCheckFilter#doFilter 方法如下：

@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    long threadId = Thread.currentThread().getId();
    log.info("当前线程id：{}",threadId);

    // 类型转换
    HttpServletRequest request = (HttpServletRequest) servletRequest;
    HttpServletResponse response = (HttpServletResponse) servletResponse;

    // 1.获取请求的 URI 地址
    String requestURI = request.getRequestURI();
    // 2.判断当前的 URI 地址是否需要忽略
    boolean check = Arrays.stream(IGNORE_URI).anyMatch(uri -> ANT_PATH_MATCHER.match(uri, requestURI));
    // 3.如果需要忽略，则直接放行
    if(check){
        filterChain.doFilter(request,response);
        return;
    }
    // 4.如果用户已经登录，则直接放行
    Long empId = (Long) request.getSession().getAttribute("employee");
    if(empId != null){
        // 将当前登录用户的 id 存入 ThreadLocal 中
        BaseContext.setCurrentId(empId);
        // 放行
        filterChain.doFilter(request,response);
        return;
    }
    // 5.用户未登录，通过输出流方式向客户端页面响应数据
    response.getWriter().write(JSON.toJSONString(R.error("NOTLOGIN")));
}

最后注释掉 EmployeeController 中的 setCreateTime、setUpdateTime、setCreateUser、setUpdateUser 部分代码即可。

3.功能测试

下面以新增员工为例进行测试：

点击保存后，查看对应数据库表中是否自动填充了我们设置的公共字段：