【原创】为MybatisPlus增加一个逻辑删除插件,让XML中的SQL也能自动增加逻辑删除功能

18 篇文章 0 订阅
8 篇文章 0 订阅

前言

看到这个标题有人就要说了,D哥啊,MybatisPlus不是本来就有逻辑删除的配置吗,比如@TableLogic注解,配置文件里也能添加如下配置设置逻辑删除。

mybatis-plus:
  mapper-locations: classpath*:mapper/*.xml
  configuration:
    mapUnderscoreToCamelCase: true
  global-config:
    db-config:
      logic-delete-field: del
      logic-delete-value: 1
      logic-notDelete-value: 0

但是我想说,xml中添加了逻辑删除了吗?很明显这个没有,MybatisPlus只在QueryWrapper中做了手脚,而xml是Mybatis的功能,非MybatisPlus的功能。而xml中写SQL又是我工作中最常用到的,优势在于SQL可读性强,结合MybatisX插件并在IDEA中连接database后能够直接跳转到方法和表,且对多表join和子查询支持都比QueryWrapper来得好。而逻辑删除又是会经常漏掉的字段,虽然说手动添加也不费多少时间,但是麻烦的是容易漏掉,特别是子查询和join的情况,而且时间积少成多,我觉得有必要解决这个问题。

本插件适用于绝大部分表都拥有逻辑删除字段的情况!!

本文使用的MybatisPlus的版本为3.5.3.1

不多说了,直接上代码!


/**
 * @author DCT
 * @version 1.0
 * @date 2023/11/9 23:10:18
 * @description
 */
@Slf4j
public class DeleteMpInterceptor implements InnerInterceptor {
    public static final String LOGIC_DELETE = "LOGIC_DELETE";
    public static final List<String> excludeFunctions = new ArrayList<>();
    protected String deleteFieldName;

    public DeleteMpInterceptor(String deleteFieldName) {
        this.deleteFieldName = deleteFieldName;
    }

    static {
        excludeFunctions.add("selectList");
        excludeFunctions.add("selectById");
        excludeFunctions.add("selectBatchIds");
        excludeFunctions.add("selectByMap");
        excludeFunctions.add("selectOne");
        excludeFunctions.add("selectCount");
        excludeFunctions.add("selectObjs");
        excludeFunctions.add("selectPage");
        excludeFunctions.add("selectMapsPage");
    }

    @SneakyThrows
    @Override
    public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
        if (InterceptorIgnoreHelper.willIgnoreOthersByKey(ms.getId(), LOGIC_DELETE)) {
            return;
        }

        if (StringUtils.isBlank(deleteFieldName)) {
            // INFO: Zhouwx: 2023/11/20 没有设置逻辑删除的字段名,也忽略添加逻辑删除
            return;
        }

        PluginUtils.MPBoundSql mpBs = PluginUtils.mpBoundSql(boundSql);
        String sql = mpBs.sql();
        Statement statement = CCJSqlParserUtil.parse(sql);

        if (!(statement instanceof Select)) {
            return;
        }

        String id = ms.getId();
        int lastIndexOf = id.lastIndexOf(".");
        String functionName = id.substring(lastIndexOf + 1);
        if (excludeFunctions.contains(functionName)) {
            // INFO: DCT: 2023/11/12 QueryWrapper的查询,本来就会加逻辑删除,不需要再加了
            return;
        }

        Select select = (Select) statement;
        SelectBody selectBody = select.getSelectBody();

        // INFO: DCT: 2023/11/12 处理核心业务
        handleSelectBody(selectBody);

