Mybatis中xml的動態sql實現示例

Posted on by

動態SQL簡介

動態 SQL 是 MyBatis 的強大特性之一。

如果你使用過 JDBC 或其它類似的框架，你應該能理解根據不同條件拼接 SQL 語句有多痛苦，例如拼接時要確保不能忘記添加必要的空格，還要註意去掉列表最後一個列名的逗號。利用動態 SQL，可以徹底擺脫這種痛苦。

使用動態 SQL 並非一件易事，但借助可用於任何 SQL 映射語句中的強大的動態 SQL 語言，MyBatis 顯著地提升瞭這一特性的易用性。

一、#{}與${}區別#{}表示一個占位符，使用占位符可以防止sql註入，

$ {}通過${}可以將parameterType傳入的內容拼接在sql中,不能防止sql註入，但是有時方便
例:

SELECT * FROM USER WHERE username LIKE '%${name}%'

再比如order by排序，如果將列名通過參數傳入sql，根據傳的列名進行排序，應該寫為：

ORDER BY ${columnName}

如果使用#{}將無法實現此功能。

二、傳遞包裝類型

Java 類

public class UserVo {
    private Administration adm；  
    //自定義用戶擴展類
    private UserCustom userCustom;
}

xml文件

<select id="findUserList" parameterType="userVo" resultType="UserCustom">
          SELECT * FROM adm where adm.sex=
          #{userCustom.sex} and adm.username LIKE '%${userCustom.username}%'
</select>

三、動態sql—類型

mybatis 的動態sql語句是基於OGNL表達式的。可以方便的在 sql 語句中實現某些邏輯.

總體說來mybatis 動態SQL 語句主要有以下幾類:

  • if 語句 (簡單的條件判斷)
  • choose (when,otherwize) ,相當於java 語言中的 switch ,與 jstl 中的choose 很類似.
  • trim (對包含的內容加上 prefix,或者 suffix 等，前綴，後綴)
  • where (主要是用來簡化sql語句中where條件判斷的，能智能的處理 and or ,不必擔心多餘導致語法錯誤)
  • set (主要用於更新時)
  • foreach (在實現 mybatis in 語句查詢時特別有用)

四、動態sql—詳解

（一）if 語句處理

    <select id="getUnitListByUserId" resultType="com.xjrsoft.module.customer.stock.inv_storer.vo.InvStorerVo"
            parameterType="string">
        SELECT ins.USER_ID as user_id, ins.OPERATING_UNIT_ID as operating_unit_id, mou.`NAME` as operating_unit_name
        FROM `inv_storer` ins
        left join md_operating_unit mou on ins.OPERATING_UNIT_ID = mou.F_Id
        where ins.F_DeleteMark = 0
        and ins.F_EnabledMark = 1
        <if test="userId != null and userId != ''">
            and ins.USER_ID = #{userId}
        </if>
    </select>

（二）choose (when,otherwize)語句處理

choose (when,otherwize) ,相當於java 語言中的 switch ,與 jstl 中的choose 很類似

<select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">
 select * from t_blog where 1 = 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中的內容。

（三）trim 語句處理

trim (對包含的內容加上 prefix,或者 suffix 等，前綴，後綴)

<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>

詳解

  • trim元素的主要功能是可以在自己包含的內容前加上某些前綴，也可以在其後加上某些後綴，與之對應的屬性是prefix和suffix；
  • 可以把包含內容的首部某些內容覆蓋，即忽略，也可以把尾部的某些內容覆蓋，對應的屬性是prefixOverrides和suffixOverrides；

正因為trim有這樣的功能，所以我們也可以非常簡單的利用trim來代替where元素的功能。

小結

trim標記是一個格式化的標記，可以完成set或者是where標記的功能，如下代碼：

