MyBatis-Plus實現(xiàn)自動填充功能的示例代碼

更新時間：2025年07月30日 10:45:32 作者：SimonKing

在數(shù)據(jù)庫設(shè)計中,常常有一些字段每次都需要賦值,如創(chuàng)建時間、更新時間、操作人、刪除標(biāo)識等,有沒有框架級的技術(shù),全局處理這樣的統(tǒng)一字段呢？當(dāng)然有,Mybatis-Plus自動填充技術(shù)幫我們解決問題,本文給大家詳細(xì)介紹了MyBatis-Plus實現(xiàn)自動填充功能,需要的朋友可以參考下

01 引言

在數(shù)據(jù)庫設(shè)計中，常常有一些字段每次都需要賦值，如創(chuàng)建時間、更新時間、操作人、刪除標(biāo)識等。很多時候，為了趕項目匆匆的賦值了一些業(yè)務(wù)字段，而漏掉了這些字段，導(dǎo)致查詢問題的時候，時間點或者操作人對不上，加大了定位問題的難度。

有沒有框架級的技術(shù)，全局處理這樣的統(tǒng)一字段呢？當(dāng)然有。

Mybatis-Plus自動填充技術(shù)幫我們解決問題。

02 自動填充實現(xiàn)

使用Mybtis-Plus之前，我們需要簡單的搭建環(huán)境。

2.1 Mybatis-Plus 簡單搭建

Maven

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>${mybatis-plus.version}</version>
</dependency>
<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
    <scope>runtime</scope>
</dependency>

配置

# 數(shù)據(jù)源
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test
spring.datasource.username=root
spring.datasource.password=root

# 日志實現(xiàn)
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
# 開啟駝峰匹配
mybatis-plus.configuration.map-underscore-to-camel-case=true
# 配置全局?jǐn)?shù)據(jù)庫主鍵
mybatis-plus.global-config.db-config.id-type=auto

啟動類增加Mapper掃描

@MapperScan("com.simonking.boot.mybaits.mapper")

實體

@Data
@TableName("user_info")
public class UserInfo {
    
    /**
     * 主鍵ID
     **/
    @TableId
    private Integer id;

    /**
     * 姓名
     **/
    private String name;

    /**
     * 年齡
     **/
    private Integer age;


    /**
     * 性別
     **/
    private String sex;

    /**
     * 工作
     **/
    private String job;

    /**
     * 生日
     **/
    private LocalDateTime birthday;

    /**
     * 創(chuàng)建時間
     **/
    private LocalDateTime createdTime;

    /**
     * 更新時間
     **/
    private LocalDateTime updateTime;
}

繼承BaseMapper

public interface UserInfoMapper extends BaseMapper<UserInfo> {

}

到這里，Mybatis-Plus就搭建好了，可以注解注入xxxMapper調(diào)用方法了。

2.2 標(biāo)記自動填充的字段

在實體類中，你需要使用 @TableField 注解來標(biāo)記哪些字段需要自動填充，并指定填充的策略。

@Data
@TableName("user_info")
public class UserInfo {
    
    // 其他字段...

    /**
     * 創(chuàng)建時間
     **/
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createdTime;

    /**
     * 更新時間
     **/
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;
}

FieldFill填充的枚舉：

public enum FieldFill {
    DEFAULT,       // 默認(rèn)不處理
    INSERT,        // 插入填充字段
    UPDATE,        // 更新填充字段
    INSERT_UPDATE  // 插入和更新填充字段
}

2.3 實現(xiàn)MetaObjectHandler

創(chuàng)建一個類來實現(xiàn) MetaObjectHandler 接口，并重寫 insertFill 和 updateFill 方法。并確保實現(xiàn)類被Spring管理，可以通過 @Component 或 @Bean 注解來實現(xiàn)。

@Slf4j
@Component
public class AutoFillMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("insertFill 開始自動填充......");
        this.strictInsertFill(metaObject, "createdTime", LocalDateTime.class, LocalDateTime.now());
        this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("updateFill 開始自動填充......");
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }
}

2.4 測試

 @Test
void contextLoads01() {
    UserInfo userInfo = new UserInfo();
    userInfo.setName("test");
    userInfo.setAge(18);
    userInfoMapper.insert(userInfo);
}

從運行結(jié)果來看，cteated_time和update_time已經(jīng)被賦值了。

2.5 思考

這種全局的自動填充有什么問題呢？

先看截圖：

這里填充的時候，需要指定字段的名稱。但是如果因為開發(fā)人員定義錯字段，如update_time -> updated_time等，這里就需要窮舉所有的字段。

有人可能說是開發(fā)規(guī)范的問題，的確是。但是這種問題確實有點別扭。

能不能通過注解字段指定別名，統(tǒng)一自動賦值的字段呢？官方暫時不支持這種方式。

03 實現(xiàn)原理

自動賦值的的觸發(fā)機制是如何實現(xiàn)的呢？第一反應(yīng)，應(yīng)該是使用了Mybatis的攔截器插件，細(xì)看了之后，并不是。我們一起來看看。

Mybatis-Plus自動填充調(diào)用MetaObjectHandler,涉及了兩個的類：

com.baomidou.mybatisplus.core.MybatisParameterHandler

3.1 MybatisParameterHandler

com.baomidou.mybatisplus.core.MybatisParameterHandler是對Mybaits原生的org.apache.ibatis.scripting.defaults.DefaultParameterHandler的增強。DefaultParameterHandler是Mybatis處理SQL參數(shù)的核心類，負(fù)責(zé)：