MyBatis中foreach的用法

foreach 说明

你可以传递一个 list 实例或者 array 数组作为参数对象传给 MyBatis。当你这么做的时候，MyBatis 会自动将它包装在一个 Map 中，用名称作为键。list 实例将会以 list 作为键，而 array 数组实例将会以 array 作为键

foreach 元素的属性主要有 item，index，collection，open，separator，close

• item：表示集合中每一个元素进行迭代时的别名
• index：指定一个名字，用于表示在迭代过程中，每次迭代到的位置
• open：表示该语句以什么开始
• separator：表示在每次进行迭代之间以什么符号作为分隔符
• close：表示以什么结束

在使用 foreach 时最关键的也是最容易出错的就是 collection 属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有一下 3 种情况

• 如果传入的是单参数且参数类型是一个 List 时，collection 属性值为 list
• 如果传入的是单参数且参数类型是一个 array 数组时，collection 的属性值为 array
• 如果传入的参数是多个时，可以把它们封装成一个 Map，collection 的属性值为 Map 的键
• 如果传入的参数是多个时，也可以把它们封装成一个 Object

foreach 使用示例

传递单个 List

public List<User> selectByList(List<User> list);

<select id="selectByList" parameterType="java.util.List" resultType="user">
	select * from user 
	<where>
		<!-- 传递List，List中是pojo -->
		<if test="list!=null">
    		<foreach collection="list" item="item" open="and id in(" separator="," close=")">
        		#{item.id} 
    		</foreach>
		</if>
	</where>
</select>

传递单个数组

public int deleteByIds(String[] ids);

<delete id="deleteByIds" parameterType="java.lang.String">
	DELETE FROM cms_article
	WHERE article_id in
		<foreach item="item" index="index" collection="array"  open="(" separator="," close=")">
	 		#{item}
  		</foreach>
</delete>

封装成 Map

List<String> list = new ArrayList<>();
list.add("1");
list.add("2");
list.add("3");

Map<String, Object> map = new HashMap<>();  
map.put("userids", list);

List<UserInfo> selectUserInfoByForEach(Map<String,Object> map);

<select id="selectUserInfoByForEach" parameterType="java.util.Map" resultMap="UserInfoResult">  
	select * from userinfo  
    <if test="userids!=null">  
    	where userid in  
        <foreach item="ParamsId" collection="userids" index="index"  open="(" separator="," close=")">  
        	#{ParamsId}  
        </foreach>  
    </if>  
</select> 

• collection="userids" 这个 userids 是 Map 的键