select * from user 
<trim prefix="WHERE" prefixoverride="AND |OR">
<if test="name != null and name.length()>0"> 
AND name=#{name}
</if>
<if test="gender != null and gender.length()>0"> 
AND gender=#{gender}
</if>
</trim>

假如說name和gender的值都不為null的話打印的SQL為：

select * from user where name = 'xx' and gender = 'xx'

在紅色標記的地方是不存在第一個and的，上面兩個屬性的意思如下：

  • prefix：前綴
  • prefixoverride：去掉第一個and或者是or
update user
<trim prefix="set" suffixoverride="," suffix=" where id = #{id} ">
<if test="name != null and name.length()>0">
name=#{name} ,
</if>
<if test="gender != null and gender.length()>0">
gender=#{gender} , 
</if>
</trim>

假如說name和gender的值都不為null的話打印的SQL為：

update user set name='xx' , gender='xx' where id='x'

在紅色標記的地方不存在逗號，而且自動加瞭一個set前綴和where後綴，上面三個屬性的意義如下，其中prefix意義如上：

suffixoverride：去掉最後一個逗號（也可以是其他的標記，就像是上面前綴中的and一樣）

suffix：後綴

（四）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 給忽略。

（五）foreach 語句處理

foreach (在實現 mybatis in 語句查詢時特別有用):

foreach的主要用在構建in條件中，它可以在SQL語句中進行迭代一個集合。foreach元素的屬性主要有item，index，collection，open，separator，close。

foreach元素屬性

  • item表示集合中每一個元素進行迭代時的別名。
  • index指定一個名字，用於表示在迭代過程中，每次迭代到的位置。
  • open表示該語句以什麼開始。
  • separator表示在每次進行迭代之間以什麼符號作為分隔符。
  • close表示以什麼結束。

在使用foreach的時候最關鍵的也是最容易出錯的就是collection屬性，該屬性是必須指定的，但是在不同情況下，該屬性的值是不一樣的，主要有一下3種情況：

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

1、單參數List的類型

    <select id="getStoreroomListByIds" parameterType="string"
resultType="com.xjrsoft.module.customer.inv_shift_head.invShiftHead.dto.InvStoreroomDto">
        SELECT info.*
        FROM (
        SELECT isr.F_Id AS storeroom_id,
        isr.OPERATING_UNIT_ID as unit_id,
        mou.NAME as unit_name
        FROM `inv_storeroom` isr
        LEFT JOIN `md_operating_unit` AS mou ON isr.OPERATING_UNIT_ID = mou.F_Id
        WHERE isr.F_DeleteMark = 0
        AND isr.F_EnabledMark = 1
        AND mou.F_DeleteMark = 0
        AND mou.F_EnabledMark = 1
        ) AS info
        <where>
            <if test="ids != null and ids != ''">
                info.storeroom_id in
                <foreach collection="ids" item="item" close=")" open="(" separator=",">
                    #{item}
                </foreach>
            </if>
        </where>
    </select>

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

    /**
     * 根據庫房id獲取經營單元
     *
     * @param ids
     * @return
     */
    List<InvStoreroomDto> getStoreroomListByIds(@Param("ids") List<String> ids);

2、數組類型的參數

<select id="dynamicForeach2Test" resultType="com.mybatis.entity.User">
select * from t_user where id in
<foreach collection="array" index="index" item="item" open="(" separator="," close=")">
#{item}
</foreach>
</select>

對應mapper：

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

3、Map類型的參數

<select id="dynamicForeach3Test" resultType="com.mybatis.entity.User">
select * from t_user where username like '%${username}%' and id in
<foreach collection="ids" index="index" item="item" open="(" separator="," close=")">
#{item}
</foreach>
</select>

mapper 應該是這樣的接口:

/**mybatis Foreach測試 */
public List<User> dynamicForeach3Test(Map<String, Object> params);

到此這篇關於Mybatis中xml的動態sql實現示例的文章就介紹到這瞭,更多相關Mybatis xml的動態sql內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：