解決mybatisplus MetaObjectHandler 失效的問(wèn)題

更新時(shí)間：2023年02月05日 10:53:51 作者：lilun1231

本文主要介紹了解決mybatisplus MetaObjectHandler 失效的問(wèn)題，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

一、什么是metaObjectHandler

MetaObjectHandler接口是mybatisPlus為我們提供的的一個(gè)擴(kuò)展接口，我們可以利用這個(gè)接口在我們插入或者更新數(shù)據(jù)的時(shí)候，為一些字段指定默認(rèn)值
使用方式如下：

1、在實(shí)體類(lèi)上加入@TableField注解

@Getter
@Setter
public class AbstractBaseDO<T extends Model<T>> extends Model<T> implements Serializable {

? ? /**
? ? ?* 創(chuàng)建時(shí)間 新增時(shí)填充
? ? ?*/
? ? @TableField(fill = FieldFill.INSERT)
? ? private Date gmtCreate;

? ? /**
? ? ?* 修改時(shí)間 新增和更新時(shí)填充
? ? ?*/
? ? @TableField(fill = FieldFill.INSERT_UPDATE)
? ? private Date gmtModified;

? ? /**
? ? ?* 創(chuàng)建人ID 新增時(shí)更新
? ? ?*/
? ? @TableField(fill = FieldFill.INSERT)
? ? private Long creatorId;

? ? /**
? ? ?* 修改人ID 新增和更新時(shí)填充
? ? ?*/
? ? @TableField(fill = FieldFill.INSERT_UPDATE)
? ? private Long modifierId;

? ? /**
? ? ?* 邏輯刪除字段 新增和更新時(shí)填充
? ? ?*/
? ? @TableField(fill = FieldFill.INSERT_UPDATE)
? ? private Integer isDeleted;

? ? @Override
? ? public String toString() {
? ? ? ? return new ToStringBuilder(this)
? ? ? ? ? ? .append("gmtCreate", gmtCreate)
? ? ? ? ? ? .append("gmtModified", gmtModified)
? ? ? ? ? ? .append("creatorId", creatorId)
? ? ? ? ? ? .append("modifierId", modifierId)
? ? ? ? ? ? .append("isDeleted", isDeleted)
? ? ? ? ? ? .toString();
? ? }
}

2、創(chuàng)建配置類(lèi)實(shí)現(xiàn)MetaObjectHandler接口

@Slf4j
@Configuration
public class MetaObjectHandlerConfig implements MetaObjectHandler {
?? ?
?? ?/**
?? ?*插入時(shí)自動(dòng)填充
?? ?*/
? ? @Override
? ? public void insertFill(MetaObject metaObject) {
? ? ? ? //獲得用戶上下文
? ? ? ? UserContext dscUser = GlobalSessionContext.getDscUser();
? ? ? ? //獲得當(dāng)前時(shí)間
? ? ? ? Date date = Calendar.getInstance().getTime();

? ? ? ? //創(chuàng)建時(shí)間
? ? ? ? this.fillStrategy(metaObject, "gmtCreate", date);
? ? ? ? //更新時(shí)間
? ? ? ? this.fillStrategy(metaObject, "gmtModified", date);
? ? ? ? //未刪除
? ? ? ? this.fillStrategy(metaObject, "isDeleted", CommonConstants.NON_DELETED);
? ? ? ? //創(chuàng)建者
? ? ? ? this.fillStrategy(metaObject, "creatorId", dscUser.getUserId());
? ? ? ? //更新者
? ? ? ? this.fillStrategy(metaObject, "modifierId", dscUser.getUserId());

? ? }
? ??
?? ?/**
?? ?*修改時(shí)自動(dòng)填充
?? ?*/
? ? @Override
? ? public void updateFill(MetaObject metaObject) {
? ? ? ? //獲得用戶上下文
? ? ? ? UserContext dscUser = GlobalSessionContext.getDscUser();
? ? ? ? //獲得當(dāng)前時(shí)間
? ? ? ? Date date = Calendar.getInstance().getTime();
? ? ? ? //強(qiáng)制更新時(shí)間
? ? ? ? this.setFieldValByName("gmtModified", date, metaObject);
? ? ? ? //更新者
? ? ? ? this.fillStrategy(metaObject, "modifierId",dscUser.getUserId());

? ? }
}

二、失效場(chǎng)景及解決方案

1、使用mybatis-plus的boolean update(Wrapper updateWrapper)鏈?zhǔn)礁路椒〞r(shí)失效

1）示例代碼

