公共字段自动填充

公共字段自动填充

为什么要说公共字段自动填充了？

可以提高开发效率，减少重复代码，并确保数据的一致性

就像项目中的创建人，创建时间之类的，这写公共字段其实很多表里面都有

如何自动填充了

使用Mybatis Plus提供的公共字段自动填充功能

1.实现步骤：

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

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

    private Integer status;

    private LocalDateTime createTime;

    private LocalDateTime updateTime;

    @TableField(fill = FieldFill.INSERT)
    private Long createUser;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Long updateUser;

}

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

@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
    /**
     * insert自动填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        //这里面写的是insert的
        log.info("公共字段insert的填充");
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime",LocalDateTime.now());
        metaObject.setValue("createUser",BaseContext.getCurrentId());
        metaObject.setValue("updateUser",BaseContext.getCurrentId());



    }

    /**
     * update自动填充
     * @param metaObject
     */

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("公共字段自动填充update");
        metaObject.setValue("updateTime",LocalDateTime.now());
        metaObject.setValue("updateUser",BaseContext.getCurrentId());
    }
}

2.关于其中的BaseContext

2.1为什么会使用BaseContext

​ 应为我们无法获取id在在MyMetaObjectHandler类中，HttpSession也不能获取，所以我们需要搭建一个

BaseContext的类,在这里面来使用ThreadLocal

ThredLocal 它是JDK中提供的一个类。

2.2ThreadLocal

​ 先确定一件事儿，就是每次客户端发送请求的时候，服务端都会分配一个新的线程来处理，所以在瑞吉这个项目中他的处理过程中明确路径

​ 1、LoginCheckFilter的doFilter方法

​ 2、EmployeeController的update方法

​ 3、MyMetaObjectHandler的updateFill方法

这些路径对应的线程的id是相同的

什么是ThredLocal

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

ThreadLocal常用方法：

public void set(T value) 设置当前线程的线程局部变量的值

public T get() 返回当前线程所对应的线程局部变量的值

2.3开始写出代码

​

/**
 * 基于ThreadLocal封装的工具类
 */
public class BaseContext {
    private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();

    //通过这个方法来拿去和存储id的值

    /**
     * 设置
     * @param id
     */
    public static void setCurrentId(Long id){
        threadLocal.set(id);
    }

    /**
     * 拿
     * @return
     */

    public static Long getCurrentId(){
        return threadLocal.get();
    }

}

3.关于FieldFill的源码

/**
 * 字段填充策略枚举类
 *
 * <p>
 * 判断注入的 insert 和 update 的 sql 脚本是否在对应情况下忽略掉字段的 if 标签生成
 * <if test="...">......</if>
 * 判断优先级比 {@link FieldStrategy} 高
 * </p>
 *
 * @author hubin
 * @since 2017-06-27
 */
public enum FieldFill {
    /**
     * 默认不处理
     */
    DEFAULT,
    /**
     * 插入时填充字段
     */
    INSERT,
    /**
     * 更新时填充字段
     */
    UPDATE,
    /**
     * 插入和更新时填充字段
     */
    INSERT_UPDATE
}