Mybatis的動態sql詳解，區別於傳統的sql拼寫

剛用到新框架的時候，總是要熟悉新框架的一些事情

比如Mybatis的動態sql就和之前的那些拼寫sql不同，下面根據網上看的來總結一下：

MyBatis的動態SQL是基於OGNL表達式的，它可以幫助我們方便的在SQL語句中實現某些邏輯。

MyBatis中用於實現動態SQL的元素主要有：

 

• if
• choose（when，otherwise）
• trim
• where
• set
• foreach

if就是簡單的條件判斷，利用if語句我們可以實現某些簡單的條件選擇。先來看如下一個例子：

<select id="dynamicIfTest" parameterType="Blog" resultType="Blog">
    select * from t_blog where 11 = 1
    <if test="title != null">
        and title = #{title}
    </if>
    <if test="content != null">
        and content = #{content}
    </if>
    <if test="owner != null">
        and owner = #{owner}
    </if>
</select>

這條語句的意思非常簡單，如果你提供了title參數，那麼就要滿足title=#{title}，同樣如果你提供了Content和Owner的時候，它們也需要滿足相應的條件，之後就是返回滿足這些條件的所有Blog，這是非常有用的一個功能，以往我們使用其他類型框架或者直接使用JDBC的時候， 如果我們要達到同樣的選擇效果的時候，我們就需要拼SQL語句，這是極其麻煩的，比起來，上述的動態SQL就要簡單多了。

choose元素的作用就相當於JAVA中的switch語句，基本上跟JSTL中的choose的作用和用法是一樣的，通常都是與when和otherwise搭配的。看如下一個例子：

<select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">
    select * from t_blog where 11 = 1
    <choose>
        <when test="title != null">
            and title = #{title}
        </when>
        <when test="content != null">
            and content = #{content}
        </when>
        <otherwise>
            and owner = "owner1"
        </otherwise>
    </choose>
</select>

when元素表示當when中的條件滿足的時候就輸出其中的內容，跟JAVA中的switch效果差不多的是按照條件的順序，當when中有條件滿足的時候，就會跳出choose，即所有的when和otherwise條件中，只有一個會輸出，當所有的我很條件都不滿足的時候就輸出otherwise中的內容。所以上述語句的意思非常簡單， 當title!=null的時候就輸出and titlte = #{title}，不再往下判斷條件，當title爲空且content!=null的時候就輸出and content = #{content}，當所有條件都不滿足的時候就輸出otherwise中的內容。

where語句的作用主要是簡化SQL語句中where中的條件判斷的，先看一個例子，再解釋一下where的好處。

<select id="dynamicWhereTest" parameterType="Blog" resultType="Blog">
    select * from t_blog
    <where>
        <if test="title != null">
            title = #{title}
        </if>
        <if test="content != null">
            and content = #{content}
        </if>
        <if test="owner != null">
            and owner = #{owner}
        </if>
    </where>
</select>

 where元素的作用是會在寫入where元素的地方輸出一個where，另外一個好處是你不需要考慮where元素裏面的條件輸出是什麼樣子的，MyBatis會智能的幫你處理，如果所有的條件都不滿足那麼MyBatis就會查出所有的記錄，如果輸出後是and 開頭的，MyBatis會把第一個and忽略，當然如果是or開頭的，MyBatis也會把它忽略；此外，在where元素中你不需要考慮空格的問題，MyBatis會智能的幫你加上。像上述例子中，如果title=null， 而content != null，那麼輸出的整個語句會是select * from t_blog where content = #{content}，而不是select * from t_blog where and content = #{content}，因爲MyBatis會智能的把首個and 或 or 給忽略。

trim元素的主要功能是可以在自己包含的內容前加上某些前綴，也可以在其後加上某些後綴，與之對應的屬性是prefix和suffix；可以把包含內容的首部某些內容覆蓋，即忽略，也可以把尾部的某些內容覆蓋，對應的屬性是prefixOverrides和suffixOverrides；正因爲trim有這樣的功能，所以我們也可以非常簡單的利用trim來代替where元素的功能，示例代碼如下：

<select id="dynamicTrimTest" parameterType="Blog" resultType="Blog">
    select * from t_blog
    <trim prefix="where" prefixOverrides="and |or">
        <if test="title != null">
            title = #{title}
        </if>
        <if test="content != null">
            and content = #{content}
        </if>
        <if test="owner != null">
            or owner = #{owner}
        </if>
    </trim>
</select>

 

