Mybatis-動態sql

動態 SQL

MyBatis 的強大特性之一便是它的動態 SQL。如果你有使用 JDBC 或其它類似框架的經驗，你就能體會到根據不同條件拼接 SQL 語句的痛苦。例如拼接時要確保不能忘記添加必要的空格，還要注意去掉列表最後一個列名的逗號。利用動態 SQL 這一特性可以徹底擺脫這種痛苦。

雖然在以前使用動態 SQL 並非一件易事，但正是 MyBatis 提供了可以被用在任意 SQL 映射語句中的強大的動態 SQL 語言得以改進這種情形。

動態 SQL 元素和 JSTL 或基於類似 XML 的文本處理器相似。在 MyBatis 之前的版本中，有很多元素需要花時間瞭解。MyBatis 3 大大精簡了元素種類，現在只需學習原來一半的元素便可。MyBatis 採用功能強大的基於 OGNL 的表達式來淘汰其它大部分元素。

• if
• choose (when, otherwise)
• trim (where, set)
• foreach

if

動態 SQL 通常要做的事情是根據條件包含 where 子句的一部分。比如：

<code><select>     resultType="Blog">
  SELECT * FROM BLOG
  WHERE state = ‘ACTIVE’
  
    AND title like #{title}
  
/<select>/<code>

這條語句提供了一種可選的查找文本功能。如果沒有傳入“title”，那麼所有處於“ACTIVE”狀態的BLOG都會返回；反之若傳入了“title”，那麼就會對“title”一列進行模糊查找並返回 BLOG 結果（細心的讀者可能會發現，“title”參數值是可以包含一些掩碼或通配符的）。

如果希望通過“title”和“author”兩個參數進行可選搜索該怎麼辦呢？首先，改變語句的名稱讓它更具實際意義；然後只要加入另一個條件即可。

<code><select>     resultType="Blog">
  SELECT * FROM BLOG WHERE state = ‘ACTIVE’
  
    AND title like #{title}
  
  
    AND author_name like #{author.name}
  
/<select>/<code>

choose, when, otherwise

有時我們不想應用到所有的條件語句，而只想從中擇其一項。針對這種情況，MyBatis 提供了 choose 元素，它有點像 Java 中的 switch 語句。

還是上面的例子，但是這次變為提供了“title”就按“title”查找，提供了“author”就按“author”查找的情形，若兩者都沒有提供，就返回所有符合條件的 BLOG（實際情況可能是由管理員按一定策略選出 BLOG 列表，而不是返回大量無意義的隨機結果）。

<code><select>     resultType="Blog">
  SELECT * FROM BLOG WHERE state = ‘ACTIVE’
  <choose>
    <when>
      AND title like #{title}
    /<when>
    <when>
      AND author_name like #{author.name}
    /<when>
    <otherwise>
      AND featured = 1
    /<otherwise>
  /<choose>
/<select>/<code>

trim, where, set

前面幾個例子已經合宜地解決了一個臭名昭著的動態 SQL 問題。現在回到“if”示例，這次我們將“ACTIVE = 1”也設置成動態的條件，看看會發生什麼。

<code><select>     resultType="Blog">
  SELECT * FROM BLOG
  WHERE
  
    state = #{state}
  
  
    AND title like #{title}
   

  
    AND author_name like #{author.name}
  
/<select>/<code>

如果這些條件沒有一個能匹配上會發生什麼？最終這條 SQL 會變成這樣：

<code>SELECT * FROM BLOG
WHERE/<code>

這會導致查詢失敗。如果僅僅第二個條件匹配又會怎樣？這條 SQL 最終會是這樣:

<code>SELECT * FROM BLOG
WHERE
AND title like ‘someTitle’/<code>

這個查詢也會失敗。這個問題不能簡單地用條件句式來解決，如果你也曾經被迫這樣寫過，那麼你很可能從此以後都不會再寫出這種語句了。

MyBatis 有一個簡單的處理，這在 90% 的情況下都會有用。而在不能使用的地方，你可以自定義處理方式來令其正常工作。一處簡單的修改就能達到目的：

<code><select>     resultType="Blog">
  SELECT * FROM BLOG
  <where>
    
         state = #{state}
    
     

        AND title like #{title}
    
    
        AND author_name like #{author.name}
    
  /<where>
/<select>/<code>

where 元素只會在至少有一個子元素的條件返回 SQL 子句的情況下才去插入“WHERE”子句。而且，若語句的開頭為“AND”或“OR”，where 元素也會將它們去除。

如果 where 元素沒有按正常套路出牌，我們可以通過自定義 trim 元素來定製 where 元素的功能。比如，和 where 元素等價的自定義 trim 元素為：

<code><trim>
  ...
