5 MyBatis动态sql中foreach标签的使用

1 MyBatis动态SQL之if 语句
2 MyBatis动态sql之where标签|转
3 MyBatis动态SQL之set标签|转
4 MyBatis动态SQL之trim元素|转
5 MyBatis动态sql中foreach标签的使用
6 MyBatis动态SQL之choose(when、otherwise)语句
7 MyBatis动态SQL之bind标签|转

  关于动态SQL另外一个常用的功能就是使用foreach标签对一个集合进行遍历，尤其是在构建IN条件语句的时候。

  案例1 Spring Boot项目中，Dao层代码片段如下：

    // 查询指定ID的员工
    List<Employee> selectEmployeeIn(Long[] ids);

  xml文件代码片段如下：

	<select id="selectEmployeeIn" resultType="cn.mybatis.domain.Employee">
		SELECT * FROM tb_employee
		<where>
			<if test="ids != null">
				<foreach item="item" index="index" collection="ids"
						 open="id in (" separator="," close=")" nullable="true">
					#{item}
				</foreach>
			</if>
		</where>
	</select>

  foreach 元素的功能非常强大，它允许你指定一个集合，声明可以在元素体内使用的集合项（item）和索引（index）变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。这个元素也不会错误地添加多余的分隔符，看它多智能！

  温馨提示 你可以将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象作为集合参数传递给 foreach。当使用可迭代对象或者数组时，index 是当前迭代的序号，item 的值是本次迭代获取到的元素。当使用 Map 对象（或者 Map.Entry 对象的集合）时，index 是键，item 是值。

  假如在上述案例中，请求参数为int[] ids = {1,2,3,4,5}，那么，调用selectEmployeeIn后，控制台打印的SQL如下：

SELECT * FROM tb_employee where id in (1,2,3,4,5)

  如果把请求参数封装为map，如下：

public void selectPostIn() {
    final List<Long> ids = new ArrayList<Long>();
    ids.add(1L);
    ids.add(2L);
    ids.add(32L);
    Map<String,Long> maps = new HashMap();
    params.put("ids", ids);
    List<Employee> employeeList = employeeMapper.selectEmployeeIn(maps);
}

//---- Dao层修改 ------
 List<Employee> selectEmployeeIn(Map<String, Long> mapParam);

  则对应的xml仍然可以使用案例1中的selectEmployeeIn。

  foreach标签的主要属性描述如下：

• collection ：指定被遍历的集合，支持参数类型包括List、数组、Map和自定义对象，请注意，Dao和xml中的变量名必须一致。
• item：表示在迭代过程中每一个元素的别名，值可以自定义。
• index ：表示在迭代过程中，当前迭代到的位置（下标），一般很少使用。若遍历的是list或者数组，index代表下标；若遍历的是Map，index代表键。
• open ：前缀，即遍历开始时的拼接字符串。
• close ：后缀，即遍历结束时拼接的字符串。
• separator ：分隔符，表示遍历时每个元素之间以什么分隔。
• nullable：是否为空开关。如果启用该配置且设置为true，程序会在遇到null时自动跳过，而不是抛出异常。

  通常可以将foreach用到批量增删改查等操作中，关于批量删除和修改的介绍，请戳《Mybatis 批量操作-删除、修改和查询》。