Reggie外卖项目 —— 公共字段自动填充功能

10、公共字段自动填充

10.1、问题分析

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

2、能不能对于这些公共字段在某个地方统一处理，来简化开发呢？

答案就是使用MyBatis-Plus提供的公共字段自动填充功能。

10.2、代码实现

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

2、实现步骤：

1）在实体类的属性上加入@TableField注解，指定自动填充的策略

@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;
1
2
3
4
5
6
7
8
9
10
11

2）按照框架要求编写元数据对象处理器，在此类中统一为公共字段赋值，此类需要实现MetaObjectHandler接口

/**
 * 自定义元数据对象处理器
 */
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {

    /**
     * 插入操作自动填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("公共字段自动填充【insert】");
        log.info(metaObject.toString());
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("createUser", new Long(1));
        metaObject.setValue("updateUser", new Long(1));
    }

    /**
     * 更新操作自动填充
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充【update】");
        log.info(metaObject.toString());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("updateUser", new Long(1));
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

注意：

当前我们设置createUser和updateUser为固定值，后面需要进行改造，改为动态获得当前登录用户的id

10.3、功能测试

将EmployeeController中的新增和修改方法手动设置公共字段的代码注释掉，测试这些公共字段是否完成了自动填充。

10.4、功能完善

10.4.1、问题分析

1、前面我们已经完成了公共字段自动填充功能的代码开发，但是还有一个问题没有解决，就是我们在自动填充createUser和updateUser时设置的用户id是固定值，现在我们需要改造成动态获取当前登录用户的id。

可以想到，用户登录成功后我们将用户id存入了HttpSession中，现在我从HttpSession中获取不就行了？

注意，我们在MyMetaObjectHandler类中是不能获得HttpSession对象的，所以我们需要通过其他方式来获取登录用户的id。

可以使用ThreadLocal来解决此问题，它是JDk中提供的一个类。

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

• LoginCheckFilter的doFilter方法
• EmployeeController的update方法
• MyMetaObjectHandler 的updateFill方法

可以在上面的三个方法中分别加入下面代码（获取当前线程id）

long id = Thread.currentThread().getId();
log.info("线程id为：{}", id);
1
2

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

10.4.2、ThreadLocal

1、什么是ThreadLocal

ThreadLocal并不是一个Thread，而是Thread的局部变量。当使用ThreadLocal维护变量时，ThreadLocal为每个使用该变量的线程提供独立的变量副本，所以每一个线程都可以独立地改变自己的副本，而不会影响其他线程所对应的副本。

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

2、ThreadLocal常用方法：

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

10.4.3、代码开发

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

2、实现步骤：

• 编写BaseContext工具类，基于ThreadLocal封装的工具类

  /**
   * 基于ThreadLocal封装工具类，用户保存和获取当前登录用户的id
   */
  public class BaseContext {
      private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();
  
      /**
       * 设置值
       * @param id
       */
      public static void setCurrentId(Long id) {
          threadLocal.set(id);
      }
  
      /**
       * 获取值
       * @return
       */
      public static Long getCurrentId() {
          return threadLocal.get();
      }
  }
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22

• 在LoginCheckFilter的doFilter方法中调用BaseContext来设置当前登录用户的id

  //4、判断登录状态，如果已登录，则直接放行
  if (request.getSession().getAttribute("employee") != null) {
      log.info("用户已登录，用户id为：{}", request.getSession().getAttribute("employee"));
  
      Long empId = (Long) request.getSession().getAttribute("employee");
      BaseContext.setCurrentId(empId);
  
      filterChain.doFilter(request, response);
      return;
  }
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10

• 在MyMetaObjectHandler的updateFill方法中调用BaseContext获取登录用户的id

  metaObject.setValue("updateTime", LocalDateTime.now());
  metaObject.setValue("updateUser", BaseContext.getCurrentId());
  1
  2