        // INFO: DCT: 2023/11/12 将处理完的数据重新转为MPBoundSql
        String sqlChange = statement.toString();
        mpBs.sql(sqlChange);
    }

    protected void handleSelectBody(SelectBody selectBody) {
        if (selectBody instanceof PlainSelect) {
            PlainSelect plainSelect = (PlainSelect) selectBody;

            // INFO: DCT: 2023/11/12 处理join中的内容
            handleJoins(plainSelect);

            Expression where = plainSelect.getWhere();

            FromItem fromItem = plainSelect.getFromItem();
            EqualsTo equalsTo = getEqualTo(fromItem);

            if (where == null) {
                // INFO: DCT: 2023/11/12 where条件为空,增加一个where,且赋值为 表名.del = 0
                plainSelect.setWhere(equalsTo);
            } else {
                // INFO: DCT: 2023/11/12 普通where,后面直接加上本表的 表名.del = 0 
                AndExpression andExpression = new AndExpression(where, equalsTo);
                plainSelect.setWhere(andExpression);

                // INFO: DCT: 2023/11/12 有子查询的处理子查询 
                handleWhereSubSelect(where);
            }
        }
    }

    /**
     * 这一段来自MybatisPlus的租户插件源码,通过递归的方式加上需要的SQL
     *
     * @param where
     */
    protected void handleWhereSubSelect(Expression where) {
        if (where == null) {
            return;
        }
        if (where instanceof FromItem) {
            processOtherFromItem((FromItem) where);
            return;
        }
        if (where.toString().indexOf("SELECT") > 0) {
            // 有子查询
            if (where instanceof BinaryExpression) {
                // 比较符号 , and , or , 等等
                BinaryExpression expression = (BinaryExpression) where;
                handleWhereSubSelect(expression.getLeftExpression());
                handleWhereSubSelect(expression.getRightExpression());
            } else if (where instanceof InExpression) {
                // in
                InExpression expression = (InExpression) where;
                Expression inExpression = expression.getRightExpression();
                if (inExpression instanceof SubSelect) {
                    handleSelectBody(((SubSelect) inExpression).getSelectBody());
                }
            } else if (where instanceof ExistsExpression) {
                // exists
                ExistsExpression expression = (ExistsExpression) where;
                handleWhereSubSelect(expression.getRightExpression());
            } else if (where instanceof NotExpression) {
                // not exists
                NotExpression expression = (NotExpression) where;
                handleWhereSubSelect(expression.getExpression());
            } else if (where instanceof Parenthesis) {
                Parenthesis expression = (Parenthesis) where;
                handleWhereSubSelect(expression.getExpression());
            }
        }
    }

    /**
     * 处理子查询等
     */
    protected void processOtherFromItem(FromItem fromItem) {
        // 去除括号
        while (fromItem instanceof ParenthesisFromItem) {
            fromItem = ((ParenthesisFromItem) fromItem).getFromItem();
        }

        if (fromItem instanceof SubSelect) {
            SubSelect subSelect = (SubSelect) fromItem;
            if (subSelect.getSelectBody() != null) {
                // INFO: Zhouwx: 2023/11/20 递归从select开始查找
                handleSelectBody(subSelect.getSelectBody());
            }
        } else if (fromItem instanceof ValuesList) {
            log.debug("Perform a subQuery, if you do not give us feedback");
        } else if (fromItem instanceof LateralSubSelect) {
            LateralSubSelect lateralSubSelect = (LateralSubSelect) fromItem;
            if (lateralSubSelect.getSubSelect() != null) {
                SubSelect subSelect = lateralSubSelect.getSubSelect();
                if (subSelect.getSelectBody() != null) {
                    // INFO: Zhouwx: 2023/11/20 递归从select开始查找
                    handleSelectBody(subSelect.getSelectBody());
                }
            }
        }
    }

    protected void handleJoins(PlainSelect plainSelect) {
        List<Join> joins = plainSelect.getJoins();
        if (joins == null) {
            return;
        }

        for (Join join : joins) {
            // INFO: DCT: 2023/11/12 获取表别名,并获取 表.del = 0
            FromItem rightItem = join.getRightItem();
            EqualsTo equalsTo = getEqualTo(rightItem);

            // INFO: DCT: 2023/11/12 获取on右边的表达式
            Expression onExpression = join.getOnExpression();
            // INFO: DCT: 2023/11/12 给表达式增加 and 表.del = 0
            AndExpression andExpression = new AndExpression(onExpression, equalsTo);

            ArrayList<Expression> expressions = new ArrayList<>();
            expressions.add(andExpression);
            // INFO: DCT: 2023/11/12 目前的这个表达式就是and后的表达式了,不用再增加原来的表达式,因为这个and表达式已经包含了原表达式所有的内容了
            join.setOnExpressions(expressions);
        }
    }

    protected EqualsTo getEqualTo(FromItem fromItem) {
        Alias alias = fromItem.getAlias();

        String aliasName = "";
        if (alias == null) {
            if (fromItem instanceof Table) {
                Table table = (Table) fromItem;
                aliasName = table.getName();
            }
        } else {
            aliasName = alias.getName();
        }

        EqualsTo equalsTo = new EqualsTo();
        Column leftColumn = new Column();
        leftColumn.setColumnName(aliasName + "." + deleteFieldName);
        equalsTo.setLeftExpression(leftColumn);
        equalsTo.setRightExpression(new LongValue(0));

        return equalsTo;
    }
}

