MyBatis系列(八)：MyBatis動態Sql之foreach標簽的用法

本篇博客主要講解如何使用foreach標簽生成動態的Sql，主要包含以下3個場景：

1. foreach 實現in集合
2. foreach 實現批量插入
3. foreach 實現動態update

1. foreach 實現in集合

假設有這樣1個需求：根據傳入的用戶id集合查詢出所有符合條件的用戶，此時我們需要使用到Sql中的IN，如 id in (1,1001)。

首先，我們在接口SysUserMapper中添加如下方法：

/**
 * 根據用戶id集合查詢用戶
 *
 * @param idList
 * @return
 */
List<SysUser> selectByIdList(List<Long> idList);

然后在對應的SysUserMapper.xml中添加如下代碼：

<select id="selectByIdList" resultType="com.zwwhnly.mybatisaction.model.SysUser">
    SELECT id,
    user_name,
    user_password,
    user_email,
    create_time
    FROM sys_user
    WHERE id IN
    <foreach collection="list" open="(" close=")" separator=","
             item="id" index="i">
        #{id}
    </foreach>
</select>

最后，在SysUserMapperTest測試類中添加如下測試方法：

@Test
public void testSelectByIdList() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        List<Long> idList = new ArrayList<Long>();
        idList.add(1L);
        idList.add(1001L);

        List<SysUser> userList = sysUserMapper.selectByIdList(idList);
        Assert.assertEquals(2, userList.size());
    } finally {
        sqlSession.close();
    }
}

運行測試代碼，測試通過，輸出日志如下：

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE id IN ( ? , ? )

DEBUG [main] - ==> Parameters: 1(Long), 1001(Long)

TRACE [main] - <== Columns: id, user_name, user_password, user_email, create_time

TRACE [main] - <== Row: 1, admin, 123456, [e-mail], 2019-06-27 18:21:07.0

TRACE [main] - <== Row: 1001, test, 123456, [e-mail], 2019-06-27 18:21:07.0

DEBUG [main] - <== Total: 2

通過日志會發現，foreach元素中的內容最終生成的Sql語句為(1,1001)。

foreach包含屬性講解：

• open：整個循環內容開頭的字符串。
• close：整個循環內容結尾的字符串。
• separator：每次循環的分隔符。
• item：從迭代對象中取出的每一個值。
• index：如果參數為集合或者數組，該值為當前索引值，如果參數為Map類型時，該值為Map的key。
• collection：要迭代循環的屬性名。

也許有人會好奇，為什么collection的值是list？該值該如何設置呢？

上面的例子中只有一個集合參數，我們把collection屬性的值設置為了list，其實也可以寫成collection，為什么呢？讓我們看下DefaultSqlSession中的默認處理邏輯：

private Object wrapCollection(Object object) {
    DefaultSqlSession.StrictMap map;
    if (object instanceof Collection) {
        map = new DefaultSqlSession.StrictMap();
        map.put("collection", object);
        if (object instanceof List) {
            map.put("list", object);
        }

        return map;
    } else if (object != null && object.getClass().isArray()) {
        map = new DefaultSqlSession.StrictMap();
        map.put("array", object);
        return map;
    } else {
        return object;
    }
}

雖然使用默認值，代碼也可以正常運行，但還是推薦使用@Param來指定參數的名字，如下所示：

List<SysUser> selectByIdList(@Param("idList") List<Long> idList);

<foreach collection="idList" open="(" close=")" separator=","
         item="id" index="i">
    #{id}
</foreach>

如果參數是一個數組參數，collection可以設置為默認值array，看了上面的源碼，應該不難理解。

/**
 * 根據用戶id數組查詢用戶
 *
 * @param idArray
 * @return
 */
List<SysUser> selectByIdArray(Long[] idArray);

<select id="selectByIdArray" resultType="com.zwwhnly.mybatisaction.model.SysUser">
    SELECT id,
    user_name,
    user_password,
    user_email,
    create_time
    FROM sys_user
    WHERE id IN
    <foreach collection="array" open="(" close=")" separator=","
             item="id" index="i">
        #{id}
    </foreach>
</select>

雖然使用默認值，代碼也可以正常運行，但還是推薦使用@Param來指定參數的名字，如下所示：

List<SysUser> selectByIdArray(@Param("idArray")Long[] idArray);

<foreach collection="idArray" open="(" close=")" separator=","
         item="id" index="i">
    #{id}
</foreach>

2. foreach 實現批量插入

假設有這樣1個需求：將傳入的用戶集合批量寫入數據庫。

