关于Mybatis-plus公共字段注入

Mybatis-plus公共字段注入

1.实体类字段添加注解

首先在需要自动注入的字段上添加注解 @TableField(fill = FieldFill.INSERT)或者@TableField(fill = FieldFill.INSERT_UPDATE)
举个例子：

    //创建时间
    @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;

2.实体类字段分类处理

2.1 可以直接创建的时间字段自动注入

  注意：这里的createUser和updateUser都需要获取到当前登录者的id值才能够进行注入，而这设计到运用拦截器或者过滤器对登录信息进行获取，先不处理createUser和updateUser自动注入，之后再说

（1）建立结构

建议先创建一个common包，这个功能很多实体类都会用到，所以放在公共包下，便于管理。
然后在common包下创建MyMetaObjecthandler类，并继承MetaObjectHandler类。

（2）编写代码

具体代码如下：

@Slf4j
@Component
public class MyMetaObjecthandler implements MetaObjectHandler {

    @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", BaseContext.getCurrentId());
        //metaObject.setValue("updateUser",BaseContext.getCurrentId());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充[update]...");
        log.info(metaObject.toString());

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

        metaObject.setValue("updateTime",LocalDateTime.now());
        //metaObject.setValue("updateUser",BaseContext.getCurrentId());
    }
}

2.2 需要获取登录信息的字段自动注入

  在编写项目时，大多数项目都会在登录时用拦截器或者过滤器来进行登录拦截，这是就需要判断登录状态，可以在这里存储登录信息，但是怎么存储呢，这就涉及到了一个线程问题。

①ThreadLocal初识

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

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

long id Thread.currentThread().getId();
log.info(线程id:0",id);

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

2022-06-10 15:36:00.708INFO 11972 ---[nio-8080-exec-7]c.i.reggie.filter.LoginCheckFilter线程id:34
2022-06-10 15:36:00.711INFO 11972---[nio-8080-exec-7]c.i.r.controller.EmployeeController线程id:34
2022-06-10 15:36:00.711 INF0 11972 ---[nio-8080-exec-7]c.i.r.controller.EmployeeControllerEmployee (id=14078983:Creating a new SqlSessionSqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@17f9a154]was not registered for synchronization because
2022-06-10 15:36:00.715 INFO 11972 ---[nio-8080-exec-7]c.i.reggie.common.MyMetaObjectHandler:线程id:34

  那什么是ThreadLocal?

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

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

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

  或者也可以在拦截器的preHandle()方法中获取当前登录用户id。

③代码实现

  首先在common包下创建一个类BaseContext，代码如下：

/**
 * 基于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();
    }
}

  其次在过滤器或者拦截器判断登录状态过程中用ThreadLocal的特性来存储id值。

if (request.getSession().getAttribute("employee") != null) {
            log.info("用户已登录，用户id为：{}", request.getSession().getAttribute("employee"));
            //存储id值
            Long employeeId = (Long) request.getSession().getAttribute("employee");
            BaseContext.setCurrentId(employeeId);
            filterChain.doFilter(request, response);
            return;
        }

  最后就可以在之前创建的MyMetaObjecthandler类中获取到id了。

@Slf4j
@Component
public class MyMetaObjecthandler implements MetaObjectHandler {

    @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", BaseContext.getCurrentId());
        metaObject.setValue("updateUser",BaseContext.getCurrentId());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充[update]...");
        log.info(metaObject.toString());

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

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

这样就实现了Mybatis-plus公共字段注入了。