mybatis plus CU自動填充和軟刪除自動填充的實現方法

Posted on 2021-07-14 by WalkonNet

說明

CU 是 CRUD 中的創建和修改

本文實現以下需求效果

創建數據時自動填充 createTime
更新數據時自動填充 updateTime(每次修改都自動填充新的 updateTime 值)
軟刪除數據時自動填充 deleteUserId 和 deleteTime

創建

實體類

為實體類(DO)的 createTime 字段配置以下 Annotation，代表標記在插入(insert into)時自動填充字段值

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

實現 MetaObjectHandler

如果實體(DO)中配置瞭上面的註解，就會執行這個 handler。這裡在 insert 時自動填充 createTime 字段的值

public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
    private static final String createTime = "createTime";

    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, createTime, Date::new, Date.class);
        // 關於 is_delete 字段，這裡不提供默認值，因為官方推薦設置數據庫中列的默認值
    }

    @Override
    public void updateFill(MetaObject metaObject) {}   
}

配置

註入 IOC 容器。
在 MybatisPlusMetaObjectHandler 類上配置 @Configuration 註解也可以達到同樣目的。

@Configuration
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusMetaObjectHandler mybatisPlusCommonDateFieldValueFillHandler(){
        return new MybatisPlusMetaObjectHandler();
    }
}

更新

實體類

在實體類(DO)上配置註解

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

實現 MetaObjectHandler

如果實體(DO)中配置瞭上面的註解，就會執行這個 handler。這裡在 update 時自動填充 updateTime 字段的值

特別註意，這裡需要重寫 strictFillStrategy 方法，因為默認的行為不會按照預期執行（每次更新數據時都更新 updateTime)

public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
    private static final String updateTime = "updateTime";

    @Override
    public void insertFill(MetaObject metaObject) {}

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

    /**
     * 嚴格模式填充策略,默認有值不覆蓋,如果提供的值為null也不填充
     *
     * @param metaObject metaObject meta object parameter
     * @param fieldName  java bean property name
     * @param fieldVal   java bean property value of Supplier
     * @return this
     * @since 3.3.0
     */
    @Override
    public MetaObjectHandler strictFillStrategy(MetaObject metaObject, String fieldName, Supplier<?> fieldVal) {
        // 但當自動填充字段為 updateTime 時，始終更新它
        if (fieldName.equals(updateTime)) {
            Object obj = fieldVal.get();
            metaObject.setValue(fieldName, obj);
        } else if (metaObject.getValue(fieldName) == null) { // 這個 if 是源碼中的
            Object obj = fieldVal.get();
            if (Objects.nonNull(obj)) {
                metaObject.setValue(fieldName, obj);
            }
        }
        return this;
    }
}

配置

參考創建章節中的配置，如果已經配置瞭就不需要再配置瞭

軟刪除

配置 application.yml

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: is_delete # 邏輯刪除屬性名稱（為數據庫中的字段名稱）
      logic-delete-value: 1 # 代表已刪除的值
      logic-not-delete-value: 0 # 代表未刪除的值

實體類

在實體類(DO)中對以下字段配置註解。

標識 isDelete 字段作為邏輯刪除的標識，然後有兩個需要自動填充值的字段。

/**
  * 邏輯刪除標識
  *
  * \@TableLogic\ 註解標記邏輯刪除屬性
  */
@TableLogic
private Boolean isDelete;

@TableField(fill = FieldFill.UPDATE)
private Integer deleteUserId;

@TableField(fill = FieldFill.UPDATE)
private Date deleteTime;

重寫 DefaultSqlInjector

如果需要在軟刪除時自動填充其他字段的值，才需要重寫這個 DefaultSqlInjector，否則忽略本小節。

這裡配置瞭邏輯刪除時填充其他字段值的 SqlInjector

public class MybatisPlusSqlInjector extends DefaultSqlInjector {
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        final List<AbstractMethod> methods = super.getMethodList(mapperClass);

        methods.add(new LogicDeleteByIdWithFill());

        return methods;
    }
}

實現 MetaObjectHandler

由於 mybatis plus 的 @TableField 註解枚舉字段 fill 的值沒有我們想要的 Delete，所以 Update 和 Delete 實際上都是走的 updateFill 函數，在函數內部我們需要區分出到底是更新還是軟刪除，才能繼續下一步即自動填充不同行為下字段的值

public class MybatisPlusMetaObjectHandler implements MetaObjectHandler {
    private static final String deleteUserId = "deleteUserId";
    private static final String updateTime = "updateTime";
    private static final String deleteTime = "deleteTime";

    @Override
    public void insertFill(MetaObject metaObject) {}

    @Override
    public void updateFill(MetaObject metaObject) {
        // 有這兩個字段並且也已經 deleteUserId 有值(外面必須為實體類設置 deleteUserId 字段的值)，deleteTime 外面不給值
        if (metaObject.hasGetter(deleteUserId)
                && metaObject.hasGetter(deleteTime)
                && !ObjectUtil.isNull(metaObject.getValue(deleteUserId))
                && ObjectUtil.isNull(metaObject.getValue(deleteTime))) {
            this.strictUpdateFill(metaObject, deleteUserId, () -> (Integer) metaObject.getValue(deleteUserId), Integer.class);
            this.strictUpdateFill(metaObject, deleteTime, Date::new, Date.class);
        } else {
            this.strictUpdateFill(metaObject, updateTime, Date::new, Date.class);
        }
    }

