MyBatis快速入门（16）动态SQL

Bertha 。 2022-12-09 03:16 156阅读 0赞

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

虽然在以前使用动态 SQL 并非一件易事，但正是 MyBatis 提供了可以被用在任意 SQL 映射语句中的强大的动态 SQL 语言得以改进这种情形。

动态 SQL 元素和 JSTL 或基于类似 XML 的文本处理器相似。在 MyBatis 之前的版本中，有很多元素需要花时间了解。MyBatis 3 大大精简了元素种类，现在只需学习原来一半的元素便可。MyBatis 采用功能强大的基于 OGNL 的表达式来淘汰其它大部分元素。常用的动态SQL标签如下：

> if
> 
> choose (when, otherwise)
> 
> trim (where, set)
> 
> foreach

# if标签 #

动态 SQL 经常要做的事情是根据条件判断是否包含 where 子句的一部分。比如：

![4d0fa652157dbcaea984da0866bf2226.png][]

这条语句提供了一种可选的查找文本功能。如果没有传入“name”，那么只返回符合id条件的user；反之若传入了“name”，那么就会对“name”一列进行查找并返回 user 结果。另外，很多时候查询字符串会使用模糊查询，因此要是用like，还要给参数两边加上%进行模糊匹配，加的方式根据数据库拼接字符串的特性来判断，比如mysql数据库：

