Mybatis-Plus 自動填充失效問題解決

更新時間：2024年10月23日 11:06:09 作者：Excellent的崽子

在使用MyBatis-Plus時,自動填充功能可能會失效,這通常與版本和配置有關(guān),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

確認版本

首先確認你的項目中使用的 mybatis-plus 版本是 3.3.0 以下還是 3.3.0 以上（包含 3.3.0），在低版本和高版本中重寫 MetaObjectHandler 方法的 insertFill 和 updateFill 的寫法是不同的，比如下面示例：

@Bean
public MetaObjectHandler metaObjectHandler(){

    return new MetaObjectHandler() {
        @Override
        public void insertFill(MetaObject metaObject) {
            this.setFieldValByName("createdDate", new Date(), metaObject);
            this.setFieldValByName("updatedDate", new Date(), metaObject);
        }
            @Override
        public void updateFill(MetaObject metaObject) {
            this.setFieldValByName("updatedDate", new Date(), metaObject);
        }
    };
}

這是使用 MyBatis-Plus 早期版本（在 3.3.0 之前）的自定義 MetaObjectHandler 實現(xiàn)。它使用 setFieldValByName 方法來設置 createdDate 和 updatedDate 字段的值。這種方法使用的是 java.util.Date 類型。

    @Bean
    public MetaObjectHandler metaObjectHandler(){
        return new MetaObjectHandler() {
            @Override
            public void insertFill(MetaObject metaObject) {
                this.strictInsertFill(metaObject, "createdDate", Date.class, new Date());
                this.strictInsertFill(metaObject, "updatedDate", Date.class, new Date());
            }

            @Override
            public void updateFill(MetaObject metaObject) {
                this.strictUpdateFill(metaObject, "updatedDate",  LocalDateTime.class, LocalDateTime.now());
            }
        };
    }

這是使用 MyBatis-Plus 3.3.0 及以上版本中引入的更高級的填充策略。它使用 strictInsertFill 和 strictUpdateFill 方法，這些方法更加類型安全，也提供了更靈活的填充選項。此版本推薦使用 java.time.LocalDateTime 類型，這符合 Java 8 及更高版本中引入的時間 API，提供了更好的日期和時間處理能力。
詳細對比：

類型安全性：

第二種寫法中，strictInsertFill 和 strictUpdateFill 方法允許你指定目標字段的數(shù)據(jù)類型（例如 LocalDateTime.class），從而避免了類型轉(zhuǎn)換錯誤。

第一種寫法中，setFieldValByName 方法需要你自己確保字段類型和賦值類型的一致性。

默認值提供方式：

第二種寫法中，你可以直接傳遞一個 LocalDateTime.now() 表達式，或者使用 lambda 表達式 () -> LocalDateTime.now() 來提供一個延遲執(zhí)行的默認值。這在某些情況下可能更有用，比如當你的默認值依賴于一些業(yè)務邏輯時。

第一種寫法直接使用 new Date() 創(chuàng)建日期實例，沒有提供延遲執(zhí)行的機制。

兼容性和 bug 修復：

第二種寫法是 MyBatis-Plus 推薦的最新實踐，通常意味著它有更好的兼容性和已知問題的修復。

第一種寫法可能在新版本中不再得到支持，或存在未解決的 bug，例如 fillStrategy 方法在 3.3.0 版本中有 bug。

檢查配置

首先是引入高版本的 pom 依賴：

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

編寫mybatis-plus的配置類

/**
 * MyBatis-Plus配置類
 */
@MapperScan("com.demo.mapper") // 定義項目中的 mapper 路徑
@Configuration
public class MybatisPlusConfig {

    /**
     * mybatis-plus 自動填充配置
     */
    @Bean
    public MetaObjectHandler metaObjectHandler(){
        return new MetaObjectHandler() {
            @Override
            public void insertFill(MetaObject metaObject) {
                /**
                  * 第一個參數(shù) metaObject 這里面包含了你傳入的實體類
                  * 第二個參數(shù)要和實體類中的屬性名保持一致
                  * 第三個參數(shù)要跟實體類中的屬性類型保持一致
                  * 第四個參數(shù)是你設置的填充默認值
                  */      
                this.strictInsertFill(metaObject, "createdDate", Date.class, new Date());
                this.strictInsertFill(metaObject, "updatedDate", Date.class, new Date());
            }

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

}

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

public class User {
    @TableField(fill = FieldFill.INSERT)
    private String createTime;

    @TableField(fill = FieldFill.UPDATE)
    private String updateTime;

    // 其他字段...
}

delete 和 update 方法的區(qū)別

在 MyBatis-Plus 中，`delete` 方法和 `update` 方法的行為差異主要源于它們對 `MetaObjectHandler` 中定義的自動填充邏輯的調(diào)用時機和方式的不同。

對于 update方法：

當你使用 update 方法時，MyBatis-Plus 會調(diào)用 MetaObjectHandler 的 updateFill 方法。這是因為 update 方法本質(zhì)上是一個更新操作，它會觸發(fā)自動填充邏輯，尤其是那些被標記為 FieldFill.UPDATE 或 FieldFill.INSERT_UPDATE 的字段。

對于 delete 方法：

當使用 delete 方法時，情況就有所不同了。默認情況下，delete 方法不會觸發(fā) MetaObjectHandler 的 updateFill 方法，即使你正在使用邏輯刪除（即，delete 方法實際上執(zhí)行的是一個 UPDATE 語句來修改一個邏輯刪除標志）。這是因為在 MyBatis-Plus 的設計中，delete 方法的目的就是刪除記錄，無論是物理刪除還是邏輯刪除，它都不會觸發(fā)更新字段的自動填充邏輯。

然而，當你在實體類中使用了 @TableLogic 注解并配置了邏輯刪除，MyBatis-Plus 的 delete 方法會執(zhí)行一個 UPDATE 語句來改變邏輯刪除字段的值，但它不會執(zhí)行 updateFill 方法來更新其他字段，如 updatedDate。這是 MyBatis-Plus 的設計決策，它將 delete 和 update 視為不同的操作，即使在邏輯刪除的情況下，delete 方法也不會觸發(fā)常規(guī)的更新字段填充。