代码说明

这代码中已经有很多注释了,其实整段代码并非100%我的原创,而是借鉴了MybatisPlus自己的TenantLineInnerIntercept,因为两者的功能实际上非常详尽,我依葫芦画瓢造了一个,特别是中间的handleWhereSubSelect方法,令人拍案叫绝!使用大量递归,通过非常精简的代码处理完了SQL查询中所有的子查询。

getEqualTo方法可以算是逻辑删除插件的核心代码了,先判断表是否存在别名,如果有,就拿别名,如果没有就拿表名,防止出现多个表都有逻辑删除字段的情况下指代不清的情况,出现查询ambiguous错误。通过net.sf.jsqlparser中的EqualsTo表达式,拼上字段名和未被逻辑删除的值0(这里可以按照自己的情况进行修改!)

顶上的excludeFunctions是为了排除QueryWrapper的影响,因为QueryWrapper自己会加上逻辑删除,而这个插件还会再添加一个逻辑删除,导致出现重复,打印出来的SQL不美观。

使用方法

和MybatisPlus其他的插件一样,都通过@Bean的方式进行配置

    @Value("${mybatis-plus.global-config.db-config.logic-delete-field}")
    private String deleteFieldName;


    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new DeleteMpInterceptor(deleteFieldName));
        return interceptor;
    }

我这里的deleteFieldName直接借用了MybatisPlus自己的逻辑删除配置,可以自己设置

排除使用这个插件

如果有几张表是没有逻辑删除字段的,那么这个插件自动补的逻辑删除字段则会导致SQL出现报错,可以通过添加以下注解@InterceptorIgnore排除插件对于该方法的生效

@Repository
interface ExampleMapper : BaseMapper<ExampleEntity> {
    @InterceptorIgnore(others = [DeleteMpInterceptor.LOGIC_DELETE + "@true"])
    fun findByList(query: ExampleQo): List<ExampleListVo>
}

上面的代码是Kotlin写的,但是不妨碍查看

运行效果

mapper中代码为:

/**
 * @author DCTANT
 * @version 1.0
 * @date 2023/11/20 17:40:41
 * @description
 */
@Repository
interface ExampleMapper : BaseMapper<ExampleEntity> {
    fun findByList(query: ExampleQo): List<ExampleListVo>
}

