MyBatis:动态SQL高级标签使用方法指南

一、引言

目前互联网大厂在搭建后端Java服务时,常使用Springboot搭配Mybatis/Mybatis-plus的框架。Mybatis/Mybatis-plus之所以能成为当前国内主流的持久层框架,与其本身的优点有关:支持定制动态 SQL、存储过程及高级映射,简化数据库操作。

可能有人会问, 为什么要用动态SQL,在开发过程中把SQL写死不是比较方便、更加不容易出错吗?其实这是由开发过程中具体业务需求决定的,比如在用户注册场景下,用户注册填写信息时,会有必填字段和非必填字段,不同用户注册时传给后端的参数有区别,对应的插入用户表的SQL也不一样,因此,在这些的场景下开发人员需要使用动态SQL来完成。本文首先介绍Springboot项目中SQL映射方式,最后介绍动态SQL和支持动态SQL的核心标签。

欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送“后端”获取资料

二、SQL映射方式

1、XML映射文件,该文件通常位于 resources/自定义的包路径/mapper 目录。

示例:

  <!-- UserMapper.xml -->
  <mapper namespace="com.example.UserMapper">
    <select id="selectUserById" resultType="User">
      SELECT * FROM user WHERE id = #{id}
    </select>
  </mapper>

2、注解映射

适用场景:简单 SQL 可直接在接口方法上使用注解。

示例:

public interface UserMapper {
    @Insert("INSERT INTO user(name) VALUES(#{name})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    void insertUser(User user);
  }

欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送“后端”获取资料

三、动态SQL及常用标签

在 MyBatis中,动态SQL允许开发人员根据不同的条件构建不同的 SQL 语句。执行原理为,使用OGNL从SQL参数对象中计算表达式的值,根据表达式的值动态拼接SQL,以此来完成动态SQL的功能。动态SQL中常用的核心标签有:、、、、、等。

1、动态 SQL

  • 以下SQL为XML文件中复杂动态SQL的示例:
  <select id="searchUsers" resultType="User">
    SELECT * FROM user
    <where>
      <if test="name != null">
         AND name LIKE CONCAT('%', #{name}, '%')
      </if>
      <if test="roles != null">
        AND role IN
        <foreach item="role" collection="roles" open="(" separator="," close=")">
          #{role}
        </foreach>
      </if>
    </where>
  </select>

2、常用标签

1)<if> 标签

a)用途:条件判断,满足条件时包含 SQL 片段。

b)示例

<select id="findUser" resultType="User">
    SELECT * FROM user
    WHERE 1=1
    <if test="name != null">
      AND name = #{name}
    </if>
  </select>
2)<where> 标签

a)用途:自动添加 WHERE 关键字,并去除首条多余的 AND/OR

b)示例

<select id="selectByStudent" resultMap="BaseResultMap" parameterType="com.xxx.entity.Student">
    select
    <include refid="Base_Column_List" />
    from student
   <where>
    <if test="name != null and name !=''">
      and name like concat('%', #{name}, '%')
    </if>
    <if test="sex != null">
      and sex=#{sex}
    </if>
   </where>
  </select>

说明:以上SQL中,当条件都不满足时:此时 SQL 中应该要不能有 where , 否则导致出错。当 if 有条件满足时:SQL 中需要有 where, 且第一个成立的 if 标签下的 and | or 等要去掉,这时候,我们可以使用 where 标签。

3)<set> 标签

a)用途:主要用于SQL的UPDATE命令中,自动添加 SET 关键字,并去除末尾多余的逗号。

b)示例:

 <update id="updateUser">
    UPDATE user
    <set>
      <if test="name != null">name = #{name},</if>
      <if test="age != null">age = #{age},</if>
    </set>
    WHERE id = #{id}
  </update>
4)<foreach> 标签

a)用途:遍历集合(如 IN 查询、批量插入)。

b)该标签的属性:

  - collection:集合参数名。

  - item:遍历元素的变量名。

  - open/close:包裹结果的前缀/后缀。

  - separator:元素间的分隔符。

c)示例:

<!-- IN 查询 -->
  SELECT * FROM user WHERE id IN
  <foreach item="id" collection="ids" open="(" separator="," close=")">
    #{id}
  </foreach>
  
  <!-- 批量插入 -->
  INSERT INTO user (name) VALUES
  <foreach item="user" collection="list" separator=",">
    (#{user.name})
  </foreach>

注意:在使用标签时,最好在标签前加上标签,判断列表是否为null或者有数据,如果列表没数据,不加标签直接使用标签会报错。第一个查询SQL的动态SQL建议写法:

 SELECT * FROM user 
<if test = "ids != null and ids.size > 0">
    WHERE id IN
<foreach item="id" collection="ids" open="(" separator="," close=")">
    #{id}
</foreach>
</if>
5)<choose>/<when>/<otherwise> 标签

