Mybatis Plus自定义全局SQL注入

本文涉及的产品
RDS MySQL DuckDB 分析主实例,集群系列 4核8GB
RDS AI 助手,专业版
RDS MySQL DuckDB 分析主实例,基础系列 4核8GB
简介: Mybatis Plus自定义全局SQL注入

根据MybatisPlus 的 AutoSqlInjector可以自定义各种你想要的 sql ,注入到全局中,相当于自定义 Mybatisplus 自动注入的方法。之前需要在xml中进行配置 的 SQL语句,现在通过扩展 AutoSqlInjector 在加载 mybatis环境时就注入。


这种方式适合简单、全局式、批量式的业务。实际应用中如果MybatisPlus已经注入好的方法不能满足业务需要,更多还是使用xml方式实现自己的业务。


【1】自定义注入实现步骤

实现步骤如下:


  • 在 Mapper接口中定义相关的 CRUD方法
  • 扩展 AutoSqlInjector inject 方法,实现 Mapper接口中方法要注入的 SQL
  • 在 MP全局策略中,配置 自定义注入器


① mapper中定义业务方法

如下所示:

public interface EmployeeMapper extends BaseMapper<Employee> {
  int  deleteAll();
}


② 实现自己的MySqlInjector

如下所示:

/**
 * 自定义全局操作
 */
public class MySqlInjector  extends AutoSqlInjector{
  /**
   * 扩展inject 方法,完成自定义全局操作
   */
  @Override
  public void inject(Configuration configuration, MapperBuilderAssistant builderAssistant, Class<?> mapperClass,
      Class<?> modelClass, TableInfo table) {
    //将EmployeeMapper中定义的deleteAll, 处理成对应的MappedStatement对象,加入到configuration对象中。
    //注入的SQL语句
    String sql = "delete from " +table.getTableName();
    //注入的方法名   一定要与EmployeeMapper接口中的方法名一致
    String method = "deleteAll" ;
    //构造SqlSource对象
    SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
    //构造一个删除的MappedStatement
    this.addDeleteMappedStatement(mapperClass, method, sqlSource);
  }
}

③ 把自定义的MySqlInjector 配置到全局策略中

如果是xml配置方式,实例如下:

<!-- 定义MybatisPlus的全局策略配置-->
<bean id ="globalConfiguration" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
<!-- 在2.3版本以后,dbColumnUnderline 默认值就是true -->
<property name="dbColumnUnderline" value="true"></property>
<!-- Mysql 全局的主键策略 -->
<property name="idType" value="0"></property> 
<!-- 全局的表前缀策略配置 -->
<property name="tablePrefix" value="tbl_"></property>
<!--注入自定义全局操作   -->
<property name="sqlInjector" ref="mySqlInjector"></property>
</bean>
<!-- 定义自定义注入器 -->
<bean id="mySqlInjector" class="com.jane.mp.injector.MySqlInjector"></bean>

【2】自定义注入器的应用之逻辑删除

什么是假删除、逻辑删除?


并不会真正的从数据库中将数据删除掉,而是将当前被删除的这条数据中的一个逻辑删除字段置为删除状态。MybatisPlus(mp)为我们内置了一个LogicSqlInjector来帮助我们实现逻辑删除功能。

TableFieldInfo中有如下两个字段:


在 POJO的逻辑删除字段 添加 @TableLogic注解

则会在 mp自带查询和更新方法的 sql后面,追加『逻辑删除字段』 =『 LogicNotDeleteValue默认值』

而对删除方法,如 deleteById()和其他 delete方法 , 底层 SQL调用的是 update tbl_xxx set 『逻辑删除字段』 =『 logicDeleteValue默认值』


LogicNotDeleteValue默认值、logicDeleteValue默认值默认为空,但是可以在全局配置中进行设置如下所示:

<!-- 定义MybatisPlus的全局策略配置-->
<bean id ="globalConfiguration" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
<!-- 在2.3版本以后,dbColumnUnderline 默认值就是true -->
<property name="dbColumnUnderline" value="true"></property>
<!-- Mysql 全局的主键策略 -->
<!-- <property name="idType" value="0"></property> -->
<!-- Oracle全局主键策略 -->
<property name="idType" value="1"></property>
<!-- 全局的表前缀策略配置 -->
<property name="tablePrefix" value="tbl_"></property>
<!-- 注入逻辑删除 -->
<property name="sqlInjector" ref="logicSqlInjector"></property>
<!-- 注入逻辑删除全局值 -->
<property name="logicDeleteValue" value = "-1"></property>
<property name="logicNotDeleteValue" value="1"></property>
</bean>
<!-- 逻辑删除 -->
<bean id="logicSqlInjector" class="com.baomidou.mybatisplus.mapper.LogicSqlInjector"></bean>