> and name like concat('%',\#\{name\},'%')

或者oracle数据库：

> and name like '%'||\#\{name\}||'%'

等等，按照数据库的语法来使用即可。如果有多个参数不固定，写多个if标签就可以：

![73839fdf678071a0d8af580455300117.png][]

注意，age不是字符串，因此不用判断 age!=''，这个条件。

# choose, when, otherwise标签 #

有时我们不想应用到所有的条件语句，而只想从中择其一项。针对这种情况，MyBatis 提供了 choose 元素，它有点像 Java 中的 switch 语句。

还是上面的例子，但是这次变为提供了“name”就按“name”查找，提供了“id”就按“id”查找的情形，若两者都没有提供，就返回所有符合条件的 user。

![e944f7b333b494b8853e92fa2c34dc49.png][]

从语句中可以看出，id的条件在上面，name的条件在下面，如果id先满足条件，那么后面的name就不用判断了，如果id不满足但是name条件满足，就会查询符合name条件的记录。如果都不满足，就会变成 where 1=1 and 2=2 ，这样的结果就是查询所有记录了。这种结构就类似与Java中的switch或者 if...else if这样的逻辑语句。

# trim, where, set标签 #

前面几个例子已经合宜地解决了一个臭名昭著的动态 SQL 问题。现在回到“if”示例，我们为了拼接语句，开头都写了一个硬条件，1=1，如果不写会怎么样？可以想象当条件都不满足的时候，SQL语句最终会变成这样：

> select id,name from t\_user where

这会导致查询失败和报错。这个问题不能简单地用条件句式来解决，如果你也曾经被迫这样写过，那么你很可能从此以后都不会再写出这种语句了。MyBatis 有一个简单的处理，这在 90% 的情况下都会有用。而在不能使用的地方，你可以自定义处理方式来令其正常工作。一处简单的修改就能达到目的：

![bb90b72dbd7a5967c435674c7d96d412.png][]

把where单词去掉，换成<where>标签，然后里面的条件就可以恣无忌惮的写了，如果一个条件都不满足，那么SQL最后的结果就是连where关键字都没有了，如果第一个条件满足，那么第一个条件带着and也会智能的去掉and。

如果 *where* 元素没有按正常套路出牌，我们可以通过自定义 trim 元素来定制 *where* 元素的功能。比如，和 *where* 元素等价的自定义 trim 元素。**trim**标签一般用于去除sql语句中多余的and关键字，逗号，或者给sql语句前拼接 “where“、“set“以及“values(“ 等前缀，或者添加“)“等后缀，可用于选择性插入、更新、删除或者条件查询等操作。

因此上面的写法也可以换一种等价的写法：

![ce35109f84ba431be4647ff5fa5f6f56.png][]

*prefixOverrides* 属性会忽略通过管道分隔的文本序列（注意此例中and和or后面的空格也是必要的）。它的作用是移除所有指定在 *prefixOverrides* 属性中的内容，并且插入 *prefix* 属性中指定的内容。

类似的用于动态更新语句的解决方案叫做 *set*。*set* 元素可以用于动态包含需要更新的列，而舍去其它的。比如：

![0beed5e951fc71732b19e325fa1e2044.png][]

这是一个update语句，set标签中包含的其实就是SQL中的set语句，这里，*set* 元素会动态前置 SET 关键字，同时也会删掉无关的逗号，因为用了条件语句之后很可能就会在生成的 SQL 语句的后面留下这些逗号。（因为用的是“if”元素，若最后一个“if”没有匹配上而前面的匹配上，SQL 语句的最后就会有一个逗号遗留）。

同时，set标签也可以使用trim标签替换，写法如下：

![d0ef8f13e9c33b49fdf4c66caf08efa8.png][]

注意逗号在每个判断语句的后面，所以使用了suffixOverrides属性。同时，我们可以想象，有了上面这些动态的判断标签，增加，更新，和删除语句可以写的更加具有适应性，来看一个新增：

![f1251f1ef04861cdb0887a43eead53c3.png][]

上面这个语句基本上能满足单体的所有新增情况。其它的更新和删除大家可以试着写一下。

# foreach标签 #

动态 SQL 的另外一个常用的操作需求是对一个集合进行遍历，前面也简单接触过，通常是在构建 IN 条件语句的时候。比如：

![b8699475910339836c42d2b194a456f3.png][]

*foreach* 元素的功能非常强大，它允许你指定一个集合，声明可以在元素体内使用的集合项（item）和索引（index）变量。它也允许你指定开头与结尾的字符串以及在迭代结果之间放置分隔符。这个元素是很智能的，因此它不会偶然地附加多余的分隔符。

> 注意： 你可以将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象传递给 *foreach* 作为集合参数。当使用可迭代对象或者数组时，index 是当前迭代的次数，item 的值是本次迭代获取的元素。当使用 Map 对象（或者 Map.Entry 对象的集合）时，index 是键，item 是值。

代码地址：[https://gitee.com/blueses/mybatis-demo][https_gitee.com_blueses_mybatis-demo]  08

[4d0fa652157dbcaea984da0866bf2226.png]: /images/20221123/7a8ce18bddce4dc1987807a97f734888.png
[73839fdf678071a0d8af580455300117.png]: /images/20221123/6c45b3cb37994b45a62051e15304ffeb.png
[e944f7b333b494b8853e92fa2c34dc49.png]: /images/20221123/130290284eaf4c1f90a492544085c013.png
[bb90b72dbd7a5967c435674c7d96d412.png]: /images/20221123/a21721f3b4e245bf9001b0a08bbf92e2.png
[ce35109f84ba431be4647ff5fa5f6f56.png]: /images/20221123/abcb905b0ef7495a835dd898949c08a1.png
[0beed5e951fc71732b19e325fa1e2044.png]: /images/20221123/156db0d8800f4a6194f66f958f0143b2.png
[d0ef8f13e9c33b49fdf4c66caf08efa8.png]: /images/20221123/4ac1d7436ac149a5b876fb96fb8241e3.png
[f1251f1ef04861cdb0887a43eead53c3.png]: /images/20221123/60ce365179b645fd8e821522d5276840.png
[b8699475910339836c42d2b194a456f3.png]: /images/20221123/ec5d250c63574906819e7748a9c2fda7.png
[https_gitee.com_blueses_mybatis-demo]: https://gitee.com/blueses/mybatis-demo