a)用途:多条件分支(功能类似于switch-case)。

b)示例:

<select id="findUser" resultType="User">
    SELECT * FROM user
    <where>
      <choose>
        <when test="name != null">AND name = #{name}</when>
        <when test="email != null">AND email = #{email}</when>
        <otherwise>AND is_active = 1</otherwise>
      </choose>
    </where>
  </select>
6)<trim> 标签

a)用途:自定义字符串修剪(可替代 标签 或 标签)。

b)属性:

  - prefix:添加前缀。

  - prefixOverrides:去除首部匹配的字符。

  - suffix:添加后缀。

  - suffixOverrides:去除尾部匹配的字符。

c)示例:

<!-- 替代 <where> -->
  <trim prefix="WHERE" prefixOverrides="AND |OR ">
<if test="name != null and name != ``">
AND name = #{name}
</if>
  </trim>
  <!-- 替代 <set> -->
  <trim prefix="SET" suffixOverrides=",">
    <if test="name != null">name = #{name},</if>
  </trim>
7)<bind> 标签

a)用途:创建变量并绑定到上下文,用于复杂表达式或重复逻辑。

b)示例:

  <select id="searchUser">
    <bind name="pattern" value="'%' + keyword + '%'" />  <!-- 拼接模糊查询参数 -->
    SELECT * FROM user
    WHERE name LIKE #{pattern}
  </select>

欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送“后端”获取资料

四、使用注意事项

1)OGNL表达式中:test 属性中使用的表达式语言,支持复杂逻辑,例如:==, !=, &&, || 等操作。例如:

<if test="name != null and name != ''">  <!-- 同时检查非空和非空字符串 -->

2)参数处理:

  • mapper接口中抽象方法的集合参数需通过 @Param 命名
List<User> findUsersByIds(@Param("ids") List<Integer> ids);
  • 空值检查需显式处理(如 test="name != null and name != ''")。

3)动态 SQL 性能:避免写过度复杂的动态SQL,过度复杂的SQL可能影响数据库执行计划,导致查询性能差。

4)动态表名/列名不建议使用 ${},建议使用#{},以防止 SQL 注入。

5)在Springboot搭配使用Mybatis时,为了能将Mapper接口上加了@Mapper@Dao的Bean注入到spring容器中,需要在启动类中添加@MapperScan注解,@MapperScan注解中的包路径名称为mapper接口的路径。如下所示:

  @SpringBootApplication
  @MapperScan("com.example.mapper")
  public class Application {
    public static void main(String[] args) {
      SpringApplication.run(Application.class, args);
      // 其它业务代码
    }
  }

欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送“后端”获取资料

五、一些最佳实践

1、在Mybatis的XML文件中对于某些频繁用到的SQL,为了避免重复写以及重复写导致的出错,可以引用某个常用的SQL,如下即为引用SQL的做法:

<sql id="all">
select * from user
</sql>

<select id="selectUserByUid" resultType="user">
<include refid="all"/>
where uid = #{uid}
</select>

<select id="selectIf" resultType="user">
<include refid="all"/>
<where>
<if test="username != null">
username = #{username}
</if>
</where>
</select>

2、判断list集合是否包含指定数据

<if test="list.contains('0')">
#{逻辑}
</if>

3、XML的SQL中比较符号的写法

gt 对应 >
gte 对应 >=
lt 对应 <(会报错 相关联的 "test" 属性值不能包含 '<' 字符)
lte 对应 <=(会报错 相关联的 "test" 属性值不能包含 '<' 字符)
<![CDATA[ sql 语句 ]]>
<![CDATA[ >= ]]>

4、MyBatis的XML中使用内部类的方式

内部类需要使用$符号连接,而不是点.,以下为正确写法:

com.xxx.model.SMSESBResult$ReceiveResult$ResultInfo

六、写在最后的话

总之,MyBatis的动态SQL功能允许开发者根据不同条件灵活构建SQL语句,避免手动拼接字符串,另外,常用查询列和查询SQL还可以借助动态SQL实现复用,提高XML中SQL代码的可维护性和安全性。



