mybatis foreach 屬性及其三種使用情況詳解

Posted on by

foreach 屬性介紹

foreach 用於迭代傳入過來的參數。

它的屬性介紹分別是

  • collection：表示傳入過來的參數的數據類型。該參數為必選。要做 foreach 的對象，作為入參時，List 對象默認用 list 代替作為鍵，數組對象有 array 代替作為鍵，Map 對象沒有默認的鍵。當然在作為入參時可以使用 @Param(“keyName”) 來設置鍵，設置 keyName 後，list,array 將會失效。 除瞭入參這種情況外，還有一種作為參數對象的某個字段的時候。

舉個例子：如果 User 有屬性 List ids。入參是 User 對象，那麼這個 collection = “ids” 如果 User 有屬性 Ids ids;其中 Ids 是個對象，Ids 有個屬性 List id;入參是 User 對象，那麼 collection = “ids.id”

如果傳入的是單參數且參數類型是一個 List 的時候，collection 屬性值為 list

如果傳入的是單參數且參數類型是一個 array 數組的時候，collection 的屬性值為 array

如果傳入的參數是多個的時候，我們就需要把它們封裝成一個 Map 瞭，當然單參數也可以封裝成 map。

  • item：循環體中的具體對象。支持屬性的點路徑訪問，如 item.age,item.info.details。具體說明：在 list 和數組中是其中的對象，在 map 中是 value，該參數為必選。（它是每一個元素進行迭代時的別名）
  • index：在 list 和數組中,index 是元素的序號；在 map 中，index 是元素的 key。
  • open：表示該語句以什麼開始
  • close：表示該語句以什麼結束
  • separator：表示在每次進行迭代之間以什麼符號作為分隔符

介紹完屬性之後，下面就進入實踐。首先先來看一個簡單到爆炸的表（表名：t_test_foreach）

這裡寫圖片描述

單參數是 array 類型

測試類

// ids = {1,2,3}
public List<User> testFindByArray(int[] ids) throws Exception {
    SqlSession sqlSession = getSession().openSession();
    userList = sqlSession.selectList(NameSpace + ".findByArray", ids);
    System.out.println(userList.toString());
    sqlSession.close();
    return userList;
}

mapper.xml

<!--這裡的 item 值可以和傳遞過來的參數名不一樣，在介紹屬性的時候已經說過這是一個別名瞭。比如可以修改成如下代碼：
    <foreach collection="array" item="id" index="index" open="(" close=")" separator=",">
        #{id}   <!--這裡要和 item 值保持一致-->
    </foreach>
-->
<select id="findByArray" resultType="com.test.foreach.User">
    SELECT id,`name` FROM t_test_foreach WHERE id IN
    <foreach collection="array" item="ids" index="index" open="(" close=")" separator=",">
        #{ids}
    </foreach>
</select>

輸出結果

DEBUG – ==>  Preparing: SELECT id,`name` FROM t_test_foreach WHERE id IN ( ? , ? , ? ) 
DEBUG – ==> Parameters: 1(Integer), 2(Integer), 3(Integer)
DEBUG – <==      Total: 3
[User{name='n1', id='1'}, User{name='n2', id='2'}, User{name='n3', id='3'}]

單參數是 List 類型

測試類

// List 元素有 1，3，5
public List<User> testFindByList(List<Integer> ids) throws Exception {
    SqlSession sqlSession = getSession().openSession();
    userList = sqlSession.selectList(NameSpace + ".findByList", ids);
    System.out.println(userList.toString());
    sqlSession.close();
    return userList;
}

mapper.xml

<select id="findByList" resultType="com.test.foreach.User">
    SELECT id,`name` FROM t_test_foreach WHERE id IN
    <foreach collection="list" item="ids" index="index" open="(" close=")" separator=",">
        #{ids}
    </foreach>
</select>

輸出結果

DEBUG – ==>  Preparing: SELECT id,`name` FROM t_test_foreach WHERE id IN ( ? , ? , ? ) 
DEBUG – ==> Parameters: 1(Integer), 3(Integer), 5(Integer)
DEBUG – <==      Total: 3
[User{name='n1', id='1'}, User{name='n3', id='3'}, User{name='n5', id='5'}]

單參數是 Map 類型

測試類

// Map<String, Object> 中的元素有 int[] ids = {2, 4};map.put("ids", ids);
public List<User> testFindByMap(Map map) throws Exception {
    SqlSession sqlSession = getSession().openSession();
    System.out.println(map.toString());
    List<Object> objects = sqlSession.selectList(NameSpace + ".findByMap", map);
    System.out.println(objects.toString());
    sqlSession.close();
    return userList;
}

mapper.xml

<!--註意 collection 值是 ids，即要進行迭代的對象。覺得有點懵的夥伴可以回到最開始介紹 collection 屬性那裡看看,不要急-->
<select id="findByMap" resultType="com.test.foreach.User">
    SELECT id,`name` FROM t_test_foreach WHERE id IN
    <foreach collection="ids" item="id" index="index" open="(" close=")" separator=",">
        #{id}
    </foreach>
</select>

輸出結果

DEBUG – ==>  Preparing: SELECT id,`name` FROM t_test_foreach WHERE id IN ( ? , ? ) 
DEBUG – ==> Parameters: 2(Integer), 4(Integer)
DEBUG – <==      Total: 2
[User{name='n2', id='2'}, User{name='n4', id='4'}]

多參數

這種情況在傳參數時，一定要改用 Map 方式

測試類

public void testUpdateByParams(int[] ids,String name) throws Exception {
    SqlSession sqlSession = getSession().openSession();
    Map<String,Object> map = new HashMap<String, Object>();
    map.put("ids",ids); // ids = {1,2,4}
    map.put("name",name);// name = "updated"
    sqlSession.selectList(NameSpace + ".findByParams", map);
    sqlSession.close();
}

mapper.xml

<select id="findByParams">
    UPDATE t_test_foreach SET `name` = '#{name}' WHERE id IN
    <foreach collection="ids" item="item" index="index" open="(" close=")" separator=",">
        #{item}
    </foreach>
</select>

輸出結果

DEBUG – ==>  Preparing: UPDATE t_test_foreach SET `name` = ? WHERE id IN ( ? , ? , ? ) 
DEBUG – ==> Parameters: updated(String), 1(Integer), 2(Integer), 4(Integer)

這裡寫圖片描述

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

推薦閱讀：