/<trim>/<code>

prefixOverrides 屬性會忽略通過管道分隔的文本序列（注意此例中的空格也是必要的）。它的作用是移除所有指定在 prefixOverrides 屬性中的內容，並且插入 prefix 屬性中指定的內容。

類似的用於動態更新語句的解決方案叫做 set。set 元素可以用於動態包含需要更新的列，而捨去其它的。比如：

<code><update>
  update Author
    
      username=#{username}, 

      password=#{password},
      email=#{email},
      bio=#{bio}
    
  where id=#{id}
/<update>/<code>

這裡，set 元素會動態前置 SET 關鍵字，同時也會刪掉無關的逗號，因為用了條件語句之後很可能就會在生成的 SQL 語句的後面留下這些逗號。（譯者注：因為用的是“if”元素，若最後一個“if”沒有匹配上而前面的匹配上，SQL 語句的最後就會有一個逗號遺留）

若你對 set 元素等價的自定義 trim 元素的代碼感興趣，那這就是它的真面目：

<code><trim>
  ...
/<trim>/<code>

注意這裡我們刪去的是後綴值，同時添加了前綴值。

foreach

動態 SQL 的另外一個常用的操作需求是對一個集合進行遍歷，通常是在構建 IN 條件語句的時候。比如：

<code><select> 

  SELECT *
  FROM POST P
  WHERE ID in
  <foreach>      open="(" separator="," close=")">
        #{item}
  /<foreach>
/<select>/<code>

foreach 元素的功能非常強大，它允許你指定一個集合，聲明可以在元素體內使用的集合項（item）和索引（index）變量。它也允許你指定開頭與結尾的字符串以及在迭代結果之間放置分隔符。這個元素是很智能的，因此它不會偶然地附加多餘的分隔符。

注意 你可以將任何可迭代對象（如 List、Set 等）、Map 對象或者數組對象傳遞給 foreach 作為集合參數。當使用可迭代對象或者數組時，index 是當前迭代的次數，item 的值是本次迭代獲取的元素。當使用 Map 對象（或者 Map.Entry 對象的集合）時，index 是鍵，item 是值。

到此我們已經完成了涉及 XML 配置文件和 XML 映射文件的討論。下一章將詳細探討 Java API，這樣就能提高已創建的映射文件的利用效率。

script

要在帶註解的映射器接口類中使用動態 SQL，可以使用>

<code>    @Update({""})
    void updateAuthorValues(Author author);/<code>

bind

bind 元素可以從 OGNL 表達式中創建一個變量並將其綁定到上下文。比如：

<code><select>
  <bind>
  SELECT * FROM BLOG
  WHERE title LIKE #{pattern}
/<select>/<code>

多數據庫支持

一個配置了“_databaseId”變量的 databaseIdProvider 可用於動態代碼中，這樣就可以根據不同的數據庫廠商構建特定的語句。比如下面的例子：

<code><insert>
  <selectkey>
    
      select seq_users.nextval from dual
    
    
      select nextval for seq_users from sysibm.sysdummy1"
    
  /<selectkey>
  insert into users values (#{id}, #{name})
/<insert>/<code>

動態 SQL 中的可插拔腳本語言

MyBatis 從 3.2 開始支持可插拔腳本語言，這允許你插入一種腳本語言驅動，並基於這種語言來編寫動態 SQL 查詢語句。

可以通過實現以下接口來插入一種語言：

<code>public interface LanguageDriver {
  ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql);
  SqlSource createSqlSource(Configuration configuration, XNode/>  SqlSource createSqlSource(Configuration configuration, String/>}/<code>

一旦設定了自定義語言驅動，你就可以在 mybatis-config.xml 文件中將它設置為默認語言：

<code><typealiases>
  <typealias>
/<typealiases>
<settings>
  <setting>
/<settings>/<code>

除了設置默認語言，你也可以針對特殊的語句指定特定語言，可以通過如下的 lang 屬性來完成：

<code><select>
  SELECT * FROM BLOG
/<select>/<code>

或者，如果你使用的是映射器接口類，在抽象方法上加上 @Lang 註解即可：

<code>public interface Mapper {
  @Lang(MyLanguageDriver.class)
  @Select("SELECT * FROM BLOG")
  List<blog> selectBlog();
}/<blog>/<code>

注意 可以將 Apache Velocity 作為動態語言來使用，更多細節請參考 MyBatis-Velocity 項目。

你前面看到的所有 xml 標籤都是由默認 MyBatis 語言提供的，而它由別名為 xml 的語言驅動器 org.apache.ibatis.scripting.xmltags.XmlLanguageDriver 所提供。

閱讀更多 西貝9527 的文章

關鍵字: 動態 SQL XML