欢迎关注工 众号:ItBeeCoder,查看更多高质量技术文章,发送“后端”获取资料


又到了金三银四求职季,我整理了一些互联网大厂的面试题,有需要的可关注工 众号:ItBeeCoder,发送“后端”获取

在这里插入图片描述
在这里插入图片描述

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

快速入门——Axios网络请求

学习自哔哩哔哩上的“刘老师教编程”&#xff0c;具体学习的网站为&#xff1a;11.Axios网络请求_哔哩哔哩_bilibili&#xff0c;以下是看课后做的笔记&#xff0c;仅供参考。 第一节Axios的使用 第二节与Vue整合 第三节跨域 第一节Axios的使用 在实际项目开发中&#xff0…

Typora的Github主题美化

对Typora的Github主题进行一些自己喜欢的修改&#xff0c;主要包括&#xff1a;字体、代码块、表格样式 美化前&#xff1a; 美化后&#xff1a; 字体更换 之前便看上了「中文网字计划」的「朱雀仿宋」字体&#xff0c;于是一直想更换字体&#xff0c;奈何自己拖延症作祟&#…

DeepSeek 助力 Vue 开发:打造丝滑的 键盘快捷键(Keyboard Shortcuts)

前言&#xff1a;哈喽&#xff0c;大家好&#xff0c;今天给大家分享一篇文章&#xff01;并提供具体代码帮助大家深入理解&#xff0c;彻底掌握&#xff01;创作不易&#xff0c;如果能帮助到大家或者给大家一些灵感和启发&#xff0c;欢迎收藏关注哦 &#x1f495; 目录 Deep…

[深度学习][python]yolov12+bytetrack+pyqt5实现目标追踪

【算法介绍】 实时目标检测因其低延迟特性而持续受到广泛关注&#xff0c;具有重要的实际应用价值[4, 17, 24, 28]。其中&#xff0c;YOLO系列[3, 24, 28, 29, 32, 45-47, 53, 57, 58]通过有效平衡延迟与精度&#xff0c;在该领域占据主导地位。尽管YOLO的改进多集中在损失函数…

Python大数据可视化:基于大数据技术的共享单车数据分析与辅助管理系统_flask+hadoop+spider

开发语言&#xff1a;Python框架&#xff1a;flaskPython版本&#xff1a;python3.7.7数据库&#xff1a;mysql 5.7数据库工具&#xff1a;Navicat11开发软件&#xff1a;PyCharm 系统展示 管理员登录 管理员功能界面 场地信息界面 单车信息界面 归还信息界面 共享单车界面 系…

ssm-day06 ssm整合

从springMVC总结再回顾一下 60节 整合就是应用框架&#xff0c;并且把这个框架放到IOC容器中 web容器&#xff1a;装springMVC和controller相关的web组件 root容器&#xff1a;装业务和持久层相关的组件 子容器可以引用父容器中的组件&#xff0c;父容器不能调子容器 一个容器…

MATLAB基础学习相关知识

MATLAB安装参考&#xff1a;抖音-记录美好生活 MATLAB基础知识学习参考&#xff1a;【1小时Matlab速成教程-哔哩哔哩】 https://b23.tv/CnvHtO3 第1部分&#xff1a;变量定义和基本运算 生成矩阵&#xff1a; % 生成矩阵% 直接法% ,表示行 ;表示列 a [1,2,3;4,5,6;7,8,9];%…

Windows - 通过ssh打开带有图形界面的程序 - 一种通过计划任务的曲折实现方式

Windows(奇思妙想) - 通过ssh打开带有图形界面的程序 - 一种通过计划任务的曲折实现方式 前言 Windows启用OpenSSH客户端后就可以通过SSH的方式访问Windows了。但是通过SSH启动的程序&#xff1a; 无法显示图形界面会随着SSH进程的结束而结束 于是想到了一种通过执行“计划…

WPS接入deepseek-OfficeAI助手插件下载

功能简介 OfficeAI 助手 是一款免费的智能AI办公工具软件&#xff0c;专为 Microsoft Office 和 WPS 用户打造。 无论你是在寻找如何输入“打勾&#xff08;√&#xff09;符号”的方法&#xff0c;还是想知道“怎么在插入表格前添加文字”&#xff0c;或者“该用哪个公式”&a…

【JavaEE进阶】Spring MVC(4)-图书管理系统案例

欢迎关注个人主页&#xff1a;逸狼 创造不易&#xff0c;可以点点赞吗 如有错误&#xff0c;欢迎指出~ 图书管理系统 创建书籍类BookInfo import lombok.Data;import java.math.BigDecimal;Data //这个类基本上是和数据库对应起来的 public class BookInfo {private Integer id…

路由器的WAN口和LAN口有什么区别?

今时今日&#xff0c;移动终端盛行的时代&#xff0c;WIFI可以说是家家户户都有使用到的网络接入方式。那么路由器当然也就是家家户户都不可或缺的设备了。而路由器上的两个实现网络连接的基础接口 ——WAN 口和 LAN 口&#xff0c;到底有什么区别&#xff1f;它们的功能和作用…

AI客服-接入deepseek大模型到微信(本地部署deepseek集成微信自动收发消息)

1.本地部署 1.1 ollama Ollama软件通过其高度优化的推理引擎和先进的内存管理机制&#xff0c;显著提升了大型语言模型在本地设备上的运行效率。其核心采用了量化技术&#xff08;Quantization&#xff09;以降低模型的计算复杂度和存储需求&#xff0c;同时结合张量并行计算&…

基于COSTAR模型的内容创作:如何用框架提升写作质量

目录 前言1. Context&#xff08;上下文&#xff09;&#xff1a;理解背景&#xff0c;奠定写作基础1.1 何为上下文1.2 上下文的作用1.3 案例解析 2. Objective&#xff08;目标&#xff09;&#xff1a;明确写作方向&#xff0c;避免跑题2.1 确立目标2.2 如何设定目标2.3 案例…

kafka-集群缩容

一. 简述&#xff1a; 当业务增加时&#xff0c;服务瓶颈&#xff0c;我们需要进行扩容。当业务量下降时&#xff0c;为成本考虑。自然也会涉及到缩容。假设集群有 15 台机器&#xff0c;预计缩到 10 台机器&#xff0c;那么需要做 5 次缩容操作&#xff0c;每次将一个节点下线…

DeepSeek 提示词:定义、作用、分类与设计原则

&#x1f9d1; 博主简介&#xff1a;CSDN博客专家&#xff0c;历代文学网&#xff08;PC端可以访问&#xff1a;https://literature.sinhy.com/#/?__c1000&#xff0c;移动端可微信小程序搜索“历代文学”&#xff09;总架构师&#xff0c;15年工作经验&#xff0c;精通Java编…

基于vue和微信小程序的校园自助打印系统(springboot论文源码调试讲解)

第3章 系统设计 3.1系统功能结构设计 本系统的结构分为管理员和用户、店长。本系统的功能结构图如下图3.1所示&#xff1a; 图3.1系统功能结构图 3.2数据库设计 本系统为小程序类的预约平台&#xff0c;所以对信息的安全和稳定要求非常高。为了解决本问题&#xff0c;采用前端…

大数据组件(四)快速入门实时数据湖存储系统Apache Paimon(3)

Paimon的下载及安装&#xff0c;并且了解了主键表的引擎以及changelog-producer的含义参考&#xff1a; 大数据组件(四)快速入门实时数据湖存储系统Apache Paimon(1) 利用Paimon表做lookup join&#xff0c;集成mysql cdc等参考&#xff1a; 大数据组件(四)快速入门实时数据…

blender笔记2

一、物体贴地 物体->变换->对齐物体 ->对齐弹窗(对齐模式&#xff1a;反方&#xff0c;相对于&#xff1a;场景原点&#xff0c;对齐&#xff1a;z)。 之后可以设置原点->原点--3d游标 二、面上有阴影 在编辑模式下操作过后&#xff0c;物体面有阴影。 数据-&g…

MinkowskiEngine安装(CUDA11.8+torch2.0.1+RTX4070TI)

1、背景 1&#xff09;因为项目要用这个库&#xff1a;MinkowskiEngine&#xff0c;Minkowski Engine — MinkowskiEngine 0.5.3 documentation 然后就用了之前安装好 MinkowskiEngine 的torch1.8.1,cuda11.1的环境。 2&#xff09;自己的代码出现cuda不支持torch用gpu进行矩…

【Blender】二、建模篇--05,阵列修改器与晶格形变

阵列修改器是bender里面一个比较常用的修改器,所以我们单独开口来讲,我们会先从几片树叶出发,然后我们用阵列修改器把这几片树叶变成这样的造型和这样的造型。这两个造型分别就代表着阵列修改器最常用的两种偏移方法,我们现在就开始我们先来做几个树叶。 1.树叶建模 首先…