【原创】为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.rhkb.cn/news/201551.html

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

相关文章

【Linux】-进程间通信-共享内存（SystemV），详解接口函数以及原理（使用管道处理同步互斥机制）

【Linux】-进程间通信-共享内存（SystemV），详解接口函数以及原理（使用管道处理同步互斥机制）

&#x1f496;作者&#xff1a;小树苗渴望变成参天大树&#x1f388; &#x1f389;作者宣言&#xff1a;认真写好每一篇博客&#x1f4a4; &#x1f38a;作者gitee:gitee✨ &#x1f49e;作者专栏&#xff1a;C语言,数据结构初阶,Linux,C 动态规划算法&#x1f384; 如 果 你 …
阅读更多...
Vue3+Vite实现工程化，插值表达式和v-text以及v-html

Vue3+Vite实现工程化，插值表达式和v-text以及v-html

1、插值表达式 插值表达式最基本的数据绑定形式是文本插值&#xff0c;它使用的是"Mustache"语法&#xff0c;即 双大括号{{}} 插值表达式是将数据 渲染 到元素的指定位置的手段之一插值表达式 不绝对依赖标签&#xff0c;其位置相对自由插值表达式中支持javascript的…
阅读更多...
XmlElement注解在Java的数组属性上，以产生多个相同的XML元素

XmlElement注解在Java的数组属性上，以产生多个相同的XML元素

例如&#xff0c;下面这段XML数据&#xff0c;有多个data元素&#xff0c;并且它们级别相同: <?xml version"1.0" encoding"UTF-8"?><request><reqtype>05</reqtype><secret>test</secret><body><userid&…
阅读更多...
93.STL-系统内置仿函数

93.STL-系统内置仿函数

目录 算术仿函数 关系仿函数 逻辑仿函数 C 标准库中提供了一些内置的函数对象&#xff0c;也称为仿函数&#xff0c;它们通常位于 <functional> 头文件中。以下是一些常见的系统内置仿函数&#xff1a; 算术仿函数 功能描述&#xff1a; 实现四则运算其中negate是一元…
阅读更多...
个人博客项目 - 测试报告

个人博客项目 - 测试报告

文章目录 一、项目背景二、测试报告功能测试1.编写测试用例2.登录测试3.编写文章测试4.查看文章测试5.删除文章测试7.注销登录测试 自动化测试性能测试1.VUG2.进行场景设计3.生成性能测试报告 总结 本文开始 一、项目背景 通过学习测试相关的知识&#xff0c;动手实践并测试一…
阅读更多...
Linux文件

Linux文件

目录 一、基本概念 二、研究进程和被打开文件的关系 &#xff08;一&#xff09;w方式 &#xff08;二&#xff09;a方式 三、认识系统接口&#xff0c;操作文件 &#xff08;一&#xff09;认识文件描述符 &#xff08;二&#xff09;举例 &#xff08;三&#xff09;…
阅读更多...
ML-Net：通过深度学习彻底改变多标签分类

ML-Net：通过深度学习彻底改变多标签分类

一、说明 多标签分类是一项具有挑战性的机器学习任务&#xff0c;其中输入可以同时属于多个类。传统的多标签分类方法通常依赖于将问题转化为一系列二元分类任务或使用集成方法。然而&#xff0c;深度学习的出现开创了多标签分类的新时代&#xff0c;ML-Net 等模型突破了该领域…
阅读更多...
【数据结构】动态顺序表详解

【数据结构】动态顺序表详解

目录 1.顺序表的概念及结构 2.动态顺序表的实现 2.1创建新项目 2.2动态顺序表的创建 2.3接口的实现及测其功能 2.3.1初始化 2.3.2尾插 2.3.3头插 2.3.4尾删&头删 2.3.5打印&从任意位置插入 2.3.6删除任意位置的数据 2.3.7查找 2.3.8销毁顺序表 3.结语 He…
阅读更多...
2018-2022年富时罗素 ESG评分数据

2018-2022年富时罗素 ESG评分数据

2018-2022年富时罗素 ESG评分数据 1、时间&#xff1a;2018-2022年 2、指标&#xff1a;证券代码、证券简称、富时罗素ESG评分、 3、说明&#xff1a; 富时罗素ESG评级体系评估了中国大陆、香港、欧洲以及美国等市场上1800家中国上市企业股票&#xff0c;评估了7200多种证券…
阅读更多...
scss的高级用法——循环

scss的高级用法——循环

周末愉快呀&#xff01;一起来学一点简单但非常有用的css小知识。 最近在一个项目中看到以下css class写法&#xff1a; 了解过tailwind css或者unocss的都知道&#xff0c;从命名就可以看出有以下样式&#xff1a; font-size: 30pxmargin-left: 5px;margin-top: 10px; 于是…
阅读更多...
SpringBoot监听器解析

