MybatisPlus公共字段自动填充

MybatisPlus公共字段自动填充

插入或更新的时候,为指定的字段赋予指定的值,使用的好处就是可以统一对这些字段进行处理,避免重复代码

步骤

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

指定哪些字段用了自动填充

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

编写处理器

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import delta.main.utils.BaseContext;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

/**
 * 自定义元数据处理器
 */
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
    /**
     * 插入元对象字段填充（用于插入时对公共字段的填充）
     *
     * @param metaObject 元对象
     */
    @Override
    public void insertFill(MetaObject metaObject) { // 执行插入操作的时候自动调用
        log.info("公共字段自动填充[insert]");
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime",LocalDateTime.now());
        metaObject.setValue("createUser",BaseContext.getCurrentId());
        metaObject.setValue("updateUser",BaseContext.getCurrentId());
    }

    /**
     * 更新元对象字段填充（用于更新时对公共字段的填充）
     *
     * @param metaObject 元对象
     */
    @Override
    public void updateFill(MetaObject metaObject) { // 执行更新的时候自动调用
        log.info("公共字段自动填充[update]");
        metaObject.setValue("updateTime",LocalDateTime.now());
        metaObject.setValue("updateUser", BaseContext.getCurrentId());
    }
}

小问题

• 不同的请求,参数不同,可能里面的操作人,创建人是不一样的
• 这个原则上是应该从session中获取当前的操作人,但是MyMetaObjectHandler 获取不到
• 曲线救国,通过ThreadLocal,不同线程里面的变量不冲突,隔离来解决问题
• 每次操作获取的都是线程内部自己的变量,故公司内部可以直接通过LoginContext工具类来获取,LoginContext里也是用了ThreadLocal来解决这个问题

工具类BaseContext

public class BaseContext {
    // 线程是作用域,每个线程保存副本
    private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();

    public static void setCurrentId(Long id){
        threadLocal.set(id);
    }
    public static Long getCurrentId(){
        return threadLocal.get();
    }
}