Mybatis-Plus 自动填充功能

悠悠 2024-03-26 23:21 45阅读 0赞

原理:

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

第一步在实体类里面添加自动填充注解

public class User {
    
        // 注意！这里需要标记为填充字段
        @TableField(fill = FieldFill.INSERT)
        @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
        private LocalDateTime createTime;
    
        @TableField(fill = FieldFill.INSERT_UPDATE)
        @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
        private LocalDateTime updateTime;
        ....
    }

第二步创建自定义实现类 实现接口 MyMetaObjectHandler

@Component
    public class MyMetaObjectHandler implements MetaObjectHandler {
    
        private static final Logger LOGGER = LoggerFactory.getLogger(MyMetaObjectHandler.class);
    
        /** 新增的时候自动填充*/
        @Override
        public void insertFill(MetaObject metaObject) {
            LOGGER.info("start insert fill ....");
            this.setFieldValByName("createTime", LocalDateTime.now(), metaObject);
            this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
        }
    
        /** 更新后自动填充*/
        @Override
        public void updateFill(MetaObject metaObject) {
            LOGGER.info("start update fill ....");
            this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
        }
    }

注意事项：

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

FieldFill 是一个枚举类型的类,如下：

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

#### *相关* ####