mybatis foreach（长文解析）

💡一则或许对你有用的小广告

欢迎加入小哈的星球 ，你将获得：专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论

• 新项目:《从零手撸：仿小红书（微服务架构）》 正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...，点击查看项目介绍 ;
• 《从零手撸：前后端分离博客项目（全栈开发）》 2 期已完结，演示链接： http://116.62.199.48/ ;

截止目前， 星球 内专栏累计输出 82w+ 字，讲解图 3441+ 张，还在持续爆肝中.. 后续还会上新更多项目，目标是将 Java 领域典型的项目都整一波，如秒杀系统, 在线商城, IM 即时通讯，权限管理，Spring Cloud Alibaba 微服务等等，已有 2900+ 小伙伴加入学习 ，欢迎点击围观

在 Java 开发领域，MyBatis 是一款广泛使用的持久层框架，因其灵活的 SQL 写法和与数据库的高效交互而备受开发者青睐。在 MyBatis 的众多功能中，foreach 标签因其强大的动态 SQL 生成能力，成为处理批量操作、复杂条件查询的“瑞士军刀”。无论是处理多条件查询、批量插入，还是构建动态的 IN 子句，foreach 都能通过简洁的语法实现复杂的逻辑。本文将从零开始，结合实际案例和代码示例，深入解析 mybatis foreach 的核心用法、应用场景及常见技巧，帮助开发者快速掌握这一工具。

一、MyBatis foreach 的基本语法

1.1 基础结构与参数类型

foreach 标签的核心作用是遍历集合或数组，生成重复的 SQL 片段。其基本语法如下：

<foreach collection="collectionName" item="itemName" open="(" separator="," close=")">  
  #{itemName}  
</foreach>  

• collection：指定需要遍历的集合名称，通常对应参数中的 List、Set 或数组。
• item：遍历时的单个元素变量名，可在内部 SQL 中引用。
• open、separator、close：分别表示遍历前、元素间的分隔符、遍历后的闭合符号。

例如，当需要生成 IN 条件时：

<select id="selectUsersByIds" resultType="User">  
  SELECT * FROM users WHERE id IN  
  <foreach collection="list" item="id" open="(" separator="," close=")">  
    #{id}  
  </foreach>  
</select>  

此时，若传入的参数是一个 List<Long>，最终生成的 SQL 可能是：

SELECT * FROM users WHERE id IN (1, 2, 3)  

1.2 参数类型的选择与绑定

foreach 的参数类型需与传入的集合类型一致。例如：

• 若参数是 List<Long>，则 collection="list"（默认值）；
• 若参数是 Map 中的某个集合，如 Map<String, List<Long>>，则需指定 collection="map.key"。

示例：

// Java 代码  
Map<String, Object> params = new HashMap<>();  
params.put("ids", Arrays.asList(1L, 2L, 3L));  

// MyBatis XML  
<foreach collection="ids" item="id" ...>  

二、常见场景与实战案例

2.1 动态 IN 查询

场景：根据用户输入的多个 ID 查询对应的记录。
解决方案：通过 foreach 生成动态的 IN 条件。

<select id="selectByIds" resultType="User">  
  SELECT * FROM users  
  WHERE id IN  
  <foreach item="id" collection="ids" open="(" separator="," close=")">  
    #{id}  
  </foreach>  
</select>  

Java 调用：

List<User> users = userMapper.selectByIds(Arrays.asList(1L, 2L, 3L));  

2.2 动态 UPDATE 的 SET 子句

场景：批量更新多个字段，且每个字段的值可能不同。
解决方案：使用 foreach 遍历 Map 中的键值对，动态生成 SET 子句。

<update id="updateUserFields">  
  UPDATE users  
  SET  
  <foreach collection="fields" item="entry" separator=",">  
    ${entry.key} = #{entry.value}  
  </foreach>  
  WHERE id = #{id}  
</update>  

Java 调用：

Map<String, Object> fields = new HashMap<>();  
fields.put("name", "Alice");  
fields.put("age", 25);  
userMapper.updateUserFields(fields, 1L);  

生成的 SQL：

UPDATE users SET name = 'Alice', age = 25 WHERE id = 1  

2.3 多表 JOIN 的动态条件

场景：根据多个关联表的条件动态拼接 JOIN 语句。
解决方案：通过 foreach 遍历关联条件，生成多个 JOIN 子句。

<select id="queryOrdersWithConditions" resultType="Order">  
  SELECT * FROM orders  
  <foreach collection="joins" item="join" separator=" ">  
    ${join}  
  </foreach>  
  WHERE ...  
</select>  

Java 调用：

List<String> joins = Arrays.asList(  
  "LEFT JOIN users ON orders.user_id = users.id",  
  "INNER JOIN products ON orders.product_id = products.id"  
);  
List<Order> orders = orderMapper.queryOrdersWithConditions(joins);  

三、高级技巧与性能优化

3.1 分页与 foreach 的结合

在批量操作中，结合分页可以避免 SQL 语句过长导致的性能问题。例如，使用 LIMIT 或 ROWNUM 限制单次查询的行数。

<select id="selectBatch" resultType="User">  
  SELECT * FROM users  
  WHERE id IN  
  <foreach collection="ids" item="id" open="(" separator="," close=")">  
    #{id}  
  </foreach>  
  LIMIT #{offset}, #{pageSize}  
</select>  

3.2 参数类型优化：使用 Map 聚合复杂条件

当参数包含多个集合或动态条件时，可通过 Map 将参数统一管理。例如：

Map<String, Object> params = new HashMap<>();  
params.put("ids", idsList);  
params.put("status", status);  

在 XML 中通过 ${key} 访问：

<foreach collection="ids" item="id" ...>  

3.3 性能陷阱与解决方案

• SQL 注入风险：避免直接拼接字符串（如 ${}），应优先使用 #{} 进行参数化查询。
• 索引失效：IN 条件中元素过多可能导致全表扫描，建议拆分为多次查询或使用临时表。

四、常见误区与问题解答

4.1 集合为空时的异常处理

若传入的集合为空，foreach 可能生成无效的 SQL（如 WHERE id IN ()）。可通过 <if> 标签判断集合是否非空：

<if test="ids != null and ids.size() > 0">  
  <foreach ...> ... </foreach>  
</if>  

4.2 分页与 foreach 的兼容性

在分页场景中，若需动态生成 ORDER BY 子句，可通过 foreach 遍历排序字段：

<foreach collection="sortFields" item="field" separator=", ">  
  ${field} ${directions[field]}  
</foreach>  

五、结论

mybatis foreach 是开发者应对动态 SQL 和批量操作的利器，其简洁的语法和强大的扩展性使其在各类场景中大放异彩。从基础的 IN 查询到复杂的多表关联，开发者只需掌握其核心参数和常见用法，即可快速构建高效、灵活的数据库交互逻辑。

通过本文的案例解析和技巧总结，读者不仅能理解 foreach 的工作原理，还能根据实际需求设计出优雅的解决方案。在后续的开发中，建议结合具体业务场景，进一步探索 foreach 与其他 MyBatis 标签（如 <if>、<choose>）的组合使用，以实现更复杂的动态 SQL 需求。

关键词布局示例：

• 标题中直接使用“mybatis foreach”作为核心关键词；
• 在代码示例和场景描述中自然提及关键词，如“通过 mybatis foreach 动态生成 SQL”；
• 在高级技巧和问题解答中，通过对比或总结再次强化关键词的关联性。