Mybatis的where標簽使用總結梳理

Posted on by

背景

在上篇文章，我們系統地學習瞭where 1=1 相關的知識點，大傢可以回看《MySQL中where 1=1方法的使用及改進》這篇文章。文章中涉及到瞭Mybatis的替代方案，有好學的朋友在評論區有朋友問瞭基於Mybatis寫法的問題。

本篇文章會將Mybatis中where標簽的基本使用形式、小技巧以及容易踩到的坑進行總結梳理，方便大傢更好地實踐運用d

原始的手動拼接

在不使用Mybatis的where標簽時，我們通常是根據查詢條件進行手動拼接，也就是用到瞭上面提到的where 1=1的方式，示例如下：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    where 1=1
    <if test="username != null and username != ''">
     and username = #{username}
    </if>
    <if test="idNo != null and idNo != ''">
      and id_no = #{idNo}
    </if>
  </select>

這種方式主要就是為瞭避免語句拼接錯誤，出現類似如下的錯誤SQL：

select * from t_user where and username = 'Tom' and id = '1001';
select * from t_user where and id = '1001';

當添加上1=1時，SQL語句便是正確的瞭：

select * from t_user where 1=1 and username = 'Tom' and id = '1001';
select * from t_user where 1=1 and id = '1001';

這個我們之前已經提到過，多少對MySQL數據庫的有一定的壓力。因為1=1條件的優化過濾是需要MySQL做的。如果能夠將這部分放到應用程序來做，就減少瞭MySQL的壓力。畢竟，應用程序是可以輕易地橫向擴展的。

Mybatis where標簽的使用

為瞭能達到MySQL性能的調優，我們可以基於Mybatis的where標簽來進行實現。where標簽是頂層的遍歷標簽，需要配合if標簽使用，單獨使用無意義。通常有下面兩種實現形式。

方式一：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        and id_no = #{idNo}
      </if>
    </where>
  </select>

方式二：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        and username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        and id_no = #{idNo}
      </if>
    </where>
  </select>

仔細觀察會發現，這兩種方式的區別在於第一if條件中的SQL語句是否有and。

這裡就涉及到where標簽的兩個特性：

  • 第一，隻有if標簽有內容的情況下才會插入where子句；
  • 第二，若子句的開通為 “AND” 或 “OR”，where標簽會將它替換去除；

所以說，上面的兩種寫法都是可以瞭，Mybatis的where標簽會替我們做一些事情。

但需要註意的是：where標簽隻會 智能的去除（忽略）首個滿足條件語句的前綴。所以建議在使用where標簽時，每個語句都最好寫上 and 前綴或者 or 前綴，否則像以下寫法就會出現問題：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        id_no = #{idNo}
      </if>
    </where>
  </select>

生成的SQL語句如下：

select * from t_user      WHERE username = ?  id_no = ?

很顯然，語法是錯誤的。

因此，在使用where標簽時，建議將所有條件都添加上and或or；

進階：自定義trim標簽

上面使用where標簽可以達到拼接條件語句時，自動去掉首個條件的and或or，那麼如果是其他自定義的關鍵字是否也能去掉呢？

此時，where標簽就無能為力瞭，該trim標簽上場瞭，它也可以實現where標簽的功能。

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <trim prefix="where" prefixOverrides="and | or ">
      <if test="username != null and username != ''">
        and username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        and id_no = #{idNo}
      </if>
    </trim>
  </select>

將上面基於where標簽的寫改寫為trim標簽，發現執行效果完全一樣。而且trim標簽具有瞭更加靈活的自定義性。

where語句的坑

另外，在使用where語句或其他語句時一定要註意一個地方，那就是：註釋的使用。

先來看例子：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        and username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        /* and id_no = #{idNo}*/
        and id_no = #{idNo}
      </if>
    </where>
  </select>

上述SQL語句中添加瞭 /**/的註釋，生成的SQL語句為：

select * from t_user WHERE username = ? /* and id_no = ?*/ and id_no = ?

執行時，直接報錯。

還有一個示例：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        -- and username = #{username}
        and username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        and id_no = #{idNo}
      </if>
    </where>
  </select>

生成的SQL語句為：

select * from t_user WHERE -- and username = ? and username = ? and id_no = ?

同樣會導致報錯。

這是因為我們使用 XML 方式配置 SQL 時，如果在 where 標簽之後添加瞭註釋，那麼當有子元素滿足條件時，除瞭 < !– –> 註釋會被 where 忽略解析以外，其它註釋例如 // 或 /**/ 或 — 等都會被 where 當成首個子句元素處理，導致後續真正的首個 AND 子句元素或 OR 子句元素沒能被成功替換掉前綴，從而引起語法錯誤。

同時，個人在實踐中也經常發現因為在XML中使用註釋不當導致SQL語法錯誤或執行出錯誤的結果。強烈建議，非必要，不要在XML中註釋掉SQL，可以通過版本管理工具來追溯歷史記錄和修改。

小結

本文基於Mybatis中where標簽的使用，展開講瞭它的使用方式、特性以及拓展到trim標簽的替代作用，同時，也提到瞭在使用時可能會出現的坑。內容雖然簡單，但如果能夠很好地實踐、避免踩坑也是能力的體現。

到此這篇關於Mybatis的where標簽使用總結梳理的文章就介紹到這瞭,更多相關Mybatis的where標簽 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：