上一篇博客的传送门:MyBatis 入门到精通(四)
动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架,你应该能理解根据不同条件拼接 SQL 语句有多痛苦,例如拼接时要确保不能忘记添加必要的空格,还要注意去掉列表最后一个列名的逗号。利用动态 SQL,可以彻底摆脱这种痛苦。
使用动态 SQL 并非一件易事,但借助可用于任何 SQL 映射语句中的强大的动态 SQL 语言,MyBatis 显著地提升了这一特性的易用性。
在 MyBatis 之前的版本中,需要花时间了解大量的元素。借助功能强大的基于 OGNL 的表达式,MyBatis 3 替换了之前的大部分元素,大大精简了元素种类,现在要学习的元素种类比原来的一半还要少。
- if
- choose (when, otherwise)
- trim (where, set)
- foreach
- bind
if 标签
<select id="findAllEmp" resultType="emp">
SELECT * FROM emp
WHERE empstate= 1
<if test="ename != null">
AND ename like #{ename}
</if>
</select>
这条语句提供了可选的查找员工姓名功能。如果不传入 “ename”,那么所有处于 “显示” 状态的 EMP 都会返回;如果传入了 “ename” 参数,那么就会对 “ename” 一列进行模糊查找并返回对应的 EMP 结果。
如果希望通过 “ename” 和 “job” 两个参数进行可选搜索该怎么办呢?首先,我想先将语句名称修改成更名副其实的名称;接下来,只需要加入另一个条件即可。
<select id="findAllEmp" resultType="emp">
SELECT * FROM emp
WHERE empstate= 1
<if test="ename != null">
AND ename like #{ename}
</if>
<if test="job != null">
AND job like #{job}
</if>
</select>
choose、when、otherwise 标签
有时候,我们不想使用所有的条件,而只是想从多个条件中选择一个使用。针对这种情况,MyBatis 提供了 choose 元素,它有点像 Java 中的 switch 语句。
还是上面的例子,但是策略变为:传入了 “ename” 就按 “ename” 查找,传入了 “job” 就按 “job” 查找的情形。若两者都没有传入,就返回工资最高的员工。
<select id="findAllEmp" resultType="emp">
SELECT * FROM emp WHERE empstate = 1
<choose>
<when test="ename != null">
AND ename like #{ename}
</when>
<when test="job != null">
AND job like #{job}
</when>
<otherwise>
order by sal desc limit 1
</otherwise>
</choose>
</select>
trim、where、set 标签
前面几个例子已经合宜地解决了一个臭名昭著的动态 SQL 问题。现在回到之前的 “if” 示例,这次我们将 “empstate = 1” 去掉,想想看会发生什么。
<select id="findAllEmp" resultType="emp">
SELECT * FROM emp
WHERE
<if test="ename != null">
AND ename like #{ename}
</if>
</select>
如果没有匹配的条件会怎么样?最终这条 SQL 会变成这样:
SELECT * FROM emp WHERE
请求这会导致查询失败。这个问题就不能简单地用条件元素来解决。
这个问题是如此的难以解决,以至于解决过的人不会再想碰到这种问题。MyBatis 有一个简单且适合大多数场景的解决办法。而在其他场景中,可以对其进行自定义以符合需求。而这,只需要一处简单的改动:
<select id="findAllEmp" resultType="emp">
SELECT * FROM emp
<where>
<if test="ename != null">
ename like #{ename}
</if>
</where>
</select>
where 元素只会在子元素返回任何内容的情况下才插入 “WHERE” 子句。而且,若子句的开头为 “AND” 或 “OR”,where 元素也会将它们去除。
如果 where 元素与你期望的不太一样,你也可以通过自定义 trim 元素来定制 where 元素的功能。比如,和 where 元素等价的自定义 trim 元素为:
<trim prefix="WHERE" prefixOverrides="AND |OR ">
...
</trim>
prefixOverrides 前缀属性会忽略通过管道符分隔的文本序列,案例中会忽略第一次出现的and 或者 or。
用于动态更新语句的类似解决方案叫做 set。set 元素可以用于动态包含需要更新的列,忽略其它不更新的列。比如:
<update id="updateEmp">
update emp
<set>
<if test="ename != null">ename=#{ename},</if>
<if test="job != null">job=#{job},</if>
<if test="mgr != null">mgr=#{mgr},</if>
<if test="sal != null">sal=#{sal},</if>
</set>
where empNo=#{empNo}
</update>
这个例子中,set 元素会动态地在行首插入 SET 关键字,并会删掉额外的逗号。
来看看与 set 元素等价的自定义 trim 元素吧:
<trim prefix="SET" suffixOverrides=",">
...
</trim>
注意,我们覆盖了后缀值设置,并且自定义了前缀值。
foreach 标签
动态 SQL 的另一个常见使用场景是对集合进行遍历(尤其是在构建 IN 条件语句的时候)。比如:
<select id="findEmp" resultType="emp">
SELECT * FROM emp
WHERE job in
<foreach item="j" index="index" collection="list" open="(" separator="," close=")">
#{j}
</foreach>
</select>
foreach 标签主要有以下属性,说明如下。
- item:表示集合中每一个元素进行迭代时的别名。
- index:指定一个名字,表示在迭代过程中每次迭代到的位置。
- open:表示该语句以什么开始(既然是 in 条件语句,所以必然以(开始)。
- separator:表示在每次进行迭代之间以什么符号作为分隔符(既然是 in 条件语句,所以必然以,作为分隔符)。
- close:表示该语句以什么结束(既然是 in 条件语句,所以必然以)开始)。
- 使用 foreach 标签时,最关键、最容易出错的是 collection 属性,该属性是必选的,但在不同情况下该属性的值是不一样的,主要有以下 3 种情况:
- 如果传入的是单参数且参数类型是一个 List,collection 属性值为 list。
- 如果传入的是单参数且参数类型是一个 array 数组,collection 的属性值为 array。
- 如果传入的参数是多个,需要把它们封装成一个 Map,当然单参数也可以封装成 Map。Map 的 key 是参数名,collection 属性值是传入的 List 或 array 对象在自己封装的 Map 中的 key。
foreach 元素的功能非常强大,它允许你指定一个集合,声明可以在元素体内使用的集合项(item)和索引(index)变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。
bind 标签
bind 元素允许你在 OGNL 表达式以外创建一个变量,并将其绑定到当前的上下文。比如:
<select id="findEmpByEname" resultType="emp">
<bind name="pattern" value="'%' + _parameter.getEname() + '%'" />
SELECT * FROM emp WHERE ename LIKE #{pattern}
</select>
你前面看到的所有 xml 标签都由默认 MyBatis 语言提供,而它由语言驱动 org.apache.ibatis.scripting.xmltags.XmlLanguageDriver(别名为 xml)所提供。
下个章节我们继续讲解 Mybatis 的二级缓存。----MyBatis 入门到精通(六)