首先，我們在接口SysUserMapper中添加如下方法：

/**
 * 批量插入用戶信息
 *
 * @param userList
 * @return
 */
int insertList(List<SysUser> userList);

然后在對應的SysUserMapper.xml中添加如下代碼：

<insert id="insertList" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO sys_user(user_name, user_password, user_email, user_info, head_img, create_time)
    VALUES
    <foreach collection="list" item="user" separator=",">
        (#{user.userName},#{user.userPassword},#{user.userEmail},#{user.userInfo},#{user.headImg,jdbcType=BLOB},#{user.createTime,jdbcType=TIMESTAMP})
    </foreach>
</insert>

最后，在SysUserMapperTest測試類中添加如下測試方法：

@Test
public void testInsertList() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        List<SysUser> sysUserList = new ArrayList<SysUser>();
        for (int i = 0; i < 2; i++) {
            SysUser sysUser = new SysUser();
            sysUser.setUserName("test" + i);
            sysUser.setUserPassword("123456");
            sysUser.setUserEmail("[e-mail]");

            sysUserList.add(sysUser);
        }

        int result = sysUserMapper.insertList(sysUserList);

        for (SysUser sysUser : sysUserList) {
            System.out.println(sysUser.getId());
        }

        Assert.assertEquals(2, result);
    } finally {
        sqlSession.close();
    }
}

運行測試代碼，測試通過，輸出日志如下：

DEBUG [main] - ==> Preparing: INSERT INTO sys_user(user_name, user_password, user_email, user_info, head_img, create_time) VALUES (?,?,?,?,?,?) , (?,?,?,?,?,?)

DEBUG [main] - ==> Parameters: test0(String), 123456(String), [e-mail](String), null, null, null, test1(String), 123456(String), [e-mail](String), null, null, null

DEBUG [main] - <== Updates: 2

1035

1036

3. foreach 實現動態update

假設有這樣1個需求：根據傳入的Map參數更新用戶信息。

首先，我們在接口SysUserMapper中添加如下方法：

/**
 * 通過Map更新列
 *
 * @param map
 * @return
 */
int updateByMap(Map<String, Object> map);

然后在對應的SysUserMapper.xml中添加如下代碼：

<update id="updateByMap">
    UPDATE sys_user
    SET
    <foreach collection="_parameter" item="val" index="key" separator=",">
        ${key} = #{val}
    </foreach>
    WHERE id = #{id}
</update>

最后，在SysUserMapperTest測試類中添加如下測試方法：

@Test
public void testUpdateByMap() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        Map<String, Object> map = new HashMap<String, Object>();
        map.put("id", 1L);
        map.put("user_email", "[e-mail]");
        map.put("user_password", "12345678");

        Assert.assertEquals(1, sysUserMapper.updateByMap(map));

        SysUser sysUser = sysUserMapper.selectById(1L);
        Assert.assertEquals("[e-mail]", sysUser.getUserEmail());
        Assert.assertEquals("12345678", sysUser.getUserPassword());
    } finally {
        sqlSession.close();
    }
}

運行測試代碼，測試通過，輸出日志如下：

DEBUG [main] - ==> Preparing: UPDATE sys_user SET user_email = ? , user_password = ? , id = ? WHERE id = ?

DEBUG [main] - ==> Parameters: [e-mail](String), 12345678(String), 1(Long), 1(Long)

DEBUG [main] - <== Updates: 1

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE id = ?

DEBUG [main] - ==> Parameters: 1(Long)

TRACE [main] - <== Columns: id, user_name, user_password, user_email, create_time

TRACE [main] - <== Row: 1, admin, 12345678, [e-mail], 2019-06-27 18:21:07.0

DEBUG [main] - <== Total: 1

上面示例中，collection使用的是默認值_parameter，也可以使用@Param指定參數名字，如下所示：

int updateByMap(@Param("userMap") Map<String, Object> map);

<update id="updateByMap">
    UPDATE sys_user
    SET
    <foreach collection="userMap" item="val" index="key" separator=",">
        ${key} = #{val}
    </foreach>
    WHERE id = #{userMap.id}
</update>

4. 源碼及參考

源碼地址：https://github.com/zwwhnly/mybatis-action.git，歡迎下載。

劉增輝《MyBatis從入門到精通》

原創不易，如果覺得文章能學到東西的話，歡迎點個贊、評個論、關個注，這是我堅持寫作的最大動力。

如果有興趣，歡迎添加我的微信：zwwhnly，等你來聊技術、職場、工作等話題（PS：我是一名奮斗在上海的程序員）。