阅读(3961) (0)

MyBatis-Plus 扩展-自动填充功能

2022-03-25 11:04:32 更新

原理:

  • 实现元对象处理器接口:​com.baomidou.mybatisplus.core.handlers.MetaObjectHandler
  • 注解填充字段 ​@TableField(.. fill = FieldFill.INSERT)​ 生成器策略部分也可以配置!

public class User {

    // 注意!这里需要标记为填充字段
    @TableField(.. fill = FieldFill.INSERT)
    private String fillField;

    ....
}

  • 自定义实现类 ​MyMetaObjectHandler

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
        // 或者
        this.strictInsertFill(metaObject, "createTime", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐)
        // 或者
        this.fillStrategy(metaObject, "createTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug)
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐)
        // 或者
        this.strictUpdateFill(metaObject, "updateTime", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐)
        // 或者
        this.fillStrategy(metaObject, "updateTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug)
    }
}

注意事项:

  • 填充原理是直接给​entity的属性设置值!!!
  • 注解则是指定该属性在对应情况下必有值,如果无值则入库会是​null
  • MetaObjectHandler提供的默认方法的策略均为:如果属性有值则不覆盖,如果填充值为​null则不填充
  • 字段必须声明​TableField​注解,属性fill选择对应策略,该声明告知Mybatis-Plus需要预留注入SQL字段
  • 填充处理器​MyMetaObjectHandler​在 Spring Boot 中需要声明​@Component​或​@Bean​注入
  • 要想根据注解​FieldFill.xxx​和字段名以及字段类型来区分必须使用父类的​strictInsertFill​或者​strictUpdateFill​方法
  • 不需要根据任何来区分可以使用父类的​fillStrategy​方法
  • update(T t,Wrapper updateWrapper)​时​t​不能为空,否则自动填充失效

public enum FieldFill {
    /**
     * 默认不处理
     */
    DEFAULT,
    /**
     * 插入填充字段
     */
    INSERT,
    /**
     * 更新填充字段
     */
    UPDATE,
    /**
     * 插入和更新填充字段
     */
    INSERT_UPDATE
}