xml中的代码为:

    <select id="findByList" resultType="com.itdct.server.admin.example.vo.ExampleListVo">
        select t.* from test_example as t
        <where>
            <if test="name != null and name != ''">and t.name = #{name}</if>
            <if test="number != null">and t.number = #{number}</if>
            <if test="keyword != null and keyword != ''">and t.name like concat('%',#{keyword},'%')</if>
            <if test="startTime != null">and t.create_time &gt; #{startTime}</if>
            <if test="endTime != null">and t.create_time &lt; #{endTime}</if>
        </where>
        order by t.create_time desc
    </select>

执行效果为:

t.del = 0就是逻辑删除插件添加的代码,当然join和子查询我也使用了,目前来看没有什么问题

欢迎大家提出修改意见

目前这个代码还处于Demo阶段,并没有上线使用,还是处于没充分测试的状态,欢迎大家提出整改意见!如果有bug我也会及时修复。

  • 3
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
### 回答1: MyBatis-Plus(简称MP)是一个 MyBatis 的增强工具包,它在 MyBatis 的基础上,提供了许多实用的功能MyBatis-Plus 的历史可以追溯到 2016 年,当时它是由一个名叫 baomidou 的开源团队开发并维护的。 MyBatis-Plus 最初的目标是简化 MyBatis开发,提升开发效率,减少重复性的代码编写。随着时间的推移,MyBatis-Plus 不断地迭代和升级,提供了越来越多的实用功能,如代码生成器、分页插件、性能分析插件等,成为了广受欢迎的 MyBatis 增强工具包之一。 目前,MyBatis-Plus 已经发布了多个版本,支持了更多的功能和特性。同时,它还提供了详细的文档和示例,方便开发者使用和学习。 ### 回答2: MyBatis Plus 是一个基于 MyBatis功能增强工具,它提供了一些实用的功能,使得在使用 MyBatis 进行持久化操作时更简便和高效。除了提供 MyBatis 的核心功能外,MyBatis Plus 还进一步扩展了 CRUD 操作、分页查询、逻辑删除、乐观锁、自动填充、多租户等功能。下面我将介绍一下 MyBatis Plus 的历史。 MyBatis Plus 的前身是 MyBatis-Plus(或称为 Mybatis-Ext),它在 MyBatis 基础上进行了二次开发。起初,MyBatis-Plus 的目标是提供一套可以代替 MyBatis 核心功能的可选替代方案,以弥补 MyBatis 在某些方面的不足。然而,随着开发的不断迭代和完善,MyBatis-Plus 逐渐成长为一个功能全面的工具集。 MyBatis-Plus 项目于2014年在开源社区 GitHub 上发布,获得了广大开源爱好者的积极参与。通过用户提供的宝贵意见和不断的改进,MyBatis-Plus 成为了目前国内外广泛使用的一款 MyBatis 增强工具。它受到了国内众多知名企业的支持和青睐,得到了广泛的推广和应用。 在历史的发展过程MyBatis Plus 不断引入新的功能和优化,提高了开发效率和系统性能。目前,MyBatis Plus 的最新版本已经支持多种数据库厂商,并且具备强大的代码生成器,可以自动生成实体类、Mapper 接口以及 XML 映射文件,大大减少了重复劳动。此外,MyBatis Plus 还提供了丰富的插件扩展机制,使得开发人员可以根据自己的需求进行功能定制和功能扩展。 总而言之,MyBatis Plus 是一个功能强大的 MyBatis 增强工具,它在 MyBatis 的基础上进行了二次开发,提供了很多实用的功能和优化,大大简化了开发工作。经过多年的发展和改进,MyBatis Plus 在国内外得到了广泛的应用和认可,成为了众多开发者的首选工具之一。 ### 回答3: Mybatis-plus是一个开源的Java持久化框架,它是在Mybatis基础上进行功能扩展的。 Mybatis最初由Apache Software Foundation的一个开源项目发起,其目标是提供一个简单、易于使用的数据持久化框架。Mybatis的主要特点是以SQL语句为心的数据映射模型,通过XML配置文件或注解来定义数据库操作。 然而,随着项目的发展,一些常用的功能并没有在Mybatis提供,开发者不得不通过自己的手动编码实现这些功能,这带来了一定的开发负担和重复劳动。为了解决这个问题,Mybatis-plus应运而生。 Mybatis-plus是一个依赖于Mybatis增强的框架,它通过对Mybatis进行扩展,提供了很多实用的功能和特性,大大简化了开发者的操作。它提供了自动生成代码、分页查询、逻辑删除、乐观锁控制等常用功能。此外,Mybatis-plus还提供了强大的查询构造器、数据验证器等功能,提高了开发效率和代码质量。 Mybatis-plus的发展历程可以追溯到2013年,当时是由一位开源爱好者做开发和维护。随着社区的逐渐发展壮大,越来越多的开发者开始关注和使用Mybatis-plus,并为其贡献代码和提出建议。通过不断地更新和迭代版本,Mybatis-plus在功能和性能上不断地得到优化和改进。 目前,Mybatis-plus已经成为Java后端开发非常受欢迎的持久化框架之一,广泛应用于企业级项目和个人开发。它提供了许多优秀的功能和特性,可以大大简化和开发过程,同时也提高了代码质量和可读性。通过与其他优秀框架的集成,如Spring Boot等,Mybatis-plus可以更好地满足各种应用场景的需求。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 6
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值