Mybatis動態SQL之where標簽用法說明

Posted on by

關於where標簽用法

xml映射文件部分內容:

<select id="selectIfCondition" resultType="com.heiketu.testpackage.pojo.Product">
    SELECT
        prod_id prodId,
        vend_id vendId,
        prod_name prodName,
        prod_desc prodDesc
    FROM Products
    <where>
        <if test="prodId != null and prodId != ''">
            AND prod_id = #{prodId}
        </if>
        <if test="prodName != null and prodName != ''">
            AND prod_name = #{prodName}
        </if>
    </where>
</select>

映射文件中的where標簽可以過濾掉條件語句中的第一個and或or關鍵字。以上SQL當prodId!=null時會被mybatis的where標簽去除掉多餘的and關鍵字，生成的sql如下:

SELECT
    prod_id prodId,
    vend_id vendId,
    prod_name prodName,
    prod_desc prodDesc
FROM Products
WHERE
    prod_id = ?
AND
    prod_name = ?

註: where標簽隻能去除第一個條件中出現的前置 and 關鍵字。像以下情況，where就無能為力瞭:

<select id="selectIfCondition" resultType="com.heiketu.testpackage.pojo.Product">
    SELECT
        prod_id prodId,
        vend_id vendId,
        prod_name prodName,
        prod_desc prodDesc
    FROM Products
    <where>
        <if test="prodId != null and prodId != ''">
            prod_id = #{prodId} AND
        </if>
        <if test="prodName != null and prodName != ''">
            prod_name = #{prodName} AND
        </if>
    </where>
</select>

Mybatis會把次SQL語句拼接成:

SELECT
    prod_id prodId,
    vend_id vendId,
    prod_name prodName,
    prod_desc prodDesc
FROM Products
WHERE
    prod_id = ? AND
    prod_name = ? AND

where無法去除掉後面的and關鍵字，此時sql語句出現語法錯誤。

要想解決以上where標簽無法處理的問題，可以考慮使用trim標簽。 

使用where標簽及一些註意點

where標簽簡單使用

自己習慣性配上映射對象 這個大傢根據自己習慣去寫，可以直接使用map去接返回參數

// 返回對象映射
<resultMap id="ResultMap" type="com.xxx.root.ConnRoot">
        <result column="CONN_ID" property="connId" jdbcType="NUMERIC"/>
        <result column="CONN_NO" property="connNo" jdbcType="VARCHAR"/>
        <result column="STA_ID" property="staId" jdbcType="NUMERIC"/>
        <result column="RUN_MODE" property="runMode" jdbcType="VARCHAR"/>
        <result column="SRV_ID" property="srvId" jdbcType="NUMERIC"/>
        <result column="LINE_ID" property="lineId" jdbcType="NUMERIC"/>
</resultMap>
// 此處為使用 where相關SQL
<select id="listConnection" parameterType="java.util.Map" resultMap="ResultMap">
        SELECT
        A.CONN_ID,
        A.CONN_NO,
        A.STA_ID,
        A.RUN_MODE,
        A.SRV_ID,
        A.LINE_ID
        FROM CONN A 
        where 1=1 
        <if test="srvId!= null" >
        AND SRV_ID= #{srvId,jdbcType=DECIMAL}
        </if>
</select>

jdbcType 加上可以避免在映射時出現某些錯誤

jdbc出現的需求及 解決什麼問題：當mybatis執行mapping文件時，如果某個映射的參數為空，無法確定他的類型時需要用到jdbcType來確定類型。

// 此處為使用 where 標簽SQL
<select id="listConnection" parameterType="java.util.Map" resultMap="ResultMap">
        SELECT
        A.CONN_ID,
        A.CONN_NO,
        A.STA_ID,
        A.RUN_MODE,
        A.SRV_ID,
        A.LINE_ID
        FROM CONN A
        <where> 
            <if test="srvId!= null">
             A.SRV_ID= #{srvId,jdbcType=DECIMAL}
            </if> 
            <if test="runMode!= null">
            AND  A.RUN_MODE= #{runMode,jdbcType=VARCHAR}
            </if>
        </where>
</select>

到這裡大傢可以看到where標簽使用和不適用的一些區別

首先是 where後面加 1=1，在使用where關鍵字時，因為條件不確定存在不存在，要加上 1=1這個垃圾條件來解決條件為空時where失去存在的意義；但是< where >標簽中不需要加 1=1這個垃圾條件，因為where標簽會自動處理隻有在一個以上的< if >標簽有值時才去插入“WHERE”子句到SQL中。

然後是另一個問題條件AND 條件，where標簽會自動去除首個條件中的AND，這樣大傢就可以不用去管第一個條件是否為空可以直接給所有if標簽中的條件都加上AND，但是自己還是習慣的將第一個條件去掉AND ，但是如果遇到前邊已經有一個存在的條件的情況下，那接下來所有的if中的條件開頭AND是必須要加的，如：

<select id="listConnection" parameterType="java.util.Map" resultMap="ResultMap">
        SELECT
        A.CONN_ID,
        A.CONN_NO,
        A.STA_ID,
        A.RUN_MODE,
        A.SRV_ID,
        A.LINE_ID
        FROM CONN A
        <where> 
            A.CONN_ID=1
            <if test="srvId!= null">
            AND   A.SRV_ID= #{srvId,jdbcType=DECIMAL}
            </if> 
            <if test="runMode!= null">
            AND  A.RUN_MODE= #{runMode,jdbcType=VARCHAR}
            </if>
        </where>
</select>

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：