MyBatis3动态sql

摘自：曾令祝：《MyBatis 3 用户指南中文版》​​​​​​​。MyBatis 最强大的特性之一是它的动态语句功能。如果你以前使用 JDBC 或者类似的框架，你就会明白把 SQL 语句条件连接在一起是多么的痛苦，一点都不能疏忽空格和逗号等。动态语句完全能解决这些烦恼。 

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

if

动态 SQL 中最常做的事情就是用条件地包含一个 where 子句。比如：  

<select id=”findActiveBlogWithTitleLike” parameterType=”Blog” resultType=”Blog”>
    SELECT * FROM BLOG WHERE state = ‘ACTIVE’
    <if test=”title !=n ull”> AND title like #{title}
    </if>
</select>

这条语句提供一个带功能性的可选的文字。如果你没有传入标题，那么所以的博客都会被返回，如果你传入了一个标题，那就会寻找相似的标题。

如果我们想要可选地使用标题或者作者查询怎么办？首先，我把语句的名称稍稍改一下，使得看起来更直观。然后简单地加上另外一个条件。

<select id=”findActiveBlogLike” parameterType=”Blog” resultType=”Blog”>
    SELECT * FROM BLOG WHERE state = ‘ACTIVE’
    <if test=”title !=n ull”>
        AND title like #{title}
    </if>
    <if test=”author !=n ull and author.name !=n ull”>
        AND title like #{author.name}
    </if>
</select>

 choose, when, otherwise

有时候我们并不想应用所有的条件，而只是想从多个选项中选择一个。类似于 Java 的 switch 语句，MyBatis 提供了 choose 元素。

让我继续拿上面的例子来举例，只是现在我们只搜索有查询标题的，或者只搜索有查询作者的。如果都没有提交，则只选有特性的（比如说是管理员加精的或者是置顶的）。

<select id=”findActiveBlogLike” parameterType=”Blog” resultType=”Blog”> SELECT * FROM BLOG WHERE state = ‘ACTIVE’
    <choose>
        <when test=”title !=n ull”> AND title like #{title}
        </when>
        <when test=”author !=n ull and author.name !=n ull”>
            AND title like #{author.name}
        </when>
        <otherwise>
            AND featured = 1
        </otherwise>
    </choose>
</select>

trim, where, set

上面的示例已经围绕烦琐的动态 SQL 发出挑战。考虑一下我们上面提到的‘if’的例子中，如果现在我们把‘ACTIVE=1’也做为条件，会发生什么情况。

<select id=”findActiveBlogLike” parameterType=”Blog” resultType=”Blog”> SELECT * FROM BLOG WHERE
    <if test=”state !=n ull”> state = #{state}
    </if>
    <if test=”title !=n ull”>
        AND title like #{title}
    </if>
    <if test=”author !=n ull and author.name !=n ull”>
        AND title like #{author.name}
    </if>
</select>

如果我们一个条件都不给出，会怎么样？语句可能会变成这个样子：

SELECT * FROM BLOG

WHERE

这会很惨。或者如果我们仅仅只获得了第二个条件，语句又会变成这样：

SELECT * FROM BLOG

WHERE

AND title like ‘someTitle’

同样会很糟糕。这个问题仅用条件很难简单地解决，如果你已经这么写了，那你可能以后永远都不想犯这样的错了。

MyBatis 有个简单的方案就能解决这里面 90%的问题。如果 where 没有出现的时候，你可以自定一个。稍稍修改一下，就能完全解决：

<select id=”findActiveBlogLike” parameterType=”Blog” resultType=”Blog”>
    SELECT * FROM BLOG
    <where>
        <if test=”state !=n ull”> state = #{state}
        </if>
        <if test=”title !=n ull”> AND title like #{title}
        </if>
        <if test=”author !=n ull and author.name !=n ull”>
            AND title like #{author.name}
        </if>
    </where>
</select>

这个“where”元素会知道如果它包含的标签中有返回值的话，它就插入一个‘where’。此外，如果标签返回的内容是以 AND 或 OR 开头的，则它会剔除掉。

如果 where 元素并没有完全按你想要的那样，那你也可以使用 trim 元素自定义它。下面的 trim 也相同于 where：

<trim prefix="WHERE" prefixOverrides="AND |OR ">
…
</trim>

overrides 元素使用一个管理分隔符组成的文字来进行覆写，空白符也是不能忽略的。这样的结果是移出了所有指定在 overrides 里的字符，使用 with 属性里的字符来覆写。

在动态 update 语句里相似的情形叫做 set。这个 set 元素被用做动态囊括列名来更新，而忽略其它的。比如：

<update id="updateAuthorIfNecessary" parameterType="domain.blog.Author">
    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>

set 元素将动态的配置 SET 关键字，也用来剔除追加到条件末尾的任何不相关的逗号。

如果你非常想知道，等同的 trim 怎么写，是这样：

<trim prefix="SET" suffixOverrides=",">
…
</trim>

注意，我们只写了一个前缀，同样我们也可以追加一个后缀。

 foreach

另外一个对于动态 SQL 非常必须的，主是要迭代一个集合，通常是用于 IN 条件。比如说：

<select id="selectPostIn" resultType="domain.blog.Post">
    SELECT * FROM POST P WHERE ID in
    <foreach item="item" index="index" collection="list" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

foreach 元素非常强大，允许你指定一个集合，申明一个项和一个索引变量，用在这个元素的方法体内。也允许你指定开始和结束的字符，也可以在两个迭代器之间加入一个分隔符。它的智能之处在于它不会偶尔追加额外的分隔符。

注意：你可以传入一个 List 实例或者一个数组给 MyBatis 作为一个参数对象。如果你这么做，MyBatis 会自动将它包装成一个 Map，使用它的名称做为 key。List 实例将使用“list”做为键，数组实例以“array”