mybatis-plus 逻辑删除无法做自动填充的问题

BUG指挥官

已于 2022-02-16 17:06:06 修改

阅读量2.9k

点赞数 2

文章标签： java 后端 mybatis

于 2022-02-16 17:04:39 首次发布

本文链接：https://blog.csdn.net/WXF_Sir/article/details/122967409

版权

背景：
mybatis-plus在做数据新增、更新的时候，设置了自动填充，用于自动更新对象中的createTime、

creatorId、editeTime、editorId这个四个字段。

（如何设置自动填充见mybatis-plus官方文档：自动填充功能 | MyBatis-Plus）

@Data
@Accessors(chain = true)
public class BaseDomain extends IdBaseDomain implements Serializable {
 
    private static final long serialVersionUID = -4191346935187360593L;
 
    /**
     * 创建时间
     */
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    protected LocalDateTime createTime;
 
    /**
     * 更新时间
     */
    @TableField(value = "edit_time", fill = FieldFill.INSERT_UPDATE)
    protected LocalDateTime editTime;
 
    /**
     * 创建人
     */
    @TableField(value = "creator_id",fill = FieldFill.INSERT)
    protected Long creatorId;
 
    /**
     * 更新人
     */
    @TableField(value = "editor_id", fill = FieldFill.INSERT_UPDATE)
    protected Long editorId;
 
}
 
 
@Data
@Accessors(chain = true)
public class IdBaseDomain implements Serializable {
 
    private static final long serialVersionUID = -3793660974772423732L;
 
    /**
     * id
     */
    //@TableField("id")
    @TableId(value = "id", type = IdType.ASSIGN_ID)
    protected Long id;
 
    /**
     * 删除（1-是，0-否）
     */
    @TableLogic
    @TableField("is_delete")
    protected Integer isDelete;
 
}

问题追踪：
在isDelete字段上设置了逻辑删除@TableLogic，逻辑删除的本质是跟新标识字段isDelete，理论上是一个update语句，那么应该记录editTime和editorId才对，这样可以记录下删除人信息。但实际上发现editTime和editorId并未自动跟新，做debug后发现自动填充的代码根本没有执行。

逻辑删除 | MyBatis-Plus

核心逻辑：

1.逻辑删除只对自动注入的sql起效，意味着逻辑删除对于你代码拼接的sql是不生效的，只有调用mybatis-plus自己初始化的时候注入的sql有效。

2.删除接口的自动填充功能是无效的，要么你自己写wrapper拼接update语句做删除，要么使用sql注入器将LogicDeleteByIdWithFill注入。Sql 注入器 | MyBatis-Plus

解决方案：

在默认实现的基础上将额外的sql注入进去，所以直接继承默认的实现类做改进。以下为源码：

/**
 * 重写DefaultSqlInjector
 */
public class SqlInjectorPlus extends DefaultSqlInjector {
 
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        //继承原有方法
        List<AbstractMethod> methodList = super.getMethodList(mapperClass);
        //注入新方法
        methodList.add(new LogicDeleteByIdWithFill());
        return methodList;
    }
 
}
 
/**
 * 注入
 */
@Configuration
@EnableTransactionManagement
public class MybatisPlusConfig {
 
    /**
     * 增强sql注入的Bean
     *
     * @return
     */
    @Bean
    public SqlInjectorPlus sqlInjectorPlus() {
        return new SqlInjectorPlus();
    }
}
 
 
/**
 * 重写BaseMapper
 */
public interface BaseMapperPlus <T> extends BaseMapper<T> {
 
    /**
     * 逻辑删除
     * @param param
     * @return
     */
    int deleteByIdWithFill(@Param(Constants.ENTITY)T param);
 
}

注意：LogicDeleteByIdWithFill类是mybatis-plus源码中就有的实现类，但并未直接放开来使用。

问题源码分析：
虽然官方文档给出了解决方案，但并没有打消我的疑问，逻辑删除调用的是mybatis-plus自带的方法做删除，是在BaseMapper中的deleteById方法，按理说这个方法也是一条自动注入的sql对，为什么自动填充会失效呢？

首先我们看到作者源码中LogicDeleteByIdWithFill实现类中的注释有写到：“注意入参是 entity !!! ,如果字段没有自动填充,就只是单纯的逻辑删除”，为什么入参一定是entity才能自动填充？

以下两点是根据源码做出的分析：

1.在LogicDeleteByIdWithFill类中是根据TableInfo的入参来获取表信息的，TableInfo中的字段列表存储在 fieldList 这个字段中，可以从LogicDeleteByIdWithFill类中看到通过fieldList列表for循环拼接出sql。如果你对源码中fieldList来源进行分析，会发现该字段最终是根据mapper中传入的实例反射获取到的字段列表，由于mapper中是使用泛型传递参数，如果不传递实例则无法获取到字段列表。所以LogicDeleteByIdWithFill中才会要求方法入参必须是实例。