set元素主要是用在更新操作的時候，它的主要功能和where元素其實是差不多的，主要是在包含的語句前輸出一個set，然後如果包含的語句是以逗號結束的話將會把該逗號忽略，如果set包含的內容爲空的話則會出錯。有了set元素我們就可以動態的更新那些修改了的字段。下面是一段示例代碼：

<update id="dynamicSetTest" parameterType="Blog">
    update t_blog
    <set>
        <if test="title != null">
            title = #{title},
        </if>
        <if test="content != null">
            content = #{content},
        </if>
        <if test="owner != null">
            owner = #{owner}
        </if>
    </set>
    where id = #{id}
</update>

 上述示例代碼中，如果set中一個條件都不滿足，即set中包含的內容爲空的時候就會報錯。

foreach的主要用在構建in條件中，它可以在SQL語句中進行迭代一個集合。foreach元素的屬性主要有item，index，collection，open，separator，close。item表示集合中每一個元素進行迭代時的別名，index指定一個名字，用於表示在迭代過程中，每次迭代到的位置，open表示該語句以什麼開始，separator表示在每次進行迭代之間以什麼符號作爲分隔符，close表示以什麼結束，在使用foreach的時候最關鍵的也是最容易出錯的就是collection屬性，該屬性是必須指定的，但是在不同情況下，該屬性的值是不一樣的，主要有一下3種情況：

1. 如果傳入的是單參數且參數類型是一個List的時候，collection屬性值爲list
2. 如果傳入的是單參數且參數類型是一個array數組的時候，collection的屬性值爲array
3. 如果傳入的參數是多個的時候，我們就需要把它們封裝成一個Map了，當然單參數也可以封裝成map，實際上如果你在傳入參數的時候，在MyBatis裏面也是會把它封裝成一個Map的，map的key就是參數名，所以這個時候collection屬性值就是傳入的List或array對象在自己封裝的map裏面的key

下面分別來看看上述三種情況的示例代碼：

1.單參數List的類型：

<select id="dynamicForeachTest" resultType="Blog">
    select * from t_blog where id in
    <foreach collection="list" index="index" item="item" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

 上述collection的值爲list，對應的Mapper是這樣的

public List<Blog> dynamicForeachTest(List<Integer> ids);

 測試代碼：

@Test
public void dynamicForeachTest() {
    SqlSession session = Util.getSqlSessionFactory().openSession();
    BlogMapper blogMapper = session.getMapper(BlogMapper.class);
    List<Integer> ids = new ArrayList<Integer>();
    ids.add(1);
    ids.add(3);
    ids.add(6);
    List<Blog> blogs = blogMapper.dynamicForeachTest(ids);
    for (Blog blog : blogs)
        System.out.println(blog);
    session.close();
}

 

2.單參數array數組的類型：

<select id="dynamicForeach2Test" resultType="Blog">
    select * from t_blog where id in
    <foreach collection="array" index="index" item="item" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

 上述collection爲array，對應的Mapper代碼：

public List<Blog> dynamicForeach2Test(int[] ids);

 對應的測試代碼：

@Test
public void dynamicForeach2Test() {
    SqlSession session = Util.getSqlSessionFactory().openSession();
    BlogMapper blogMapper = session.getMapper(BlogMapper.class);
    int[] ids = new int[] {1,3,6,9};
    List<Blog> blogs = blogMapper.dynamicForeach2Test(ids);
    for (Blog blog : blogs)
        System.out.println(blog);
    session.close();
}

 

3.自己把參數封裝成Map的類型

<select id="dynamicForeach3Test" resultType="Blog">
    select * from t_blog where title like "%"#{title}"%" and id in
    <foreach collection="ids" index="index" item="item" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

上述collection的值爲ids，是傳入的參數Map的key，對應的Mapper代碼：

public List<Blog> dynamicForeach3Test(Map<String, Object> params);

  對應測試代碼：

@Test
public void dynamicForeach3Test() {
    SqlSession session = Util.getSqlSessionFactory().openSession();
    BlogMapper blogMapper = session.getMapper(BlogMapper.class);
    final List<Integer> ids = new ArrayList<Integer>();
    ids.add(1);
    ids.add(2);
    ids.add(3);
    ids.add(6);
    ids.add(7);
    ids.add(9);
    Map<String, Object> params = new HashMap<String, Object>();
    params.put("ids", ids);
    params.put("title", "中國");
    List<Blog> blogs = blogMapper.dynamicForeach3Test(params);
    for (Blog blog : blogs)
        System.out.println(blog);
    session.close();
}

 來源博客：http://haohaoxuexi.iteye.com/blog/1333271