快捷導(dǎo)航

Mybatis中xml的動(dòng)態(tài)sql實(shí)現(xiàn)示例

更新時(shí)間：2022年06月29日 16:54:02 作者：王林-wlin

本文主要介紹了Mybatis中xml的動(dòng)態(tài)sql實(shí)現(xiàn)示例，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

動(dòng)態(tài)SQL簡(jiǎn)介

動(dòng)態(tài) SQL 是 MyBatis 的強(qiáng)大特性之一。

如果你使用過 JDBC 或其它類似的框架，你應(yīng)該能理解根據(jù)不同條件拼接 SQL 語句有多痛苦，例如拼接時(shí)要確保不能忘記添加必要的空格，還要注意去掉列表最后一個(gè)列名的逗號(hào)。利用動(dòng)態(tài) SQL，可以徹底擺脫這種痛苦。

使用動(dòng)態(tài) SQL 并非一件易事，但借助可用于任何 SQL 映射語句中的強(qiáng)大的動(dòng)態(tài) SQL 語言，MyBatis 顯著地提升了這一特性的易用性。

一、#{}與${}區(qū)別#{}表示一個(gè)占位符，使用占位符可以防止sql注入，

$ {}通過${}可以將parameterType傳入的內(nèi)容拼接在sql中,不能防止sql注入，但是有時(shí)方便
例:

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

再比如order by排序，如果將列名通過參數(shù)傳入sql，根據(jù)傳的列名進(jìn)行排序，應(yīng)該寫為：

ORDER BY ${columnName}

如果使用#{}將無法實(shí)現(xiàn)此功能。

二、傳遞包裝類型

Java 類

public class UserVo {
    private Administration adm；  
    //自定義用戶擴(kuò)展類
    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>

三、動(dòng)態(tài)sql—類型

mybatis 的動(dòng)態(tài)sql語句是基于OGNL表達(dá)式的?？梢苑奖愕脑?sql 語句中實(shí)現(xiàn)某些邏輯.

總體說來mybatis 動(dòng)態(tài)SQL 語句主要有以下幾類:

if 語句 (簡(jiǎn)單的條件判斷)
choose (when,otherwize) ,相當(dāng)于java 語言中的 switch ,與 jstl 中的choose 很類似.
trim (對(duì)包含的內(nèi)容加上 prefix,或者 suffix 等，前綴，后綴)
where (主要是用來簡(jiǎn)化sql語句中where條件判斷的，能智能的處理 and or ,不必?fù)?dān)心多余導(dǎo)致語法錯(cuò)誤)
set (主要用于更新時(shí))
foreach (在實(shí)現(xiàn) mybatis in 語句查詢時(shí)特別有用)

四、動(dòng)態(tài)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) ,相當(dāng)于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元素表示當(dāng)when中的條件滿足的時(shí)候就輸出其中的內(nèi)容，跟JAVA中的switch效果差不多的是按照條件的順序，
當(dāng)when中有條件滿足的時(shí)候，就會(huì)跳出choose，即所有的when和otherwise條件中，只有一個(gè)會(huì)輸出，當(dāng)所有的我很條件都不滿足的時(shí)候就輸出otherwise中的內(nèi)容。

小結(jié)

所以上述語句的意思非常簡(jiǎn)單，當(dāng)title!=null的時(shí)候就輸出and titlte = #{title}，不再往下判斷條件，當(dāng)title為空且content!=null的時(shí)候就輸出and content = #{content}，當(dāng)所有條件都不滿足的時(shí)候就輸出otherwise中的內(nèi)容。

（三）trim 語句處理

trim (對(duì)包含的內(nèi)容加上 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元素的主要功能是可以在自己包含的內(nèi)容前加上某些前綴，也可以在其后加上某些后綴，與之對(duì)應(yīng)的屬性是prefix和suffix；
可以把包含內(nèi)容的首部某些內(nèi)容覆蓋，即忽略，也可以把尾部的某些內(nèi)容覆蓋，對(duì)應(yīng)的屬性是prefixOverrides和suffixOverrides；

正因?yàn)閠rim有這樣的功能，所以我們也可以非常簡(jiǎn)單的利用trim來代替where元素的功能。

小結(jié)

trim標(biāo)記是一個(gè)格式化的標(biāo)記，可以完成set或者是where標(biāo)記的功能，如下代碼：

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'

在紅色標(biāo)記的地方是不存在第一個(gè)and的，上面兩個(gè)屬性的意思如下：

prefix：前綴
prefixoverride：去掉第一個(gè)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'

在紅色標(biāo)記的地方不存在逗號(hào)，而且自動(dòng)加了一個(gè)set前綴和where后綴，上面三個(gè)屬性的意義如下，其中prefix意義如上：

suffixoverride：去掉最后一個(gè)逗號(hào)（也可以是其他的標(biāo)記，就像是上面前綴中的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元素的作用是會(huì)在寫入where元素的地方輸出一個(gè)where，另外一個(gè)好處是你不需要考慮where元素里面的條件輸出是什么樣子的，MyBatis會(huì)智能的幫你處理，
如果所有的條件都不滿足那么MyBatis就會(huì)查出所有的記錄，如果輸出后是and 開頭的，MyBatis會(huì)把第一個(gè)and忽略，當(dāng)然如果是or開頭的，MyBatis也會(huì)把它忽略；

此外，在where元素中你不需要考慮空格的問題，MyBatis會(huì)智能的幫你加上。

小結(jié)

像上述例子中，如果title=null，而content != null，那么輸出的整個(gè)語句會(huì)是:

select * from t_blog where content = #{content}

而不是select * from t_blog where and content = #{content}，因?yàn)镸yBatis會(huì)智能的把首個(gè)and 或 or 給忽略。

（五）foreach 語句處理

foreach (在實(shí)現(xiàn) mybatis in 語句查詢時(shí)特別有用):

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

foreach元素屬性

item表示集合中每一個(gè)元素進(jìn)行迭代時(shí)的別名。
index指定一個(gè)名字，用于表示在迭代過程中，每次迭代到的位置。
open表示該語句以什么開始。
separator表示在每次進(jìn)行迭代之間以什么符號(hào)作為分隔符。
close表示以什么結(jié)束。

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

如果傳入的是單參數(shù)且參數(shù)類型是一個(gè)List的時(shí)候，collection屬性值為list
如果傳入的是單參數(shù)且參數(shù)類型是一個(gè)array數(shù)組的時(shí)候，collection的屬性值為array
如果傳入的參數(shù)是多個(gè)的時(shí)候，我們就需要把它們封裝成一個(gè)Map了，當(dāng)然單參數(shù)也可以封裝成map，實(shí)際上如果你在傳入?yún)?shù)的時(shí)候，在MyBatis里面也是會(huì)把它封裝成一個(gè)Map的，map的key就是參數(shù)名，所以這個(gè)時(shí)候collection屬性值就是傳入的List或array對(duì)象在自己封裝的map里面的key。

1、單參數(shù)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，對(duì)應(yīng)的Mapper是這樣的：

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

2、數(shù)組類型的參數(shù)

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

對(duì)應(yīng)mapper：

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

3、Map類型的參數(shù)

<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 應(yīng)該是這樣的接口:

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

到此這篇關(guān)于Mybatis中xml的動(dòng)態(tài)sql實(shí)現(xiàn)示例的文章就介紹到這了,更多相關(guān)Mybatis xml的動(dòng)態(tài)sql內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: