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

news2025/2/21 10:21:21

一、引言

目前互联网大厂在搭建后端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,发送“后端”获取

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

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

使用 Python paramiko 自动备份设备配置实验

一、实验拓扑&#xff1a; 要求&#xff1a;交换机 SW1 做为 SSH 服务端&#xff0c;桥接本地虚拟虚拟网卡&#xff1b;本地主机通过 python paramiko 库功能登录到 SW1 上进行配置备份&#xff1b;AR1 做为测试 SW1 的 SSH 客户端 二、实验环境搭建&#xff1a; 1、SW1 配置…

【Python项目】文本相似度计算系统

【Python项目】文本相似度计算系统 技术简介&#xff1a;采用Python技术、Django技术、MYSQL数据库等实现。 系统简介&#xff1a;本系统基于Django进行开发&#xff0c;包含前端和后端两个部分。前端基于Bootstrap框架进行开发&#xff0c;主要包括系统首页&#xff0c;文本分…

某大型业务系统技术栈介绍【应对面试】

微服务架构【图】 微服务架构【概念】 微服务架构&#xff0c;是一种架构模式&#xff0c;它提倡将单一应用程序划分成一组小的服务&#xff0c;服务之间互相协调、互相配合&#xff0c;为用户提供最终价值。在微服务架构中&#xff0c;服务与服务之间通信时&#xff0c;通常是…

复现论文:DPStyler: Dynamic PromptStyler for Source-Free Domain Generalization

论文&#xff1a;[2403.16697] DPStyler: Dynamic PromptStyler for Source-Free Domain Generalization github: TYLfromSEU/DPStyler: DPStyler: Dynamic PromptStyler for Source-Free Domain Generalization 论文: 这篇论文还是在PromptStyler:Prompt-driven Style Gener…

Python在网络安全中的应用 python与网络安全

前言 网络安全是保护网络、系统和程序免受数字攻击的做法。据估计&#xff0c; 2019 年该行业价值 1120 亿美元&#xff0c;到2021 年估计有 350 万个职位空缺。 许多编程语言用于执行与网络安全相关的日常任务&#xff0c;但其中一种已成为行业标准&#xff1a;Python&#…

轻松搭建本地大语言模型(二)Open-WebUI安装与使用

文章目录 前置条件目标一、安装 Open-WebUI使用 Docker 部署 二、使用 Open-WebUI&#xff08;一&#xff09;访问Open-WebUI&#xff08;二&#xff09;注册账号&#xff08;三&#xff09;模型选择&#xff08;四&#xff09;交互 四、常见问题&#xff08;一&#xff09;容器…

解锁机器学习核心算法 | 随机森林算法:机器学习的超强武器

一、引言 在机器学习的广阔领域中&#xff0c;算法的选择犹如为一场冒险挑选趁手的武器&#xff0c;至关重要。面对海量的数据和复杂的任务&#xff0c;合适的算法能够化繁为简&#xff0c;精准地挖掘出数据背后隐藏的模式与价值。机器学习领域有十大核心算法&#xff0c;而随…

Linux环境Docker使用代理推拉镜像

闲扯几句 不知不觉已经2月中了&#xff0c;1个半月忙得没写博客&#xff0c;这篇其实很早就想写了&#xff08;可追溯到Docker刚刚无法拉镜像的时候&#xff09;&#xff0c;由于工作和生活上的事比较多又在备考软考架构&#xff0c;拖了好久…… 简单记录下怎么做的&#xf…

深度学习05 ResNet残差网络

目录 传统卷积神经网络存在的问题 如何解决 批量归一化BatchNormalization, BN 残差连接方式 ​残差结构 ResNet网络 ResNet 网络是在 2015年 由微软实验室中的何凯明等几位大神提出&#xff0c;斩获当年ImageNet竞赛中分类任务第一名&#xff0c;目标检测第一名。获得CO…

Java零基础入门笔记:(4)方法

前言 本笔记是学习狂神的java教程&#xff0c;建议配合视频&#xff0c;学习体验更佳。 【狂神说Java】Java零基础学习视频通俗易懂_哔哩哔哩_bilibili 第1-2章&#xff1a;Java零基础入门笔记&#xff1a;(1-2)入门&#xff08;简介、基础知识&#xff09;-CSDN博客 第3章…

DeepSeek 和 ChatGPT 在特定任务中的表现:逻辑推理与创意生成

&#x1f381;个人主页&#xff1a;我们的五年 &#x1f50d;系列专栏&#xff1a;Linux网络编程 &#x1f337;追光的人&#xff0c;终会万丈光芒 &#x1f389;欢迎大家点赞&#x1f44d;评论&#x1f4dd;收藏⭐文章 ​ Linux网络编程笔记&#xff1a; https://blog.cs…

VSCode本地python包“无法解析导入”

问题现象 在使用 VSCode 编写 Python 代码时&#xff0c;虽然程序能正常运行&#xff0c;但遇到“无法解析导入”的问题&#xff0c;导致代码无法高亮。 解决方法 配置 python.autoComplete.extraPaths 打开 VSCode 设置&#xff08;CtrlShiftP -> Preferences: Open Wo…

本地使用docker部署DeepSeek大模型

1、相关技术介绍 1.1、RAG RAG&#xff08;Retrieval Augmented Generation&#xff09;&#xff0c;即“检索&#xff0c;增强&#xff0c;生成”&#xff0c;用于提升自然语言处理任务的性能。其核心思想是通过检索相关信息来增强生成模型的能力&#xff0c;具体步骤如下&am…

统计5分钟nginx访问日志的数据并设置阈值告警

1.脚本统计生成deny_ip文件 #!/usr/bin/bash#Tate:2022.3.30 #Author:Yingjian #function: 统计5分钟之内的访问ip #env#脚本存放的目录 workdircd $(dirname $0);pwdif [ $# -eq 0 ];then echo "Usage: $0 {统计几分钟内的ip}" exit 2 filogfile/var/log/nginx/acc…

day12_调度和可视化

文章目录 day12_调度和可视化一、任务调度1、开启进程2、登入UI界面3、配置租户4、创建项目5、创建工作流5.1 HiveSQL部署&#xff08;掌握&#xff09;5.2 SparkDSL部署&#xff08;掌握&#xff09;5.3 SparkSQL部署&#xff08;熟悉&#xff09;5.4 SeaTunnel部署&#xff0…

DC-6靶机渗透测试全过程

目录 前期准备 一、渗透测试 1.IP地址查询 2.端口信息搜寻 3.网页信息搜集 wappalyzer WPScan 反弹shell graham用户 反弹出jens的shell nmap提权 二、总结 前期准备 攻击机&#xff1a; kali windows11 靶机&#xff1a;DC-6靶机&#xff08;调至NAT模式&#xff0…

Win11 远程 连接 Ubuntu20.04(局域网)

Win11 远程 连接 Ubuntu20.04(局域网&#xff09; 0. Ubuntu 开启共享1. Ubuntu系统中安装RDP服务器2.windows中连接使用方式1&#xff1a;远程桌面连接(winr: mstsc)方式2&#xff1a;mobaXterm 3 问题远程连接后出现黑屏 参考文献: 0. Ubuntu 开启共享 在ubunt设置中&#x…

Visual Studio Code支持WSL,直接修改linux/ubuntu中的文件

步骤1 开始通过 WSL 使用 VS Code | Microsoft Learn 点击远程开发扩展包。 步骤2 Remote Development - Visual Studio Marketplace 点击install&#xff0c; 允许打开Visual Studio Code。 步骤3 共有4项&#xff0c;一齐安装。 步骤4 在WSL Linux(Ubuntu)中&#xf…

开源在线考试系统开源在线考试系统:支持数学公式的前后端分离解决方案

开源在线考试系统&#xff1a;支持数学公式的前后端分离解决方案 项目介绍项目概述&#xff1a;技术栈&#xff1a;版本要求主要功能&#xff1a;特色亮点 项目仓库地址演示地址GiteeGitHub 系统效果展示教师端系统部分功能截图学生端系统部分功能截图 结语 项目介绍 项目概述…

解决 ssh connect to host github.com port 22 Connection timed out

一、问题描述 本地 pull/push 推送代码到 github 项目报 22 端口连接超时&#xff0c;测试连接也是 22 端口连接超时 ssh 密钥没问题、也开了 Watt Toolkit 网络是通的&#xff0c;因此可以强制将端口切换为 443 二、解决方案 1、测试连接 ssh -T gitgithub.com意味着无法通…