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

更新時間：2024年09月25日 09:02:39 作者：Flying_Fish_Xuan

MyBatis-Plus 提供了自動填充功能,幫助開發(fā)者在插入或更新數(shù)據(jù)時,自動為某些字段賦值,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

在日常開發(fā)中，數(shù)據(jù)庫表通常會包含一些系統(tǒng)自動維護的字段，例如：創(chuàng)建時間、更新時間、操作人等。為了減少手動維護這些字段的重復代碼，MyBatis-Plus 提供了自動填充功能，幫助開發(fā)者在插入或更新數(shù)據(jù)時，自動為某些字段賦值。

1. MyBatis-Plus 自動填充簡介

MyBatis-Plus 提供的自動填充功能，可以在數(shù)據(jù)庫插入或更新時，自動為指定的字段設(shè)置值，而不需要每次手動傳遞。例如：

在記錄插入時自動填充創(chuàng)建時間 created_at。
在記錄更新時自動填充更新時間 updated_at。
自動填充操作用戶 ID 或者一些其他固定值。

MyBatis-Plus 通過 @TableField 注解中的 fill 屬性和 MetaObjectHandler 接口來實現(xiàn)自動填充。fill 屬性用于指定字段在插入或更新時是否自動填充，而 MetaObjectHandler 是用于實現(xiàn)自動填充邏輯的接口。

2. 自動填充的配置步驟

2.1 在實體類中標注需要自動填充的字段

MyBatis-Plus 通過 @TableField(fill = ...) 注解來標注需要自動填充的字段，并指定該字段的填充策略。常見的填充策略有：

FieldFill.INSERT：在插入時自動填充。
FieldFill.UPDATE：在更新時自動填充。
FieldFill.INSERT_UPDATE：在插入和更新時都自動填充。

示例：

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import lombok.Data;
import java.time.LocalDateTime;

@Data
public class User {

    private Integer id;

    private String username;

    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createdAt;  // 插入時自動填充

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updatedAt;  // 插入和更新時自動填充
}

createdAt：在插入記錄時自動填充當前時間。
updatedAt：在插入和更新記錄時自動填充當前時間。

2.2 創(chuàng)建自動填充處理器

MyBatis-Plus 提供了 MetaObjectHandler 接口，開發(fā)者可以實現(xiàn)該接口中的 insertFill 和 updateFill 方法來自定義填充邏輯。

示例：

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

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    // 插入時自動填充
    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createdAt", LocalDateTime::now, LocalDateTime.class);  // 創(chuàng)建時間
        this.strictInsertFill(metaObject, "updatedAt", LocalDateTime::now, LocalDateTime.class);  // 更新時間
    }

    // 更新時自動填充
    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updatedAt", LocalDateTime::now, LocalDateTime.class);  // 更新時間
    }
}

strictInsertFill：用于在插入操作時自動填充指定字段。
strictUpdateFill：用于在更新操作時自動填充指定字段。

在 insertFill 方法中，createdAt 和 updatedAt 字段會在插入時自動填充當前時間。而在 updateFill 方法中，updatedAt 字段會在更新時自動填充當前時間。

2.3 完整示例

以下是一個完整的 MyBatis-Plus 自動填充示例，包含實體類、填充處理器和測試代碼：

1. User 實體類

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.IdType;
import lombok.Data;
import java.time.LocalDateTime;

@Data
public class User {

    @TableId(type = IdType.AUTO)
    private Integer id;

    private String username;

    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createdAt;  // 創(chuàng)建時自動填充

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updatedAt;  // 創(chuàng)建和更新時自動填充
}

2. 自動填充處理器

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

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createdAt", LocalDateTime::now, LocalDateTime.class);
        this.strictInsertFill(metaObject, "updatedAt", LocalDateTime::now, LocalDateTime.class);
    }

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

3. UserMapper 接口

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.model.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User> {
}

4. 測試代碼

import com.example.demo.mapper.UserMapper;
import com.example.demo.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class MyTestRunner implements CommandLineRunner {

    @Autowired
    private UserMapper userMapper;

    @Override
    public void run(String... args) throws Exception {
        // 測試插入時自動填充
        User user = new User();
        user.setUsername("John Doe");
        userMapper.insert(user);
        System.out.println("Inserted user: " + user);

        // 測試更新時自動填充
        user.setUsername("Jane Doe");
        userMapper.updateById(user);
        System.out.println("Updated user: " + user);
    }
}

在上面的測試代碼中：

插入新用戶時，createdAt 和 updatedAt 字段都會被自動填充。
更新用戶時，updatedAt 字段會被自動更新。

3. 自動填充策略詳解

3.1 自動填充策略選項

@TableField 注解的 fill 屬性支持以下自動填充策略：

FieldFill.INSERT：僅在插入時自動填充。
FieldFill.UPDATE：僅在更新時自動填充。
FieldFill.INSERT_UPDATE：在插入和更新時都自動填充。

@TableField(fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updatedAt;

3.2 MetaObjectHandler 方法詳解

strictInsertFill：用于插入時自動填充字段，接受 4 個參數(shù)：MetaObject、字段名、填充值和字段類型。

this.strictInsertFill(metaObject, "createdAt", LocalDateTime::now, LocalDateTime.class);

strictUpdateFill：用于更新時自動填充字段。

this.strictUpdateFill(metaObject, "updatedAt", LocalDateTime::now, LocalDateTime.class);

如果不需要區(qū)分插入和更新，可以直接使用 setFieldValByName 方法：

this.setFieldValByName("updatedAt", LocalDateTime.now(), metaObject);

3.3 手動觸發(fā)填充

在某些場景下，可能希望在代碼中手動觸發(fā)自動填充邏輯，可以使用 fillStrategy 方法。

MetaObject metaObject = SystemMetaObject.forObject(user);
this.fillStrategy(metaObject, "updatedAt", LocalDateTime.now());

4. 自動填充的注意事項

4.1 數(shù)據(jù)庫默認值沖突

如果數(shù)據(jù)庫字段設(shè)置了默認值，且實體類同時使用了自動填充，可能會導致沖突。解決辦法是在數(shù)據(jù)庫中移除默認值，完全依賴 MyBatis-Plus 進行自動填充。

4.2 MetaObjectHandler 必須注冊為 Spring Bean

自動填充處理器類 MetaObjectHandler 必須由 Spring 容器管理（即使用 @Component 注解），否則自動填充不會生效。

4.3 覆蓋已有值

在插入或更新時，MyBatis-Plus 會自動為標注了 fill 的字段賦值，但如果這些字段已經(jīng)有值，則 MyBatis-Plus 默認不會覆蓋已有值

。要覆蓋已有值，可以使用 strictInsertFill 或 strictUpdateFill。

5. 常見使用場景

5.1 創(chuàng)建時間和更新時間自動填充

在大多數(shù)數(shù)據(jù)庫表中，都會有 created_at 和 updated_at 字段，用于記錄數(shù)據(jù)的創(chuàng)建時間和最后更新時間。通過自動填充功能，MyBatis-Plus 可以輕松實現(xiàn)這兩個字段的自動維護。

5.2 操作人自動填充

在操作日志、審計系統(tǒng)等場景下，通常需要記錄操作人 ID?？梢酝ㄟ^自動填充機制，在插入和更新記錄時，自動獲取當前用戶 ID 并填充到表中。

@Override
public void insertFill(MetaObject metaObject) {
    this.strictInsertFill(metaObject, "operatorId", () -> getCurrentUserId(), Long.class);
}