如何理解Spring Boot集成Mybatis Plus自動填充字段

這篇文章主要講解了“如何理解Spring Boot集成Mybatis Plus自動填充字段”，文中的講解內容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“如何理解Spring Boot集成Mybatis Plus自動填充字段”吧！

一般在表設計的時候，都會在表中添加一些系統字段，比如 create_time、update_time等。

加入依賴

下面就通過 MyBatis Plus 來完成字段自動填充，首先加入 MyBatis Plus 依賴：

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

創建實體類，添加填充注解

創建一個實體類，然后在需要自動填充的屬性上加注解 @TableField(fill =  FieldFill.INSERT)、@TableField(fill = FieldFill.INSERT_UPDATE) 等注解。

@Data @TableName("user") public class UserEntity extends BaseEntity {     private static final long serialVersionUID = 1L;     /**      * 主鍵      */     @TableId(value = "id", type = IdType.ASSIGN_ID)     private Long id;     /**      * 姓名      */     @TableField("name")     private String name;     /**      * 年齡      */     @TableField("age")     private Integer age;     /**      * 郵件      */     @TableField("email")     private String email;     /**      * 創建時間      */     @TableField(value = "create_time", fill = FieldFill.INSERT)     public Date createTime;     /**      * 修改時間      */     @TableField(value = "modify_time", fill = FieldFill.INSERT_UPDATE)     public Date modifyTime; }

其中 fill 屬性為字段自動填充策略，可選的參數如下所示：

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

就直接創建一個 Mapper，來便于測試：

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

實現元對象處理器接口

MyBatis Plus 版本不同，實現方式可能會有些許不同，在 3.4.1 版本是實現 MetaObjectHandler 接口，低版本可能是繼承  MetaObjectHandler 抽象類，來實現對應的方法。

下面為實現插入和更新數據的字段填充邏輯，在插入對象時，對創建時間 createTime 和修改時間 modifyTime  字段自動填充為當前時間，在更新對象時，將修改時間 modifyTime 修改為最新時間。

@Component public class CommonMetaObjectHandler implements MetaObjectHandler {     /**      * 創建時間      */     private static final String FIELD_SYS_CREATE_TIME = "createTime";     /**      * 修改時間      */     private static final String FIELD_SYS_MODIFIED_TIME = "modifyTime";      /**      * 插入元對象字段填充（用于插入時對公共字段的填充）      *      * @param metaObject 元對象      */     @Override     public void insertFill(MetaObject metaObject) {         Date currentDate = new Date();         // 插入創建時間         if (metaObject.hasSetter(FIELD_SYS_CREATE_TIME)) {             this.strictInsertFill(metaObject, FIELD_SYS_CREATE_TIME, Date.class, currentDate);         }         // 同時設置修改時間為當前插入時間         if (metaObject.hasSetter(FIELD_SYS_MODIFIED_TIME)) {             this.strictUpdateFill(metaObject, FIELD_SYS_MODIFIED_TIME, Date.class, currentDate);         }     }      /**      * 更新元對象字段填充（用于更新時對公共字段的填充）      *      * @param metaObject 元對象      */     @Override     public void updateFill(MetaObject metaObject) {         this.setFieldValByName(FIELD_SYS_MODIFIED_TIME, new Date(), metaObject);     } }

其中，默認填充策略為默認有值不覆蓋，如果提供的值為 null 也不填充。如果默認填充策略不滿足，可以重寫 strictFillStrategy  方法以滿足自己的需求。

測試字段自動填充

編寫測試類來檢驗是否在插入和更新操作時，是否會自動填充響應的字段。

@Slf4j @RunWith(SpringRunner.class) @SpringBootTest public class AutoFillTest {     @Resource     private UserMapper userMapper;     @Test     public void test() throws InterruptedException {         UserEntity user = new UserEntity();         user.setName("wupx");         user.setAge(18);         user.setEmail("wupx@qq.com");         userMapper.insert(user);         Long id = user.getId();         UserEntity beforeUser = userMapper.selectById(id);         log.info("before user:{}", beforeUser);         Assert.assertNotNull(beforeUser.getCreateTime());         Assert.assertNotNull(beforeUser.getModifyTime());         beforeUser.setAge(19);         Thread.sleep(1000L);         userMapper.updateById(beforeUser);         log.info("query user:{}", userMapper.selectById(id));         // 清除測試數據         userMapper.deleteById(id);     } }

啟動測試類，通過日志可以看出來：

before user:UserEntity(id=1346071927831134210, name=wupx, age=18, email=wupx@qq.com, createTime=Mon Jan 04 20:32:11 CST 2021, modifyTime=Mon Jan 04 20:32:11 CST 2021) query user:UserEntity(id=1346071927831134210, name=wupx, age=19, email=wupx@qq.com, createTime=Mon Jan 04 20:32:11 CST 2021, modifyTime=Mon Jan 04 20:32:13 CST 2021)

第一次插入對象的時候，創建時間和修改時間都自動填充了，當修改對象的時候，修改時間也相應的進行了更新。

另外可以將公共字段封裝到公共類中，比如 BaseEntity：

@Data public class BaseEntity {     /**      * 主鍵      */     @TableId(value = "id", type = IdType.ASSIGN_UUID)     private Long id;     /**      * 創建時間      */     @TableField(value = "create_time", fill = FieldFill.INSERT)     private Date createTime;     /**      * 修改時間      */     @TableField(value = "modify_time", fill = FieldFill.INSERT_UPDATE)     private Date modifyTime; }

經過測試，也是可以完成公共字段的自動填充，大家也可以在項目中這樣搞下，可以減少每次插入或者更新時的 set 操作。

感謝各位的閱讀，以上就是“如何理解Spring Boot集成Mybatis Plus自動填充字段”的內容了，經過本文的學習后，相信大家對如何理解Spring Boot集成Mybatis Plus自動填充字段這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！