mybatis的動態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);

java測試代碼

    @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);  

java測試代碼

    @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();  
    }  

基於3.3.1版本驗證的新特性

 本文是基於Mybatis 3.0.6版本所寫，筆者最近在查看新版Mybatis（3.3.1）時發現其對動態SQL的支持較之前的3.0.6版本的區別不大，基本一致，但筆者仍是發現有如下新特性：

一、foreach標籤遍歷的集合元素類型是Map.Entry類型時，index屬性指定的變量表明對應的Map.Entry的key，item屬性指定的變量表明對應的Map.Entry的value。此時若是對應的集合是Map.entrySet，則對應的collection屬性用collection。foreach在進行遍歷的時候若是傳入的參數是List類型，則其collection屬性的值能夠是list或collection，但若是傳入的參數是Set類型，則collection屬性的值只能用collection。

    <select id="dynamicForeachTest" resultType="Blog">  
        select * from t_blog where id in  
        <!-- 遍歷的對象是Map.Entry時，index表明對應的key，item表明對應的value -->  
        <foreach collection="collection" index="key" item="value" open="(" separator="," close=")">  
            #{key}, #{value}  
        </foreach>  
    </select>  

 其對應的接口方法大概是以下這樣：

public List<Blog> dynamicForeachTest(Set<Map.Entry<Integer, Integer>> ids); 

二、bind標籤，動態SQL中已經包含了這樣一個新的標籤，它的功能是在當前OGNL上下文中建立一個變量並綁定一個值。有了它之後咱們之前的模糊查詢就能夠改爲這個樣子：

 <select id="fuzzyQuery" resultType="Blog" parameterType="java.lang.String">    
    <!-- bind標籤用於建立新的變量 -->  
<bind name="titleLike" value="'%'+_parameter+'%'"/>  
      select * from t_blog where title like #{titleLike}    
  </select>