动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架,你应该能理解根据不同条件拼接 SQL 语句有多痛苦,例如拼接时要确保不能忘记添加必要的空格,还要注意去掉列表最后一个列名的逗号。利用动态 SQL,可以彻底摆脱这种痛苦。
Mybatis 3 要学习的元素有以下几种:
- if
- choose (when, otherwise)
- trim (where, set)
- foreach
if
使用动态 SQL 最常见情景是根据条件包含 where 子句的一部分。比如:
<select id="getBlogList" parameterType="map" resultType="Blog">
select * from blog
<where>
<if test="title != null">
title like #{title}
</if>
<if test="author != null">
and author like #{author}
</if>
</where>
</select>
这条语句提供了可选的查找文本功能。如果不传入“title” 和 “author”,那么所有的 BLOG 都会返回;如果传入了 “title” 或者 “author” 参数,那么就会对对应的一列进行模糊查找并返回对应的 BLOG 结果(细心的读者可能会发现,“title” 和 “author” 的参数值需要包含查找掩码或通配符字符)。
请注意我们还使用了where元素
where 元素只会在子元素返回任何内容的情况下才插入 “WHERE” 子句。而且,若子句的开头为 “AND” 或 “OR”,where 元素也会将它们去除。
choose、when、otherwise
有时候不想使用所有的条件,而只是想从多个条件中选择一个使用。针对这种情况,MyBatis 提供了 choose 元素,它有点像 Java 中的 switch 语句。
还是上面的例子,但是策略变为:传入了 “title” 就按 “title” 查找,传入了 “author” 就按 “author” 查找的情形。若两者都没有传入,就返回view的值大于50的 BLOG
<select id="getBlogListByChoose" parameterType="map" resultType="Blog">
select * from blog
<where>
<choose>
<when test="title != null">
title like #{title}
</when>
<when test="author != null">
author like #{author}
</when>
<otherwise>
views > 50
</otherwise>
</choose>
</where>
</select>
请注意我们仍然使用了where元素, 如果不用where则是下面的样子:
<select id="getBlogListByChoose" parameterType="map" resultType="Blog">
select * from blog where
<choose>
<when test="title != null">
title like #{title}
</when>
<when test="author != null">
author like #{author}
</when>
<otherwise>
views > 50
</otherwise>
</choose>
</select>
trim、where、set
前面几个例子已经方便地解决了一个臭名昭著的动态 SQL 问题。现在回到之前的 “if” 示例,如果我们不用where
<select id="getBlogList" parameterType="map" resultType="Blog">
select * from blog where
<if test="title != null">
title like #{title}
</if>
<if test="author != null">
and author like #{author}
</if>
</select>
如果没有匹配的条件会怎么样?最终这条 SQL 会变成这样:
select * from blog where
这会导致查询失败。如果匹配的只是第二个条件又会怎样?这条 SQL 会是这样:
select * from blog where and author like ?
这个查询也会失败。这个问题不能简单地用条件元素来解决。
where 元素只会在子元素返回任何内容的情况下才插入 “WHERE” 子句。而且,若子句的开头为 “AND” 或 “OR”,where 元素也会将它们去除。
如果 where 元素与你期望的不太一样,你也可以通过自定义 trim 元素来定制 where 元素的功能。比如,和 where 元素等价的自定义 trim 元素为:
<trim prefix="WHERE" prefixOverrides="AND |OR ">
...
</trim>
prefixOverrides 属性会忽略通过管道符分隔的文本序列(注意此例中的空格是必要的)。上述例子会移除所有 prefixOverrides 属性中指定的内容,并且插入 prefix 属性中指定的内容。
用于动态更新语句的类似解决方案叫做 set。set 元素可以用于动态包含需要更新的列,忽略其它不更新的列。比如:
<update id="updateBlog" parameterType="map" >
update blog
<set>
<if test="title != null">
title = #{title},
</if>
<if test="author != null">
author = #{author},
</if>
</set>
where id = #{id}
</update>
这个例子中,set 元素会动态地在行首插入 SET 关键字,并会删掉额外的逗号(这些逗号是在使用条件语句给列赋值时引入的)。
与 set 元素等价的自定义 trim 元素如下:
<trim prefix="SET" suffixOverrides=",">
...
</trim>
注意,我们覆盖了后缀值设置,并且自定义了前缀值。
foreach
foreach常用在对集合进行遍历(尤其是在构建 IN 条件语句的时候)。比如:
<select id="getBlogListById" parameterType="map" resultType="Blog">
select * from blog
<where>
<foreach collection="ids" item="id" open="id in (" separator="," close=")">
#{id}
</foreach>
</where>
</select>
foreach 允许你指定一个集合,声明可以在元素体内使用的集合项(item)和索引(index)变量。也允许指定开头与结尾的字符串以及集合项迭代之间的分隔符。这个元素不会错误地添加多余的分隔符
提示 你可以将任何可迭代对象(如 List、Set 等)、Map 对象或者数组对象作为集合参数传递给 foreach。当使用可迭代对象或者数组时,index 是当前迭代的序号,item 的值是本次迭代获取到的元素。当使用 Map 对象(或者 Map.Entry 对象的集合)时,index 是键,item 是值。