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

前言

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

mybatis-plus:mapper-locations: classpath*:mapper/*.xmlconfiguration:mapUnderscoreToCamelCase: trueglobal-config:db-config:logic-delete-field: dellogic-delete-value: 1logic-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@Overridepublic 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 将处理完的数据重新转为MPBoundSqlString 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 = 0plainSelect.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) {// inInExpression expression = (InExpression) where;Expression inExpression = expression.getRightExpression();if (inExpression instanceof SubSelect) {handleSelectBody(((SubSelect) inExpression).getSelectBody());}} else if (where instanceof ExistsExpression) {// existsExistsExpression expression = (ExistsExpression) where;handleWhereSubSelect(expression.getRightExpression());} else if (where instanceof NotExpression) {// not existsNotExpression 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 = 0FromItem rightItem = join.getRightItem();EqualsTo equalsTo = getEqualTo(rightItem);// INFO: DCT: 2023/11/12 获取on右边的表达式Expression onExpression = join.getOnExpression();// INFO: DCT: 2023/11/12 给表达式增加 and 表.del = 0AndExpression 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;@Beanpublic 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我也会及时修复。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/154280.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

品牌挑选控价服务商的标准参考

品牌挑选控价服务商的标准参考

控价是一项需要投入时间精力的工作&#xff0c;品牌可以自主团队去做&#xff0c;但如果涉及数据量太大的时候&#xff0c;还需要开发系统&#xff0c;这样显然会增加非常多的成本&#xff0c;系统开发费用和运维费用都是一笔不小的开支&#xff0c;所以现在很多的品牌会选择找…
阅读更多...
澳洲猫罐头到底怎么样呢？我自己亲自喂养过的优质猫罐头分享

澳洲猫罐头到底怎么样呢？我自己亲自喂养过的优质猫罐头分享

猫罐头要符合三点&#xff1a;营养配方完整均衡、原料新鲜优质、生产工艺科学可靠。只有具备这些特点&#xff0c;才是品质上乘的猫罐头。 这三个要点缺一不可&#xff0c;配方不够均衡营养&#xff0c;便无法给猫提供充足的营养、会导致营养不良&#xff1b;原料不够新鲜、优质…
阅读更多...
77基于matlab的蚁群优化路径算法，二维路径和三维路径优化

77基于matlab的蚁群优化路径算法，二维路径和三维路径优化

基于matlab的蚁群优化路径算法&#xff0c;二维路径和三维路径优化。输出可视化最优路径和距离迭代曲线。数据可更换自己的&#xff0c;程序已调通&#xff0c;可直接运行。 77三维和二维路径可视化 (xiaohongshu.com)
阅读更多...
Python二级 每周练习题27

Python二级 每周练习题27

如果你感觉有收获&#xff0c;欢迎给我微信扫打赏码 ———— 以激励我输出更多优质内容 练习一: 用户输入一个半径r&#xff0c;求该半径下的圆的面积s与周长c。要求如下&#xff1a; &#xff08;1&#xff09;输出的面积与周长都保留俩位小数&#xff1b; &#xff08;2&a…
阅读更多...
Active Directory 和域名系统（DNS）的相互关系

Active Directory 和域名系统（DNS）的相互关系

什么是域名系统&#xff08;DNS&#xff09; 域名系统&#xff08;DNS&#xff09;&#xff0c;从一般意义上讲是一种将主机名或域名解析为相应IP地址的手段。 在 AD 的中&#xff0c;DNS 服务维护 DNS 域和子域的工作命名空间&#xff0c;这些域和子域主要有助于查找过程&am…
阅读更多...
人工智能基础_机器学习045_逻辑回归的梯度下降公式推导_更新公式---人工智能工作笔记0085

人工智能基础_机器学习045_逻辑回归的梯度下降公式推导_更新公式---人工智能工作笔记0085

然后我们上面有了逻辑回归的损失函数,以后,我们再来看 逻辑回归的梯度下降公式 可以看到上面是逻辑回归的梯度下降公式,这里的阿尔法是学习率,这里的 后面的部分是梯度也就是步长,这个阿尔法是,通过调节这个来控制梯度下降的快和慢对吧 然后我们再来看逻辑回归 可以看到这里…
阅读更多...
第十六章总结

第十六章总结

反射JAVA反射机制是在运行状态中&#xff0c;对于任意一个类&#xff0c;都能够知道这个类的所有属性和方法&#xff1b;对于任意一个对象&#xff0c;都能够调用它的任意一个方法和属性&#xff1b;这种动态获取的信息以及动态调用对象的方法的功能称为java语言的反射机制。 通…
阅读更多...
windows11系统如何设置锁屏壁纸

windows11系统如何设置锁屏壁纸

1. 在开始页面里面找到设置 2. 在设置里面找到个性化 3. 按照红色圈出部分操作 个性化锁屏界面 选择 图片 浏览照片 选择一张你觉得好看的图片作为锁屏壁纸 注&#xff1a;如果需要在锁屏后的登录页面显示壁纸 请勾选第三个红圈部分
阅读更多...
使用vant list实现订单列表，支持下拉加载更多

使用vant list实现订单列表，支持下拉加载更多

在公司项目开发时&#xff0c;有一个需求是实现可以分页的订单列表&#xff0c;由于是移动端项目&#xff0c;所以最好的解决方法是做下拉加载更多。 1.在页面中使用vant组件 <van-listv-model"loading":finished"finished"finished-text"没有更…
阅读更多...
盘点35个Python书籍Python爱好者不容错过

盘点35个Python书籍Python爱好者不容错过

盘点35个Python书籍Python爱好者不容错过 学习知识费力气&#xff0c;收集整理更不易。 知识付费甚欢喜&#xff0c;为咱码农谋福利。 链接&#xff1a;https://pan.baidu.com/s/1uf-MXZc9aC7y3Qju6VnCYw?pwd8888 提取码&#xff1a;8888 书籍名称&#xff1a; Django教…
阅读更多...
若依前后端分离版，快速上手

若依前后端分离版，快速上手

哈喽~大家好&#xff0c;这篇来看看若依前后端分离版&#xff0c;快速上手&#xff08;肝了挺久的&#xff09;。 &#x1f947;个人主页&#xff1a;个人主页​​​​​ &#x1f948; 系列专栏&#xff1a;【Springboot和Vue全栈开发】…
阅读更多...
在ITSM中，实施变更管理的重要因素！

在ITSM中，实施变更管理的重要因素！

在ITSM管理中&#xff0c;变更管理是不可或缺的一步。在当今快速变革的商业环境中&#xff0c;组织需要不断地进行变更以适应市场的需求和竞争的压力。 然而&#xff0c;引入变更并成功地实施变更并不容易。变更管理是一种系统化和结构化的方法&#xff0c;旨在确保变更顺利进…
阅读更多...
六要素超声波微气象仪一款气象监测设备

六要素超声波微气象仪一款气象监测设备

WX-WQX6 随着科技的发展&#xff0c;人们对天气的预测和掌控能力越来越强。在这个领域&#xff0c;六要素超声波微气象仪以其精准、实时的气象监测能力&#xff0c;赢得了众多关注。这款仪器不仅可以实时监测温度、湿度、风速、风向、气压和雨量六个气象要素&#xff0c;还可以…
阅读更多...
逐字节讲解 Redis 持久化（RDB 和 AOF）的文件格式（一）

逐字节讲解 Redis 持久化（RDB 和 AOF）的文件格式（一）

前言 相信各位对 Redis 的这两种持久化机制都不陌生&#xff0c;简单来说&#xff0c;RDB 就是对数据的全量备份&#xff0c;AOF 则是增量备份&#xff0c;而从 4.0 版本开始引入了混合方式&#xff0c;以 7.2.3 版本为例&#xff0c;会生成三类文件&#xff1a;RDB、AOF 和记…
阅读更多...
算法——双指针

算法——双指针

一、背景知识 双指针&#xff08;Two Pointers&#xff09;&#xff1a;指的是在遍历元素的过程中&#xff0c;不是使用单个指针进行访问&#xff0c;而是使用两个指针进行访问&#xff0c;从而达到相应的目的。对撞时针&#xff1a; 两个指针方向相反对撞指针一般用来解决有序…
阅读更多...
SecureCRT -- 使用说明

SecureCRT -- 使用说明

【概念解释】什么是SSH&#xff1f; SSH的英文全称是Secure Shell 传统的网络服务程序&#xff0c;如&#xff1a;ftp和telnet在本质上都是不安全的&#xff0c;因为它们在网络上用明文传送口令和数据&#xff0c;别有用心的人非常容易就可以截获这些口令和数据。而通过使用SS…
阅读更多...
《Deep learning for fine-grained image analysis: A survey》阅读笔记

《Deep learning for fine-grained image analysis: A survey》阅读笔记

论文标题 《Deep learning for fine-grained image analysis: A survey》 作者 魏秀参&#xff0c;旷世研究院 初读 摘要 细粒度图像分析&#xff08;FGIA&#xff09;的任务是分析从属类别的视觉对象。 细粒度性质引起的类间小变化和类内大变化使其成为一个具有挑战性的…
阅读更多...
筒仓料位监测|敢不敢对“精度”下狠手！您家筒仓料位测得准吗？

筒仓料位监测|敢不敢对“精度”下狠手！您家筒仓料位测得准吗？

您家是不是还在人工敲仓估算&#xff1f; 您能精确知道料位和库存吗&#xff1f; 您能实时看到库存盈亏吗&#xff1f; 筒仓里装了什么&#xff1f;用了多少&#xff1f; 什么时候进料最划算&#xff1f; 您家的筒仓管理方式可靠吗&#xff1f; 上海思伟筒仓料位监测方案 看…
阅读更多...
UE5制作场景时的小技巧和注意事项

UE5制作场景时的小技巧和注意事项

UE5制作场景时的小技巧和注意事项 一、场景相关 1.1灯光 1.1.1构建完光照，发现场景都是黑的 可能是所有灯光是静态灯光，把skylight改为动态，如果改完之后还是黑色的，那就在构建一次，就应该没问题了 1.1.2场景中有多个动态光会造成阴影闪烁 需要将skylight变为固定 1…
阅读更多...
并行与分布式 第7章 体系结构 上

并行与分布式 第7章 体系结构 上

文章目录 并行与分布式 第7章 体系结构 上7.1 多处理器结构7.1.1 多处理器存储结构分类7.1.2 非共享存储多处理器7.1.3 共享存储多处理器7.1.4 多核结构 7.2 Cache一致性问题7.2.1数据共享引发的问题7.2.2 Cache一致性协议7.2.3 监听协议的实现7.2.4目录式协议 并行与分布式 第…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023