SpringBoot监听器解析

监听器模式介绍 监听器模式的要素 事件监听器广播器触发机制 SpringBoot监听器实现 系统事件 事件发送顺序 监听器注册 监听器注册和初始化器注册流程类似 监听器触发机制 获取监听器列表核心流程: 通用触发条件: 自定义监听器实现 实现方式1 实现监听器接口: Order(1) …
阅读更多...
Docker Volume: 实现容器间数据共享与持久化的利器

Docker Volume: 实现容器间数据共享与持久化的利器

文章目录 Docker Volume的作用Docker Volume与容器内数据的比较优势劣势 Docker Volume的创建和管理创建Docker Volume管理Docker Volume 演示Docker Volume的挂载Docker Volume的生命周期安全性考虑与Docker Volume应用场景Docker Volume与多容器协作容器迁移与Docker Volume未…
阅读更多...
如何入驻抖音本地生活服务商,附上便捷流程!

如何入驻抖音本地生活服务商,附上便捷流程!

抖音作为一款短视频社交媒体应用&#xff0c;已经成为全球范围内数以亿计的用户的首选。而在普及的同时&#xff0c;短视频领域也在不断拓展自身的业务领域&#xff0c;其中之一就是本地生活服务。继抖音本地生活服务之后支付宝、视频号也相继开展了本地生活服务&#xff0c;用…
阅读更多...
用css实现原生form中radio单选框和input输入框的hover样式以及聚焦focus的样式

用css实现原生form中radio单选框和input输入框的hover样式以及聚焦focus的样式

一.问题描述&#xff1a;用css实现原生form中radio单选框和input的hover已经focus的样式 在实际的开发中&#xff0c;一般公司ui都会给效果图&#xff0c;比如单选按钮radio样式&#xff0c;input输入框hover的时候样式&#xff0c;以及focus的时候样式&#xff0c;等等&#…
阅读更多...
【并发编程】ThreadLocal详解与原理

【并发编程】ThreadLocal详解与原理

&#x1f4eb;作者简介&#xff1a;小明Java问道之路&#xff0c;2022年度博客之星全国TOP3&#xff0c;专注于后端、中间件、计算机底层、架构设计演进与稳定性建设优化&#xff0c;文章内容兼具广度、深度、大厂技术方案&#xff0c;对待技术喜欢推理加验证&#xff0c;就职于…
阅读更多...
java项目之社区互助平台（ssm+vue）

java项目之社区互助平台（ssm+vue）

项目简介 社区互助平台实现了以下功能&#xff1a; 1、一般用户的功能及权限 所谓一般用户就是指还没有注册的过客,他们可以浏览主页面上的信息。但如果有中意的社区互助信息时&#xff0c;要登录注册&#xff0c;只有注册成功才有的权限。2、管理员的功能及权限 用户信息的添…
阅读更多...
[C/C++] 数据结构 LeetCode:用队列实现栈

[C/C++] 数据结构 LeetCode:用队列实现栈

题目描述: 请你仅使用两个队列实现一个后入先出&#xff08;LIFO&#xff09;的栈&#xff0c;并支持普通栈的全部四种操作&#xff08;push、top、pop 和 empty&#xff09;。 实现 MyStack 类&#xff1a; void push(int x) 将元素 x 压入栈顶。int pop() 移除并返回栈顶元…
阅读更多...
图像分割方法

图像分割方法

常见的图像分割方法有以下几种&#xff1a; 1.基于阈值的分割方法 灰度阈值分割法是一种最常用的并行区域技术&#xff0c;它是图像分割中应用数量最多的一类。阈值分割方法实际上是输入图像f到输出图像g的如下变换&#xff1a; 其中&#xff0c;T为阈值&#xff1b;对于物体的…
阅读更多...
如何用cmd命令快速搭建FTP服务

如何用cmd命令快速搭建FTP服务

环境&#xff1a; Win10专业版 问题描述&#xff1a; 如何用cmd命令快速搭建FTP服务 解决方案&#xff1a; 1.输入以下命令来安装IIS&#xff08;Internet Information Services&#xff09;&#xff1a; dism /online /enable-feature /featurename:IIS-FTPServer /all …
阅读更多...
如果文件已经存在与git本地库中，配置gitignore能否将其从git库中删除

如果文件已经存在与git本地库中，配置gitignore能否将其从git库中删除

想把项目的前后台代码放到同一个git仓库管理&#xff0c;由于未设置.gitignore&#xff0c;就使用vscode做stage操作&#xff08;相当于git add . 命令 其中【.】点表示全部文件&#xff09;&#xff0c;观察将要入库的文件发现&#xff0c;node_modules、target、.idea、log等…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023