/**
 * 根据 id 逻辑删除数据,并带字段填充功能
 * <p>注意入参是 entity !!! ,如果字段没有自动填充,就只是单纯的逻辑删除</p>
 * <p>
 * 自己的通用 mapper 如下使用:
 * <pre>
 * int deleteByIdWithFill(T entity);
 * </pre>
 * </p>
 *
 * @author miemie
 * @since 2018-11-09
 */
public class LogicDeleteByIdWithFill extends AbstractMethod {
 
    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        String sql;
        SqlMethod sqlMethod = SqlMethod.LOGIC_DELETE_BY_ID;
        if (tableInfo.isWithLogicDelete()) {
            List<TableFieldInfo> fieldInfos = tableInfo.getFieldList().stream()
                .filter(TableFieldInfo::isWithUpdateFill)
                .collect(toList());
            if (CollectionUtils.isNotEmpty(fieldInfos)) {
                String sqlSet = "SET " + fieldInfos.stream().map(i -> i.getSqlSet(EMPTY)).collect(joining(EMPTY))
                    + tableInfo.getLogicDeleteSql(false, false);
                sql = String.format(sqlMethod.getSql(), tableInfo.getTableName(), sqlSet, tableInfo.getKeyColumn(),
                    tableInfo.getKeyProperty(), tableInfo.getLogicDeleteSql(true, true));
            } else {
                sql = String.format(sqlMethod.getSql(), tableInfo.getTableName(), sqlLogicSet(tableInfo),
                    tableInfo.getKeyColumn(), tableInfo.getKeyProperty(),
                    tableInfo.getLogicDeleteSql(true, true));
            }
        } else {
            sqlMethod = SqlMethod.DELETE_BY_ID;
            sql = String.format(sqlMethod.getSql(), tableInfo.getTableName(), tableInfo.getKeyColumn(),
                tableInfo.getKeyProperty());
        }
        SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
        return addUpdateMappedStatement(mapperClass, modelClass, getMethod(sqlMethod), sqlSource);
    }
 
    @Override
    public String getMethod(SqlMethod sqlMethod) {
        // 自定义 mapper 方法名
        return "deleteByIdWithFill";
    }
}

2.自动填充的方法是调用的MetaObjectHandler接口中updateFill方法，而这个方法具体是在MybatisParameterHandler中的process里面调用，可以在源码中清楚的看到，先通过TableInfoHelper根据入参来获取了tableInfo的信息，在tableInfo不是空的情况下，再向实体entity中写入自动填充的数据。

public class MybatisParameterHandler implements ParameterHandler {
 
    ......
 
    private void process(Object parameter) {
        if (parameter != null) {
            TableInfo tableInfo = null;
            Object entity = parameter;
            if (parameter instanceof Map) {
                Map<?, ?> map = (Map<?, ?>) parameter;
                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(parameter.getClass());
            }
            if (tableInfo != null) {
                //到这里就应该转换到实体参数对象了,因为填充和ID处理都是争对实体对象处理的,不用传递原参数对象下去.
                MetaObject metaObject = this.configuration.newMetaObject(entity);
                if (SqlCommandType.INSERT == this.sqlCommandType) {
                    populateKeys(tableInfo, metaObject, entity);
                    insertFill(metaObject, tableInfo);
                } else {
                    updateFill(metaObject, tableInfo);
                }
            }
        }
    }
 
    ......
 
}

以上两个点就大概能明白原因了，简单梳理一下：

mybatis-plus实例化的时候根据AbstractMethod的实现类先自动注入了sql模板（原生mybatis的xml中的sql语句），然后调用注入好的方法实际就是根据入参转化成tableInfo后再执行自动填充，然后填入sql模板产出sql语句，最后执行。我们的BaseMapper是使用的泛型传递参数，只能通过传递实体进去才能够让tableInfo中正常获取到字段列表fieldList。自动填充是直接填充的实体。

然后我们回过头看看mybatis-plus的默认删除实现DeleteById和Delete两个类中的代码：DeleteById入参是直接传递的id，没有实体传入，拼接sql也是直接通过id做删除，所以无法做出自动填充；Delete则是直接传递的wrapper拼接sql，wrapper是直接根据设置的条件进行拼接的，也没有实体传入，无法做出自动填充。

参考文档：【mybatis-plus】mybatis-plus 删除并自动填充_宠小仙女专用的博客-CSDN博客_mybatis-plus删除

BUG指挥官

关注

2
点赞
踩
5

收藏

觉得还不错? 一键收藏
0
评论
mybatis-plus 逻辑删除无法做自动填充的问题

背景：mybatis-plus在做数据新增、更新的时候，设置了自动填充，用于自动更新对象中的createTime、creatorId、editeTime、editorId这个四个字段。（如何设置自动填充见mybatis-plus官方文档：自动填充功能 | MyBatis-Plus）@Data@Accessors(chain = true)public class BaseDomain extends IdBaseDomain implements Serializable { .
复制链接

扫一扫