MyBatis动态SQL完整版 (转)
GechangLiu 2014-03-27
MyBatis的一个强大的特性之一通常是它的动态SQL能力。如果你有使用JDBC或其他相似框架的经验,你就明白条件地串联SQL字符串在一起是多么的痛苦,确保不能忘了空格或在列表的最后省略逗号。动态SQL可以彻底处理这种痛苦。，MyBatis的动态SQL是基于OGNL表达式的，它可以帮助我们方便的在SQL语句中实现某些逻辑。从而拼接成相应的sql语句。
1、if
在动态SQL中所做的最通用的事情是包含部分where字句的条件。比如:
[html]viewplaincopy
<selectid="findActiveBlogWithTitleLike"parameterType="Blog"
resultType="Blog">
SELECT*FROMBLOG
WHEREstate="ACTIVE"
<iftest="title!null">
ANDtitlelike#{title}
</if>
</select>
这条语句会提供一个可选的文本查找功能。如果你没有传递title,那么所有激活的博客都会被返回。但是如果你传递了title,那么就会查找相近的title(对于敏锐的检索,这中情况下你的参数值需要包含任意的遮掩或通配符)的博客。假若我们想可选地搜索title和author呢?首先,要改变语句的名称让它有意义。然后简单加入另外的一个条件。
[html]viewplaincopy
<selectid="findActiveBlogLike"parameterType="Blog"resultType="Blog">
SELECT*FROMBLOGWHEREstate=„ACTIVE‟
<iftest="title!null">
ANDtitlelike#{title}
</if>
<iftest="author!nullandauthor.name!=null">
ANDtitlelike#{author.name}
</if>
</select>
2、choose,when,otherwise
有时我们不想应用所有的条件,相反我们想选择很多情况下的一种。Java中的switch和语句相似,MyBatis提供choose元素。我们使用上面的示例,但是现在我们来搜索当title提供时仅有title条件,当author提供时仅有author条件。如果二者都没提供,只返回featuredblogs(也许是由管理员策略地选择的结果列表,而不是返回大量没有意义的,随机的博客结果列表)。
[html]viewplaincopy
<selectid="findActiveBlogLike"parameterType="Blog"resultType="Blog">
SELECT*FROMBLOGWHEREstate="ACTIVE"
<choose>
<whentest="title!null">
ANDtitlelike#{title}
</when>
<whentest="author!nullandauthor.name!=null">
ANDtitlelike#{author.name}
</when>
<otherwise>
ANDfeatured=1
</otherwise>
</choose>
</select>
3、trim,where,set
前面的例子已经方便地处理了一个臭名昭著的动态SQL问题。要考虑我们回到“if”示例后会发生什么,但是这次我们将“ACTIVE=1”也设置成动态的条件。
[java]viewplaincopy
<selectid="findActiveBlogLike"parameterType="Blog"resultType="Blog">
SELECT*FROMBLOG
WHERE
<iftest="state!null">
state=#{state}
</if>
<iftest="title!null">
ANDtitlelike#{title}
</if>
<iftest="author!nullandauthor.name!=null">
ANDtitlelike#{author.name}
</if>
</select>
如果这些条件都没有匹配上将会发生什么?这条SQL结束时就会成这样:
SELECT*FROMBLOGWHERE
这会导致查询失败。如果仅仅第二个条件匹配是什么样的?这条SQL结束时就会是这样:
SELECT*FROMBLOGWHEREANDtitlelike„someTitle‟
这个查询也会失败。这个问题不能简单的用条件来解决,或许你会说可以这样写：
[html]viewplaincopy
<selectid="findActiveBlogLike"parameterType="Blog"resultType="Blog">
SELECT*FROMBLOGWHERE1=1
<iftest="state!null">
andstate=#{state}
</if>
<iftest="title!null">
ANDtitlelike#{title}
</if>
<iftest="author!nullandauthor.name!=null">
ANDtitlelike#{author.name}
</if>
</select>
MyBatis有一个简单的处理,这在90%的情况下都会有用。而在不能使用的地方,你可以自定义处理方式。加上一个简单的改变,所有事情都会顺利进行:
[html]viewplaincopy
<selectid="findActiveBlogLike"parameterType="Blog"resultType="Blog">
SELECT*FROMBLOG
<where>
<iftest="state!null">
state=#{state}
</if>
<iftest="title!null">
ANDtitlelike#{title}
</if>
<iftest="author!nullandauthor.name!=null">
ANDtitlelike#{author.name}
</if>
</where>
</select>
where元素知道如果由被包含的标记返回任意内容,就仅仅插入“WHERE”。而且,如果以“AND”或“OR”开头的内容,那么就会跳过WHERE不插入。如果where元素没有做出你想要的,你可以使用trim元素来自定义。比如,和where元素相等的trim元素是:
<trimprefix="WHERE"prefixOverrides="AND|OR">
...
</trim>
trim元素的主要功能是可以在自己包含的内容前加上某些前缀，也可以在其后加上某些后缀，与之对应的属性是prefix和suffix；可以把包含内容的首部某些内容覆盖，即忽略，也可以把尾部的某些内容覆盖，对应的属性是prefixOverrides和suffixOverrides；正因为trim有这样的功能，所以我们也可以非常简单的利用trim来代替where元素的功能，例如：
[html]viewplaincopy
<selectid="test"parameterType="map"resultType="dept">
select*fromscott.Dept
<trimprefix="where"prefixOverrides="and|or"suffixOverrides=",">
<iftest="startId!=null">
<![CDATA[anddeptno<=#{startId}]]>
</if>
<iftest="endId!=null">
<![CDATA[ordeptno>=#{endId},]]>
</if>
</trim>
</select>
或者用于更新
[java]viewplaincopy
<updateid="updateDept"parameterType="dept">
updatescott.dept
<trimprefix="set"suffixOverrides=",">
<choose>
<whentest="dname!=null">
dname=#{dname},
</when>
<otherwise>
dname='123',
</otherwise>
</choose>
<iftest="loc!=null">
loc=#{loc},
</if>
</trim>
wheredeptno=#{deptno}
</update>
set元素可以被用于动态包含更新的列,而不包含不需更新的。比如:
[html]viewplaincopy
<updateid="updateAuthorIfNecessary"parameterType="domain.blog.Author">
updateAuthor
<set>
<iftest="username!=null">username=#{username},</if>
<iftest="password!=null">password=#{password},</if>
<iftest="email!=null">email=#{email},</if>
<iftest="bio!=null">bio=#{bio}</if>
</set>
whereid=#{id}
</update>
这里,set元素会动态前置SET关键字,而且也会消除任意无关的逗号,那也许在应用条件之后来跟踪定义的值。如果你对和这相等的trim元素好奇,它看起来就是这样的:
<trimprefix="SET"suffixOverrides=",">
...
</trim>
注意这种情况下我们覆盖一个后缀,而同时也附加前缀。
4、foreach
另外一个动态SQL通用的必要操作是迭代一个集合,通常是构建在IN条件中的。比如:
[java]viewplaincopy
<selectid="selectPostIn"resultType="domain.blog.Post">
SELECT*FROMPOSTPWHEREIDin
<foreachitem="item"index="index"collection="list"open="("
separator=","close=")">
#{item}
</foreach>
</select>
foreach元素是非常强大的,它允许你指定一个集合,声明集合项和索引变量,它们可以用在元素体内。它也允许你指定开放和关闭的字符串,在迭代之间放置分隔符。这个元素是很智能的,它不会偶然地附加多余的分隔符。
注意:你可以传递一个List实例或者数组作为参数对象传给MyBatis。当你这么做的时候,MyBatis会自动将它包装在一个Map中,用名称作为键。List实例将会以“list”作为键,而数组实例将会以“array”作为键。