查询操作实例如下:

 Execute SQL:
    SELECT
        id,
        `name`,
        logic_flag AS logicFlag 
    FROM
        tbl_user 
    WHERE
        id=1 
        AND logic_flag=1]

删除操作实例如下:

Execute SQL:
    UPDATE
        tbl_user 
    SET
        logic_flag=-1 
    WHERE
        id=1]
相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发,帮助IT从业者们通过“阿里云Web应用上云解决方案”,了解一个企业级Web应用上云的常见架构,了解如何构建一个高可用、可扩展的企业级应用架构。
MySQL数据库入门学习
本课程通过最流行的开源数据库MySQL带你了解数据库的世界。 &nbsp; 相关的阿里云产品:云数据库RDS MySQL 版 阿里云关系型数据库RDS(Relational Database Service)是一种稳定可靠、可弹性伸缩的在线数据库服务,提供容灾、备份、恢复、迁移等方面的全套解决方案,彻底解决数据库运维的烦恼。 了解产品详情:&nbsp;https://www.aliyun.com/product/rds/mysql&nbsp;
目录
相关文章
|
SQL Java 数据库连接
【YashanDB知识库】解决mybatis的mapper文件sql语句结尾加分号";"报错
【YashanDB知识库】解决mybatis的mapper文件sql语句结尾加分号";"报错
|
7月前
|
SQL XML Java
通过MyBatis的XML配置实现灵活的动态SQL查询
总结而言,通过MyBatis的XML配置实现灵活的动态SQL查询,可以让开发者以声明式的方式构建SQL语句,既保证了SQL操作的灵活性,又简化了代码的复杂度。这种方式可以显著提高数据库操作的效率和代码的可维护性。
458 18
|
11月前
|
SQL Java 数据库连接
MyBatis动态SQL字符串空值判断,这个细节99%的程序员都踩过坑!
本文深入探讨了MyBatis动态SQL中字符串参数判空的常见问题。通过具体案例分析,对比了`name != null and name != &#39;&#39;`与`name != null and name != &#39; &#39;`两种写法的差异,指出后者可能引发逻辑混乱。为避免此类问题,建议在后端对参数进行预处理(如trim去空格),简化MyBatis判断逻辑,提升代码健壮性与可维护性。细节决定成败,严谨处理参数判空是写出高质量代码的关键。
1516 0
|
7月前
|
SQL Java 数据库连接
SSM相关问题-1--#{}和${}有什么区别吗?--Mybatis都有哪些动态sql?能简述一下动 态sql的执行原理吗?--Spring支持的几种bean的作用域 Scope
在MyBatis中,`#{}`是预处理占位符,可防止SQL注入,适用于大多数参数传递场景;而`${}`是直接字符串替换,不安全,仅用于动态表名、列名等特殊场景。二者在安全性、性能及使用场景上有显著区别。
270 0
|
10月前
|
SQL XML Java
菜鸟之路Day35一一Mybatis之XML映射与动态SQL
本文介绍了MyBatis框架中XML映射与动态SQL的使用方法,作者通过实例详细解析了XML映射文件的配置规范,包括namespace、id和resultType的设置。文章还对比了注解与XML映射的优缺点,强调复杂SQL更适合XML方式。在动态SQL部分,重点讲解了`&lt;if&gt;`、`&lt;where&gt;`、`&lt;set&gt;`、`&lt;foreach&gt;`等标签的应用场景,如条件查询、动态更新和批量删除,并通过代码示例展示了其灵活性与实用性。最后,通过`&lt;sql&gt;`和`&lt;include&gt;`实现代码复用,优化维护效率。
1014 5
|
SQL Java 数据库连接
【YashanDB 知识库】解决 mybatis 的 mapper 文件 sql 语句结尾加分号";"报错
【YashanDB 知识库】解决 mybatis 的 mapper 文件 sql 语句结尾加分号";"报错
|
SQL 缓存 Java
框架源码私享笔记(02)Mybatis核心框架原理 | 一条SQL透析核心组件功能特性
本文详细解构了MyBatis的工作机制,包括解析配置、创建连接、执行SQL、结果封装和关闭连接等步骤。文章还介绍了MyBatis的五大核心功能特性:支持动态SQL、缓存机制(一级和二级缓存)、插件扩展、延迟加载和SQL注解,帮助读者深入了解其高效灵活的设计理念。
|
SQL XML Java
七、MyBatis自定义映射resultMap
七、MyBatis自定义映射resultMap
372 6
|
SQL XML Java
九、MyBatis动态SQL
九、MyBatis动态SQL
223 2
|
SQL Java 数据库连接
【潜意识Java】MyBatis中的动态SQL灵活、高效的数据库查询以及深度总结
本文详细介绍了MyBatis中的动态SQL功能,涵盖其背景、应用场景及实现方式。
1708 6