MyBatis-Plus 自动填充插入更新字段实践-CSDN博客

本文链接：https://blog.csdn.net/m0_74404191/article/details/147375615

在数据库表设计中，我们经常需要维护一些公共字段，例如create_time（创建时间）、update_time（更新时间）、create_user（创建人）等。手动在每个插入和更新操作中设置这些字段会带来大量重复代码，而 MyBatis-Plus 的自动填充功能可以优雅地解决这个问题。

一、自动填充的应用场景

创建时间 (create_time)：数据首次插入时自动填充
更新时间 (update_time)：数据每次更新时自动更新
创建人 (create_user)：记录数据创建者信息
更新人 (update_user)：记录数据最后修改者信息

二、实现步骤

1. 添加依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3.1</version>
</dependency>

2. 配置自动填充处理器

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        // 插入时自动填充字段
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
        this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
        this.strictInsertFill(metaObject, "createUser", String.class, getCurrentUserName());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        // 更新时自动填充字段
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
        this.strictUpdateFill(metaObject, "updateUser", String.class, getCurrentUserName());
    }

    private String getCurrentUserName() {
        // 获取当前登录用户，具体实现根据项目而定
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        return authentication != null ? authentication.getName() : "system";
    }
}

3. 在实体类中使用注解

在需要自动填充的字段上添加 @TableField 注解，并指定填充策略：

@Data
@TableName("user")
public class User {
    private Long id;
    private String name;
    
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;
    
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;
    
    @TableField(fill = FieldFill.INSERT)
    private String createUser;
    
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private String updateUser;
}

FieldFill 提供四种填充策略：

DEFAULT：默认不填充
INSERT：插入时填充
UPDATE：更新时填充
INSERT_UPDATE：插入和更新时都填充

三、工作原理

当执行插入操作时，MyBatis-Plus 会自动调用 insertFill 方法
当执行更新操作时，会自动调用 updateFill 方法
处理器根据字段的填充策略判断是否需要填充
使用 strictInsertFill 和 strictUpdateFill 可以保证只有标记了填充策略的字段才会被填充

四、高级用法示例

1. 自定义填充逻辑

如果需要更复杂的填充逻辑，可以在处理器中添加判断：

@Override
public void insertFill(MetaObject metaObject) {
    if (getFieldValByName("createTime", metaObject) == null) {
        setFieldValByName("createTime", LocalDateTime.now(), metaObject);
    }
    // 其他字段填充...
}

2. 多数据源环境配置

在多数据源环境下，需要为每个数据源配置独立的填充处理器：

@Configuration
@MapperScan(basePackages = "com.example.mapper.db1", sqlSessionFactoryRef = "db1SqlSessionFactory")
public class Db1Config {
    @Bean
    public MetaObjectHandler db1MetaObjectHandler() {
        return new MyMetaObjectHandler();
    }
}

@Configuration
@MapperScan(basePackages = "com.example.mapper.db2", sqlSessionFactoryRef = "db2SqlSessionFactory")
public class Db2Config {
    @Bean
    public MetaObjectHandler db2MetaObjectHandler() {
        return new AnotherMetaObjectHandler();
    }
}