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

 更新时间:2026年01月26日 09:15:12   作者:没钱的程序员  
本文主要介绍了MyBatis-Plus中逻辑删除时自动填充字段的问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

背景:

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官网文档,发现在逻辑删除的页面有以下两段描述:

逻辑删除 | 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 逻辑删除无法做自动填充内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • IDEA报错:java 找不到符号图文解决过程

    IDEA报错:java 找不到符号图文解决过程

    这篇文章主要给大家介绍了关于IDEA报错:java 找不到符号解决的相关资料,运行项目时Idea报错,提示找不到符号,但是这个类在项目里是存在的,网上找了很多文章都没解决,浪费了一个下午终于弄好了,记录一下,需要的朋友可以参考下
    2023-08-08
  • mybatis升级mybatis-plus时踩到的一些坑

    mybatis升级mybatis-plus时踩到的一些坑

    这篇文章主要给大家介绍了关于mybatis升级mybatis-plus时踩到的一些坑,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • 基于Security实现OIDC单点登录的详细流程

    基于Security实现OIDC单点登录的详细流程

    本文主要是给大家介绍 OIDC 的核心概念以及如何通过对 Spring Security 的授权码模式进行扩展来实现 OIDC 的单点登录。对Security实现OIDC单点登录的详细过程感兴趣的朋友,一起看看吧
    2021-09-09
  • 实例解析使用Java实现基本的音频播放器的编写要点

    实例解析使用Java实现基本的音频播放器的编写要点

    这篇文章主要介绍了使用Java实现基本的音频播放器的代码要点实例分享,包括音频文件的循环播放等功能实现的关键点,需要的朋友可以参考下
    2016-01-01
  • springboot使用redis实现从配置到实战

    springboot使用redis实现从配置到实战

    本文主要介绍了springboot使用redis ,采用的是RedisTemplate的形式,还有一种采用spring支持的注解进行访问缓存,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-08-08
  • Java中的三种代理模式详解

    Java中的三种代理模式详解

    这篇文章主要介绍了Java中的三种代理模式详解,代理模式的关键点是:代理对象与目标对象.代理对象是对目标对象的扩展,并会调用目标对象,文中提供了部分代码,需要的朋友可以参考下
    2023-08-08
  • 使用Shell脚本实现SpringBoot项目自动化部署到Docker的操作指南

    使用Shell脚本实现SpringBoot项目自动化部署到Docker的操作指南

    在日常项目开发中,我们经常会将SpringBoot项目打包并部署到服务器上的Docker环境中,为了提升效率、减少重复操作,我们可以通过Shell脚本实现自动化部署,所以本文给大家介绍了使用Shell脚本实现SpringBoot项目自动化部署到Docker的操作指南,需要的朋友可以参考下
    2025-05-05
  • 基于Java实现QQ登录注册功能的示例代码

    基于Java实现QQ登录注册功能的示例代码

    这篇文章主要和大家分享如何利用Java语言实现QQ登录、注册等功能。本文主要应用的技术有:GUI、JDBC、多线程等,需要的可以参考一下
    2022-05-05
  • java实现单链表、双向链表

    java实现单链表、双向链表

    这篇文章主要为大家详细介绍了java实现单链表、双向链表的相关资料,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-03-03
  • Java中高效获取IP地域信息方案全解析

    Java中高效获取IP地域信息方案全解析

    在当今互联网应用中,IP地域信息分析已成为许多业务场景的核心需求,本文将全面解析Java中获取IP地域信息的各种方案,大家可以根据需要进行选择
    2025-08-08

最新评论