/**
*更新屬性
*/
?@Override
? ? public Boolean expireHistoryTask(Long tenantId, Long produceInfoId) {
? ? ? ? return this.update(new UpdateWrapper<TaskDetailInfoDO>().lambda()
? ? ? ? ? ? .eq(TaskDetailInfoDO::getTenantId, tenantId)
? ? ? ? ? ? .in(TaskDetailInfoDO::getProduceInfoId, produceInfoId)
? ? ? ? ? ? .eq(TaskDetailInfoDO::getIsDeleted, CommonConstants.NON_DELETED)
? ? ? ? ? ? .set(TaskDetailInfoDO::getTaskStatus, TaskStatusEnum.EXPIRED.getCode())
? ? ? ? ? ??
? ? }

2）失效原因

這種更新方法失效我們需要去看mbatis-plus的源碼

   private static void process(MappedStatement ms, Object parameterObject) {
        if (parameterObject != null) {
            TableInfo tableInfo = null;
            Object entity = parameterObject;
            if (parameterObject instanceof Map) {
                Map<?, ?> map = (Map<?, ?>) parameterObject;
                if (map.containsKey(Constants.ENTITY)) {
                    Object et = map.get(Constants.ENTITY);
                    if (et != null) {
                        entity = et;
                        tableInfo = TableInfoHelper.getTableInfo(entity.getClass());
                    }
                }
            } else {
                tableInfo = TableInfoHelper.getTableInfo(parameterObject.getClass());
            }
            //tableInfo為空，則不自動(dòng)填充
            if (tableInfo != null) {
                //到這里就應(yīng)該轉(zhuǎn)換到實(shí)體參數(shù)對(duì)象了,因?yàn)樘畛浜虸D處理都是爭(zhēng)對(duì)實(shí)體對(duì)象處理的,不用傳遞原參數(shù)對(duì)象下去.
                MetaObject metaObject = ms.getConfiguration().newMetaObject(entity);
                if (SqlCommandType.INSERT == ms.getSqlCommandType()) {
                    populateKeys(tableInfo, metaObject, entity);
                    insertFill(metaObject, tableInfo);
                } else {
                    updateFill(metaObject, tableInfo);
                }
            }
        }
    }

從上面的代碼可以看出，當(dāng)tableInfo為空，則不自動(dòng)填充字段值。而繼續(xù)看，tableInfo是從parameterObject中獲取，而這parameterObject就是要更新的實(shí)體對(duì)象。
在看我們使用 update(Wrapper updateWrapper)更新的底層邏輯

 /**
     * 根據(jù) UpdateWrapper 條件，更新記錄 需要設(shè)置sqlset
     *
     * @param updateWrapper 實(shí)體對(duì)象封裝操作類(lèi) {@link com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper}
     */
    default boolean update(Wrapper<T> updateWrapper) {
        //傳入了一個(gè)空實(shí)體
        return update(null, updateWrapper);
    }

此時(shí)是傳了一個(gè)空對(duì)象，這就導(dǎo)致了整個(gè)后續(xù)的填充都失效了。

3）解決方法

使用update的另一個(gè)方法

在更新是傳入實(shí)體對(duì)象

  @Override
    public Boolean expireHistoryTask(Long tenantId, Long produceInfoId) {
        return this.update(new TaskDetailInfoDO(), new UpdateWrapper<TaskDetailInfoDO>().lambda()
            .eq(TaskDetailInfoDO::getTenantId, tenantId)
            .in(TaskDetailInfoDO::getProduceInfoId, produceInfoId)
            .eq(TaskDetailInfoDO::getIsDeleted, CommonConstants.NON_DELETED)
            .set(TaskDetailInfoDO::getTaskStatus, TaskStatusEnum.EXPIRED.getCode())
        );
    }

2、填充時(shí)使用 MetaObjectHandler fillStrategy(MetaObject metaObject, String fieldName, Object fieldVal) 方法

 @Override
    public void updateFill(MetaObject metaObject) {
        //獲得用戶上下文
        UserContext dscUser = GlobalSessionContext.getDscUser();
        //更新者
        this.fillStrategy(metaObject, "modifierId", dscUser.getUserId());
    }

fillStartegy的源碼時(shí)這樣的

    /**
     * 填充策略,默認(rèn)有值不覆蓋,如果提供的值為null也不填充
     *
     * @param metaObject metaObject meta object parameter
     * @param fieldName  java bean property name
     * @param fieldVal   java bean property value of Supplier
     * @since 3.3.0
     */
    default MetaObjectHandler fillStrategy(MetaObject metaObject, String fieldName, Object fieldVal) {
        if (getFieldValByName(fieldName, metaObject) == null) {
            setFieldValByName(fieldName, fieldVal, metaObject);
        }
        return this;
    }

當(dāng)需要更新的字段已經(jīng)有值時(shí)，則默認(rèn)不更新。需要強(qiáng)制更新字段時(shí)，使用 MetaObjectHandler setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject) 方法更新字段值。

   @Override
    public void updateFill(MetaObject metaObject) {
        //獲得用戶上下文
        UserContext dscUser = GlobalSessionContext.getDscUser();
        //獲得當(dāng)前時(shí)間
        Date date = Calendar.getInstance().getTime();
        //更新時(shí)間
        this.setFieldValByName("gmtModified", date, metaObject);
        //更新者
        this.setFieldValByName("modifierId", metaObject, dscUser.getUserId());
    }

到此這篇關(guān)于解決mybatisplus MetaObjectHandler 失效的問(wèn)題的文章就介紹到這了,更多相關(guān)mybatisplus MetaObjectHandler 失效內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: