MyBatis 详细讲解动态 SQL的使用

更新时间：2022年04月07日 12:14:12 作者：托马斯-酷涛

动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架，你应该能理解根据不同条件拼接 SQL 语句有多痛苦，例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗号。利用动态 SQL，可以彻底摆脱这种痛苦

MyBatis 框架动态 SQL

动态 SQL，通过 MyBatis 提供的各种标签对条件作出判断以实现动态拼接 SQL 语句。这里的条件判断使用的表达式为 OGNL 表达式。常用的动态 SQL 标签有<if>、<where>、<choose/>、<foreach>等。

MyBatis 的动态 SQL 语句，与 JSTL 中的语句非常相似。

动态 SQL，主要用于解决查询条件不确定的情况：在程序运行期间，根据用户提交的查询条件进行查询。提交的查询条件不同，执行的 SQL 语句不同。若将每种可能的情况均逐一列出，对所有条件进行排列组合，将会出现大量的 SQL 语句。此时，可使用动态 SQL 来解决这样的问题。

环境准备

1、创建新的 maven 项目，加入 mybatis ， mysql 驱动依赖

2、创建实体类 Student ， StudentDao 接口，StudentDao.xml ,mybatis.xml , 测试类

3、使用之前的表 student。

在 mapper 的动态 SQL 中若出现大于号（>）、小于号（=），小于等于号（<=）等符号，最好将其转换为实体符号。否则， XML 可能会出现解析出错问题。

特别是对于小于号（<），在 XML 中是绝不能出现的。否则解析 mapper 文件会出错。

实体符号表：

<	小于	&lt
>	大于	&gt
>=	大于等于	>=
<=	小于等于	<=

动态 SQL 之 if

对于该标签的执行，当 test 的值为 true 时，会将其包含的 SQL 片断拼接到其所在的 SQL 语句中。

语法： <if test="条件"> sql 语句的部分</if>

接口方法：

List<Student> selectStudentIf(Student student);

mapper文件：

<select id="selectStudentIf" resultType="com.bjpowernode.domain.Student">
 select id,name,email,age from student
 where 1=1
 <if test="name != null and name !='' ">
 and name = #{name}
 </if>
 <if test="age > 0 ">
 and age &gt; #{age}
 </if>
</select>

测试方法：

@Test
public void testSelect() throws IOException {
 Student param = new Student();
 param.setName("李力");
 param.setAge(18);
 List<Student> studentList = studentDao.selectStudentIf(param);
 studentList.forEach( stu -> System.out.println(stu));
}

动态 SQL 之 where

<if/>标签的中存在一个比较麻烦的地方：需要在 where 后手工添加 1=1 的子句。因为，若 where 后的所有<if/>条件均为 false，而 where 后若又没有 1=1 子句，则 SQL 中就会只剩下一个空的 where，SQL 出错。

所以，在 where 后，需要添加永为真子句 1=1，以防止这种情况的发生。但当数据量很大时，会严重影响查询效率。

使用<where/>标签，在有查询条件时，可以自动添加上 where 子句；没有查询条件时，不会添加 where 子句。需要注意的是，第一个<if/>标签中的 SQL 片断，可以不包含 and。

不过，写上 and 也不错，系统会将多出的 and 去掉。但其它<if/>中 SQL 片断的 and，必须要求写上。否则 SQL 语句将拼接出错。

语法：<where> 其他动态 sql</where>

接口方法：

List<Student> selectStudentWhere(Student student);

mapper文件：

<select id="selectStudentWhere" 
resultType="com.bjpowernode.domain.Student">
 select id,name,email,age from student
 <where>
 <if test="name != null and name !='' ">
 and name = #{name}
 </if>
 <if test="age > 0 ">
 and age &gt; #{age}
 </if>
 </where>
</select>

测试方法：

@Test
public void testSelectWhere() throws IOException {
 Student param = new Student();
 param.setName("李力");
 param.setAge(18);
 List<Student> studentList = studentDao.selectStudentWhere(param);
 studentList.forEach( stu -> System.out.println(stu));
}

动态 SQL 之 foreach

<foreach/>标签用于实现对于数组与集合的遍历。对其使用，需要注意：

collection 表示要遍历的集合类型, list ，array 等。
open、close、separator 为对遍历内容的 SQL 拼接。

语法：

<foreach collection="集合类型" open="开始的字符" close="结束的字符" 
 item="集合中的成员" separator="集合成员之间的分隔符">
 #{item 的值}
</foreach>

1、遍历List<简单类型>

表达式中的 List 使用 list 表示，其大小使用 list.size 表示。

需求：查询学生 id 是 1002,1005,1006

接口方法：

List<Student> selectStudentForList(List<Integer> idList);

mapper文件：

<select id="selectStudentForList" 
resultType="com.bjpowernode.domain.Student">
 select id,name,email,age from student
 <if test="list !=null and list.size > 0 ">
 where id in
 <foreach collection="list" open="(" close=")" 
 item="stuid" separator=",">
 #{stuid}
 </foreach>
 </if>
</select>

测试方法：

@Test
public void testSelectForList() {
 List<Integer> list = new ArrayList<>();
 list.add(1002);
 list.add(1005);
 list.add(1006);
 List<Student> studentList = studentDao.selectStudentForList(list);
 studentList.forEach( stu -> System.out.println(stu));
}

2、遍历List<对象类型>

接口方法：

List<Student> selectStudentForList2(List<Student> stuList);

mapper文件：

<select id="selectStudentForList2" 
resultType="com.bjpowernode.domain.Student">
 select id,name,email,age from student
 <if test="list !=null and list.size > 0 ">
 where id in
 <foreach collection="list" open="(" close=")"
 item="stuobject" separator=",">
 #{stuobject.id}
 </foreach>
 </if>
</select>

测试方法：

@Test
public void testSelectForList2() {
 List<Student> list = new ArrayList<>();
 Student s1 = new Student();
 s1.setId(1002);
 list.add(s1);
 s1 = new Student();
 s1.setId(1005);
 list.add(s1);
 List<Student> studentList = studentDao.selectStudentForList2(list);
 studentList.forEach( stu -> System.out.println(stu));
}

动态 SQL 之代码片段

<sql/>标签用于定义 SQL 片断，以便其它 SQL 标签复用。而其它标签使用该 SQL 片断，需要使用<include/>子标签。该<sql/>标签可以定义 SQL 语句中的任何部分，所以<include/>子标签可以放在动态 SQL 的任何位置。

接口方法：

List<Student> selectStudentSqlFragment(List<Student> stuList);

mapper文件：

<!--创建 sql 片段 id:片段的自定义名称--> 
<sql id="studentSql">
 select id,name,email,age from student
</sql>
<select id="selectStudentSqlFragment" 
resultType="com.bjpowernode.domain.Student">
 <!-- 引用 sql 片段 --> 
 <include refid="studentSql"/>
 <if test="list !=null and list.size > 0 ">
 where id in
 <foreach collection="list" open="(" close=")" 
 item="stuobject" separator=",">
 #{stuobject.id}
 </foreach>
 </if>
</select>

测试方法：

@Test
public void testSelectSqlFragment() {
 List<Student> list = new ArrayList<>();
 Student s1 = new Student();
 s1.setId(1002);
 list.add(s1);
 s1 = new Student();
 s1.setId(1005);
 list.add(s1);
 List<Student> studentList = studentDao.selectStudentSqlFragment(list);
 studentList.forEach( stu -> System.out.println(stu));
}

到此这篇关于MyBatis 详细讲解动态 SQL的使用的文章就介绍到这了,更多相关MyBatis 动态 SQL内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java设计模式之观察者模式详解
这篇文章主要介绍了Java设计模式之观察者模式详解,对象之间的多对一依赖的一种设计方案,被依赖的对象为Subject,依赖的对象为Observer,Subject通知Observer变化,需要的朋友可以参考下
2023-12-12
java中的final关键字详解及实例
这篇文章主要介绍了 java中的final关键字详解及实例的相关资料,需要的朋友可以参考下
2017-03-03
关于eclipse中运行tomcat提示端口被占用的4种解决
这篇文章主要介绍了关于eclipse中运行tomcat提示端口被占用的4种解决，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-01-01
一文掌握Springboot集成RabbitMQ的方法
RabbitMQ是开源的消息队列服务器,实现了AMQP高级消息队列协议标准,AMQP 是一种应用层协议,为面向消息的中间件设计,基于此协议的客户端与消息中间件可传递消息,并不受产品、开发语言等条件的限制,这篇文章主要介绍了Springboot集成RabbitMQ的过程,需要的朋友可以参考下
2024-04-04
Java使用集合实现斗地主分牌完整代码
在斗地主游戏中,通常是将一副牌平均分成3份,每份17张牌,并留3张底牌,我们可以使用集合来实现这一功能,这篇文章主要给大家介绍了关于Java使用集合实现斗地主分牌的相关资料,需要的朋友可以参考下
2024-05-05
在springboot中添加mvc功能的正确姿势讲解
这篇文章主要介绍了在springboot中添加mvc功能的正确姿势，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
springBoot+dubbo+zookeeper实现分布式开发应用的项目实践
本文主要介绍了springBoot+dubbo+zookeeper实现分布式开发应用的项目实践，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-03-03
在Java SE上使用Headless模式的超级指南
这篇文章主要介绍了在Java SE上使用Headless模式的超级指南,文中介绍了Headless模式实际使用的各种技巧,极力推荐!需要的朋友可以参考下
2015-07-07
Java实现赫夫曼树(哈夫曼树)的创建
给定N个权值作为N个叶子结点，构造一棵二叉树，若该树的带权路径长度(WPL)达到最小，称这样的二叉树为最优二叉树，也称为哈夫曼树(Huffman Tree)。这篇文章主要就是为大家介绍如何通过Java实现赫夫曼树，需要的朋友可以参考一下
2021-12-12
java生成json实现隐藏掉关键属性
这篇文章主要介绍了java生成json实现隐藏掉关键属性，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03