Mybatis foreach collection詳解

一、forEach collection的基本使用

在Mybatis中，forEach可以用來循環遍歷一個集合（collection）或數組（array）的元素，用於動態生成SQL語句。

最常用的forEach 寫法如下所示：

<select id="queryByList" resultType="com.example.demo.model.User">
    select * from user
      where id in
    <foreach collection="list" open="(" close=")" item="item" separator=",">
        #{item}
    </foreach>
</select>

解釋：

在這個例子中，list是從Java代碼中傳遞過來的 List<Integer> 集合，其裡面包含了這個查詢需要查的ID（不能是Long，否則如果條件裡面是id，則會報類型不匹配)，然後在 SQL語句中，將list的內容動態生成一個查詢條件。

如果list裡面只有一個元素，那麼該SQL會被渲染成:

select * from user where id in (1)

如果list裡面有兩個及以上的元素，那麼該SQL會被渲染成:

select * from user where id in (1, 2)

二、collection裡面是Map的處理

當我們有一個Map<String, Integer>作為輸入參數的時候，forEach的寫法如下：

    <select id="queryByMap" resultType="com.example.demo.model.User">
        select * from user
        where id in
        <foreach collection="map" index="key" item="value" open="(" close=")" separator=",">
        #{value}
        </foreach>
    </select>

解釋：

map 是從Java代碼中傳遞過來的 Map<String, Integer> 集合，其裡面包含了這個查詢需要查的ID（不能是Long，否則如果條件裡面是id，則會報類型不匹配)，其中key是map的鍵，value是map的值，在SQL語句中，將Map的值動態生成一個查詢條件。比如這樣實現，則只會查詢出ID為 1 和 3的這兩條數據。

List<User> list = userDao.queryByMap(new HashMap<String, Integer>() {{
    put("A", 1);
    put("B", 2);
    put("C", 3);
}});

三、基於collection的動態SQL

假設我們有這樣的一種需求：當map這個參數中的key值為這五個關鍵字的時候，就需要暫停一下這個SQL的執行，同時輸出一段 SQL 提示語句。

要實現這個目標，可以像下面這樣：

    <select id="queryByMap" resultType="com.example.demo.model.User">
        select * from user
        where id in
        <foreach collection="map" index="key" item="value" open="(" close=")" separator=",">
            <if test="'A,B,C,D,E'.indexOf(key)>=0">
                <bind name="sql" value="'select \'These are not allowed!\'; '"/>
            </if>
            #{value}
        </foreach>
        ${sql}
    </select>

解釋：

這樣寫會把 SQL 腳本渲染成

select * from user where id in (
  select 'These are not allowed!';
  1, 2, 3, 4, 5
)

注意：這裡的sql是一個綁定，他會被生效，然後其結果也會再次渲染在結果中。

四、動態SQL語句的順序結構

假設有這樣一個查詢場景：能夠動態選擇一個或多個資料庫名字，查詢名字以某個子串開頭的玩家列表。當然，資料庫表和欄位名、欄位值也都可以是參數傳遞進去。

假如是這樣的代碼：

<select id="queryByName" resultType="com.example.demo.model.User">
  select * from user
  <where>
    <if test="dbNames != null">
      <foreach collection="dbNames" index="index" item="dbName">
        <if test="index == 0">
          (dbName=#{dbName}
        </if>
        <if test="index > 0">
          or dbName=#{dbName}
        </if>
        <if test="index == dbNames.size()-1">
          )
        </if>
      </foreach>
      and
    </if>
    userName LIKE #{name}%
  </where>
</select>

解釋：

上述代碼中，語句的先後順序是先處理 dbName，再處理 userName，再處理dbTable、fieldNames和fieldValues。

五、foreach和bind的擴展

一個資料庫表的往往會有很多個欄位，如果寫在SQL中會顯得有些冗長，所以可以用<bind>標籤來進行簡化。

下面是一個具體的例子。 假設有一個 User 表，需要可以動態地修改這個表的若干個欄位名字值，那麼這種參數傳遞的方式需要使用「標記與攜帶參數（tag and baggage）」方式，即將每個欄位名用一個字串標記，並且把每個需要設置的欄位的值都放到集合裡面：

    <update id="update" parameterType="java.util.Map">
        update user
        <set>
            <foreach collection="fieldNames" index="index" item="field">
                <if test="fieldValues[index] != null">
                    <bind name="x" value="'#{field}' = #{fieldValues[index]}'"/>
                    ${x},${sql}
                </if>
            </foreach>
            updated_at=now()
        </set>
        where id=#{id}
    </update>

解釋：

上述代碼中，將 注入的SQL 語句的名字放到了一個列表裡面，然後再在 foreach 循環中把實際值賦給其中每個項。