Mybatis-Plus怎么使用@TableField實現自動填充日期

Mybatis-Plus怎么使用@TableField實現自動填充日期

引言

在開發過程中，我們經常需要在數據庫表中記錄數據的創建時間和更新時間。手動在每次插入或更新數據時設置這些字段不僅繁瑣，而且容易出錯。Mybatis-Plus 提供了 @TableField 注解，結合自動填充功能，可以輕松實現這些字段的自動填充。本文將詳細介紹如何使用 Mybatis-Plus 的 @TableField 注解實現自動填充日期。

1. Mybatis-Plus 簡介

Mybatis-Plus 是 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，簡化開發、提高效率。它提供了許多實用的功能，如自動生成代碼、分頁插件、性能分析插件等。其中，自動填充功能是一個非常實用的特性，可以幫助我們自動填充某些字段的值，如創建時間、更新時間等。

2. 自動填充功能概述

Mybatis-Plus 的自動填充功能允許我們在插入或更新數據時，自動填充某些字段的值。這些字段的值可以通過自定義的填充策略來生成。常見的應用場景包括：

• 自動填充創建時間（create_time）
• 自動填充更新時間（update_time）
• 自動填充操作人（operator）

3. 使用 @TableField 實現自動填充

3.1 添加 @TableField 注解

首先，我們需要在實體類中為需要自動填充的字段添加 @TableField 注解，并指定 fill 屬性。fill 屬性用于指定字段的填充策略，常用的策略包括：

• FieldFill.DEFAULT：默認策略，不自動填充
• FieldFill.INSERT：插入時自動填充
• FieldFill.UPDATE：更新時自動填充
• FieldFill.INSERT_UPDATE：插入和更新時自動填充

例如，我們有一個 User 實體類，其中包含 createTime 和 updateTime 兩個字段，我們希望在這兩個字段上實現自動填充：

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

import java.util.Date;

@Data
@TableName("user")
public class User {

    private Long id;

    private String name;

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

3.2 實現 MetaObjectHandler 接口

接下來，我們需要實現 MetaObjectHandler 接口，并在其中定義字段的填充邏輯。MetaObjectHandler 接口有兩個方法需要實現：

• insertFill(MetaObject metaObject)：在插入數據時調用
• updateFill(MetaObject metaObject)：在更新數據時調用

我們可以在這些方法中為需要自動填充的字段設置值。例如，我們可以創建一個 MyMetaObjectHandler 類來實現 MetaObjectHandler 接口：

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
        this.strictInsertFill(metaObject, "updateTime", Date.class, new Date());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
    }
}

在上面的代碼中，我們使用 strictInsertFill 和 strictUpdateFill 方法來設置字段的值。這些方法會檢查字段是否已經存在值，如果字段已經有值，則不會覆蓋它。

3.3 配置 Mybatis-Plus

最后，我們需要確保 Mybatis-Plus 能夠識別我們的 MetaObjectHandler 實現類。通常情況下，Spring Boot 會自動掃描并注冊 @Component 注解的類，因此我們不需要額外的配置。

如果你使用的是非 Spring Boot 項目，或者需要手動配置 Mybatis-Plus，可以在配置文件中添加以下配置：

<bean id="myMetaObjectHandler" class="com.example.MyMetaObjectHandler"/>

或者在 Java 配置類中手動注冊：

@Bean
public MetaObjectHandler metaObjectHandler() {
    return new MyMetaObjectHandler();
}

4. 測試自動填充功能

完成上述步驟后，我們可以通過插入和更新數據來測試自動填充功能是否正常工作。

4.1 插入數據

當我們插入一條新的 User 記錄時，createTime 和 updateTime 字段應該被自動填充為當前時間：

User user = new User();
user.setName("John Doe");
userMapper.insert(user);

執行上述代碼后，數據庫中的 user 表應該會有一條新記錄，createTime 和 updateTime 字段的值均為當前時間。

4.2 更新數據

當我們更新一條 User 記錄時，updateTime 字段應該被自動更新為當前時間：

User user = userMapper.selectById(1L);
user.setName("Jane Doe");
userMapper.updateById(user);

執行上述代碼后，數據庫中的 user 表的 updateTime 字段應該被更新為當前時間，而 createTime 字段保持不變。

5. 注意事項

在使用 @TableField 實現自動填充時，需要注意以下幾點：

• 字段類型：自動填充的字段類型必須與填充值的類型一致。例如，如果字段類型為 Date，則填充值也必須是 Date 類型。
• 字段名稱：在 MetaObjectHandler 中設置字段值時，字段名稱必須與實體類中的字段名稱一致。
• 字段值覆蓋：如果字段已經有值，strictInsertFill 和 strictUpdateFill 方法不會覆蓋它。如果需要強制覆蓋，可以使用 setFieldValByName 方法。

6. 總結

通過 Mybatis-Plus 的 @TableField 注解和 MetaObjectHandler 接口，我們可以輕松實現字段的自動填充功能。這不僅簡化了代碼，還減少了出錯的可能性。在實際開發中，自動填充功能可以廣泛應用于創建時間、更新時間、操作人等字段的自動管理。

希望本文能幫助你更好地理解和使用 Mybatis-Plus 的自動填充功能。如果你有任何問題或建議，歡迎在評論區留言討論。

7. 參考文檔

• Mybatis-Plus 官方文檔
• Mybatis-Plus GitHub 倉庫

作者: [Your Name]
日期: [2023-10-01]
版權: 本文采用 CC BY-NC-SA 4.0 協議進行許可。