    /**
     * 嚴格模式填充策略,默認有值不覆蓋,如果提供的值為null也不填充
     *
     * @param metaObject metaObject meta object parameter
     * @param fieldName  java bean property name
     * @param fieldVal   java bean property value of Supplier
     * @return this
     * @since 3.3.0
     */
    @Override
    public MetaObjectHandler strictFillStrategy(MetaObject metaObject, String fieldName, Supplier<?> fieldVal) {
        // 但當自動填充字段為 updateTime 時，始終更新它
        if (fieldName.equals(updateTime)) {
            Object obj = fieldVal.get();
            metaObject.setValue(fieldName, obj);
        } else if (metaObject.getValue(fieldName) == null) { // 這個 if 是源碼中的
            Object obj = fieldVal.get();
            if (Objects.nonNull(obj)) {
                metaObject.setValue(fieldName, obj);
            }
        }
        return this;
    }
}

配置(註入到 IOC)

我們需要將上面寫的 MybatisPlusSqlInjector 註入 IOC 容器。

同樣的，這兩個 Bean 的配置，與在 MybatisPlusSqlInjector 和 MybatisPlusMetaObjectHandler 上配置 @Configuration 註解的效果一樣。

@Configuration
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusSqlInjector mybatisPlusSqlInjector(){
        return new MybatisPlusSqlInjector();
    }

    @Bean
    public MybatisPlusMetaObjectHandler mybatisPlusCommonDateFieldValueFillHandler(){
        return new MybatisPlusMetaObjectHandler();
    }
}

創建 MyBaseRepository

我這裡將 Mapper 稱為 Repository。因為我用到瞭 MapStruct 庫，個人感覺它更適合被稱為 Mapper。

我們需要自己定義一個 MyBaseMapper 繼承自 BaseMapper(mybatis plus 的)，然後添加一個如下的方法簽名，必須跟下面示例代碼一樣，因為我猜測內部是通過反射來調用的這個函數，所以方法簽名必須一致，否則無法被 mybatis plus 庫調用哦。

public interface MyBaseMapper<Entity>  extends BaseMapper<Entity> {
    /**
     * 邏輯刪除填充其他字段的值
     *
     * @param entity 要刪除的實體對象
     * @return 受影響記錄數量
     */
    int deleteByIdWithFill(Entity entity);
}

我們原來的 Repository 繼承自 mybatis plus 的 BaseMapper，現在我們需要修改為繼承自上面新寫的 MyBaseMapper。

創建 MyBaseService

因為我希望 XXXService 中也有 deleteByIdWithFill 函數，所以這裡我還自定義瞭 Service 的基類，如果不需要的話可以忽略本小節。

自定義的 MyBaseService 繼承自 mybatis plus 的 IService<> 接口，然後添加如下方法簽名，註意方法簽名中的返回值是 boolean 而不是 int，因為寫 Service 需要方便外部使用。

public interface MyBaseService<Entity> extends IService<Entity> {
    /**
     * 邏輯刪除填充其他字段的值
     *
     * @param entity 要刪除的實體對象
     * @return 受影響記錄數量
     */
    boolean deleteByIdWithFill(Entity entity);
}

然後我們寫一個 MyBaseService 的實現類。

註意這裡我們需要繼承自 mybatis plus 的 ServiceImpl 實現，減少我們自己實現的代碼量，同時還需要實現我們的 MyBaseService 接口，然後內部寫的巴巴適適的😋

public class MyBaseServiceImpl<EntityRepository extends MyBaseMapper<Entity>, Entity>
        extends ServiceImpl<EntityRepository, Entity>
        implements MyBaseService<Entity> {
    /**
     * 邏輯刪除填充其他字段的值
     *
     * @param entity 要刪除的實體對象
     * @return 受影響記錄數量
     */
    @Override
    public boolean deleteByIdWithFill(Entity entity) {
         return SqlHelper.retBool(getBaseMapper().deleteByIdWithFill(entity));
    }
}

最後，原來的 XXXService 修改為繼承自新寫的 MyBaseService，XXXServiceImpl 修改為繼承自新寫的 MyBaseServiceImpl

public interface TestService extends MyBaseService<Test> {}

@Service
public class TestServiceImpl extends MyBaseServiceImpl<TestRepository, Test>
implements TestService{}

食用🍜

在 Controller 中的使用方法

@PostMapping("delete")
public ResponseEntity<?> delete(@Valid @NotNull(message = CommonRule.error.whenParamNull) @RequestBody TestTestDeleteBodyVo body) {
    final Test test = testService.getById(body.getId());
    if (test == null) {
        return ResponseEntity.ok().build();
    }

    test.setDeleteUserId(StpUtil.getLoginIdAsInt()); // 必須在軟刪之前設置 deleteUserId 字段的值
    testService.deleteByIdWithFill(test); // 軟刪除必須是這樣刪除

    return ResponseEntity.ok().build();
}

到此這篇關於mybatis plus CU自動填充和軟刪除自動填充的文章就介紹到這瞭,更多相關mybatis plus自動填充內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

mybatis plus CU自動填充和軟刪除自動填充的實現方法

說明

創建

配置

更新

軟刪除

實體類

重寫 DefaultSqlInjector

配置(註入到 IOC)

創建 MyBaseRepository

創建 MyBaseService

推薦閱讀：

發佈留言取消回覆

近期文章

說明

創建

配置

更新

軟刪除

實體類

重寫 DefaultSqlInjector

配置(註入到 IOC)

創建 MyBaseRepository

創建 MyBaseService

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