自动填充功能

示例工程:

👉 mybatis-plus-sample-auto-fill-metainfo自动填充功能 - 图1

  • 实现元对象处理器接口:com.baomidou.mybatisplus.core.handlers.MetaObjectHandler

  • 注解填充字段 @TableField(.. fill = FieldFill.INSERT) 生成器策略部分也可以配置!

  1. public class User {
  2. // 注意!这里需要标记为填充字段
  3. @TableField(.. fill = FieldFill.INSERT)
  4. private String fillField;
  5. ....
  6. }
  • 自定义实现类 MyMetaObjectHandler
  1. @Slf4j
  2. @Component
  3. public class MyMetaObjectHandler implements MetaObjectHandler {
  4. @Override
  5. public void insertFill(MetaObject metaObject) {
  6. log.info("start insert fill ....");
  7. this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
  8. this.fillStrategy(metaObject, "createTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug请升级到之后的版本如`3.3.1.8-SNAPSHOT`)
  9. /* 上面选其一使用,下面的已过时(注意 strictInsertFill 有多个方法,详细查看源码) */
  10. //this.setFieldValByName("operator", "Jerry", metaObject);
  11. //this.setInsertFieldValByName("operator", "Jerry", metaObject);
  12. }
  13. @Override
  14. public void updateFill(MetaObject metaObject) {
  15. log.info("start update fill ....");
  16. this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
  17. this.fillStrategy(metaObject, "updateTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug请升级到之后的版本如`3.3.1.8-SNAPSHOT`)
  18. /* 上面选其一使用,下面的已过时(注意 strictUpdateFill 有多个方法,详细查看源码) */
  19. //this.setFieldValByName("operator", "Tom", metaObject);
  20. //this.setUpdateFieldValByName("operator", "Tom", metaObject);
  21. }
  22. }

注意事项:

  • 字段必须声明TableField注解,属性fill选择对应策略,该声明告知Mybatis-Plus需要预留注入SQL字段
  • 填充处理器MyMetaObjectHandler在 Spring Boot 中需要声明@Component@Bean注入
  • 要想根据注解FieldFill.xxx字段名以及字段类型来区分必须使用父类的strictInsertFill或者strictUpdateFill方法
  • 不需要根据任何来区分可以使用父类的fillStrategy方法
  1. public enum FieldFill {
  2. /**
  3. * 默认不处理
  4. */
  5. DEFAULT,
  6. /**
  7. * 插入填充字段
  8. */
  9. INSERT,
  10. /**
  11. * 更新填充字段
  12. */
  13. UPDATE,
  14. /**
  15. * 插入和更新填充字段
  16. */
  17. INSERT_UPDATE
  18. }