所谓动态SQL,本质还是SQL语句,只是可以在SQL层面去执行一个逻辑代码。说白了就是在拼接SQL语句,我们只要确保SQL语句的正确性,按照SQL的格式去排列组合,便可以了。
听起来这么牛掰,实现起来指定是有一定难度的。动态SQL要根据不同的条件生成不同的SQL语句。而利用MyBatis动态SQL语句这一特性,便可彻底摆脱这种痛苦。
可分为四类动态标签:
- if
- choose (when, otherwise)
- trim (where, set)
- foreach
文章目录
- if
- choose
- where
- set
- foreach
- SQL片段
动态 SQL元素和JSTL或基于类似XML的文本处理器相似。
在MyBatis之前的版本中,有很多元素需要花时间了解。而MyBatis3大大精简了元素种类,现在只需学习原来一半的元素便可。
MyBatis采用功能强大的基于OGNL的表达式来淘汰其它大部分元素。
if
使用动态 SQL 最常见情景是根据条件包含 where 子句的一部分。
例如:
<select id="findActiveBlogWithTitleLike"
resultType="Blog">
SELECT * FROM BLOG
WHERE state = ‘ACTIVE’
<if test="title != null">
AND title like #{title}
</if>
</select>
这条语句提供了可选的查找文本功能。
如果不传入 “title”,那么所有处于 “ACTIVE” 状态的 BLOG 都会返回;如果传入了 “title” 参数,那么就会对 “title” 一列进行模糊查找并返回对应的 BLOG 结果。
如果有多个条件需要判断,仍可以通过在< if >标签中添加属性来达到目的。
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG WHERE state = ‘ACTIVE’
<if test="title != null">
AND title like #{title}
</if>
<if test="author != null and author.name != null">
AND author_name like #{author.name}
</if>
</select>
非常直观且方便。
choose
而有些时候,我们不想让所有的判断条件都生效,此时,便可使用MyBatis提供的< choose >标签来进行实现。
还是上述的例子,但是策略变为:传入了 “title” 就按 “title” 查找,传入了 “author” 就按 “author” 查找的情形。
若两者都没有传入,就返回标记为 featured 的 BLOG
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG WHERE state = ‘ACTIVE’
<choose>
<when test="title != null">
AND title like #{title}
</when>
<when test="author != null and author.name != null">
AND author_name like #{author.name}
</when>
<otherwise>
AND featured = 1
</otherwise>
</choose>
</select>
where
以上两条标签,已经足以解决大多数令人头疼的问题。而还有别的解决方案用以解决更加特殊的问题。
回到之前的 “if” 示例,这次我们将 “state = ‘ACTIVE’” 设置成动态条件:
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG
WHERE
<if test="state != null">
state = #{state}
</if>
<if test="title != null">
AND title like #{title}
</if>
<if test="author != null and author.name != null">
AND author_name like #{author.name}
</if>
</select>
若没有匹配条件,最终的SQL语句将会变成:
SELECT * FROM BLOG
WHERE
如你所见,它会导致查询失败。那匹配的只是第二个条件呢?
SELECT * FROM BLOG
WHERE
AND title like ‘someTitle’
它变成了这样,同样会导致查询失败。
这个问题不能通过简单的用条件元素来解决,恶心程度可见一斑。
MyBatis 有一个简单且适合大多数场景的解决办法。而在其他场景中,可根据需求来进行自定义。
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG
<where>
<if test="state != null">
state = #{state}
</if>
<if test="title != null">
AND title like #{title}
</if>
<if test="author != null and author.name != null">
AND author_name like #{author.name}
</if>
</where>
</select>
是的,使用 < where >元素。where元素只会在子集有返回值的情况下插入“where”语句。若子句的开头为“and” 或 “or”,where元素将自动删去。
set
用于动态更新语句的类似解决方案叫做 set。
set 元素可以用于动态包含需要更新的列,而忽略其它不需要更新的列。
举个栗子:
<update id="updateAuthorIfNecessary">
update Author
<set>
<if test="username != null">username=#{username},</if>
<if test="password != null">password=#{password},</if>
<if test="email != null">email=#{email},</if>
<if test="bio != null">bio=#{bio}</if>
</set>
where id=#{id}
</update>
上述SQL语句中,set元素会动态地在行首插入 set 关键字,并智能的删去多余的逗号。
foreach
动态 SQL 的另一个常见使用场景是对集合进行遍历(尤其是在构建 IN 条件语句的时候)
实例:
foreach 元素的功能非常强大,它允许你指定一个集合,声明可以在元素体内使用的集合项(item)和索引(index)变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。这个元素也不会错误地添加多余的分隔符
好家伙,牛炸了简直是。
不仅如此,还可以将任何可迭代对象(如 List、Set 等)、Map 对象或者数组对象作为集合参数传递给 foreach。
当使用可迭代对象或者数组时,index 是当前迭代的序号,item 的值是本次迭代获取到的元素。当使用 Map 对象(或者 Map.Entry 对象的集合)时,index 是键,item 是值。
简直是妙蛙种子吃着妙脆角进了米奇妙妙屋,妙到家了。
SQL片段
除过上述牛逼哄哄吊炸天的元素外,还有一个功能一般优化却不可缺少的元素:SQL片段。
它的作用很简单,支持将一部分的SQL代码抽取出来,方便复用。
实现流程:
- 使用SQL标签抽取公共部分
- 在需要使用的地方使用 Include 标签引用即可。
注意事项:
- 最好基于单表来定义SQL片段
- 在SQL片段中不能存在 where 元素