28. MyBatis中的`<foreach>`标签如何使用？有哪些常见应用场景？

PangHu大约 4 分钟

MyBatis中的<foreach>标签是一个功能强大的动态SQL标签，主要用于在SQL语句中循环遍历集合（如List、Set、数组等），从而生成动态的SQL查询、插入、更新或删除操作。<foreach>标签能够极大地提高SQL的灵活性和可维护性，适用于批量操作、动态查询条件的构建等场景。

1. `<foreach>` 标签的基本语法

<foreach>标签的基本语法如下：

<foreach collection="集合或数组" item="迭代变量" index="索引变量" open="开头字符串" separator="分隔符" close="结尾字符串">
    SQL片段
</foreach>

collection：指定要迭代的集合或数组的名称，这个名称对应Mapper方法中的参数名。
item：每次迭代的当前元素。
index：当前迭代的索引值，可选。
open：在生成的SQL语句开头添加的字符串（例如(）。
separator：每个元素之间的分隔符（例如,）。
close：在生成的SQL语句末尾添加的字符串（例如)）。

2. 常见的应用场景

2.1 批量插入

在批量插入操作中，<foreach>标签非常有用，可以用来遍历一个集合，并生成多个插入语句。

示例：批量插入用户记录

<insert id="insertUsers">
    INSERT INTO users (username, email)
    VALUES 
    <foreach collection="userList" item="user" separator=",">
        (#{user.username}, #{user.email})
    </foreach>
</insert>

解释：userList是Mapper方法的参数名，它代表一个包含多个User对象的集合。<foreach>标签会遍历这个集合，生成多个(#{user.username}, #{user.email})的值对，并用逗号分隔。

生成的SQL：

INSERT INTO users (username, email) VALUES ('John', 'john@example.com'), ('Jane', 'jane@example.com');

2.2 动态生成 `IN` 查询

当我们需要根据一个集合中的多个值来进行查询时，通常会使用IN子句。<foreach>标签可以动态地生成IN子句中的内容。

示例：根据ID列表查询用户

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

解释：idList是Mapper方法的参数名，代表一组用户ID。<foreach>标签将这个列表中的每个ID插入到IN子句中，并用逗号分隔。

生成的SQL：

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

2.3 批量更新

在批量更新的场景中，可以通过<foreach>标签生成多条UPDATE语句，或者通过动态条件进行批量更新。

示例：批量更新用户的电子邮件

<update id="updateUsers">
    <foreach collection="userList" item="user" separator=";">
        UPDATE users
        SET email = #{user.email}
        WHERE id = #{user.id}
    </foreach>
</update>

解释：<foreach>标签遍历userList集合，为每个用户生成一条更新语句，并用分号分隔。

生成的SQL：

UPDATE users SET email = 'newemail1@example.com' WHERE id = 1;
UPDATE users SET email = 'newemail2@example.com' WHERE id = 2;

2.4 动态生成多个条件

在一些查询场景中，我们可能需要根据不同的输入条件来动态生成SQL查询，<foreach>标签可以帮助我们轻松实现这一点。

示例：根据多个条件动态查询用户

<select id="findUsersByDynamicConditions" resultType="User">
    SELECT * FROM users
    WHERE 1=1
    <if test="usernameList != null and !usernameList.isEmpty()">
        AND username IN 
        <foreach collection="usernameList" item="username" open="(" separator="," close=")">
            #{username}
        </foreach>
    </if>
    <if test="emailList != null and !emailList.isEmpty()">
        AND email IN 
        <foreach collection="emailList" item="email" open="(" separator="," close=")">
            #{email}
        </foreach>
    </if>
</select>

解释：根据传入的用户名列表和电子邮件列表，动态生成IN子句，并组合到WHERE条件中。MyBatis会根据实际传入的参数值自动构建最终的SQL语句。

生成的SQL（假设两个列表都传入了值）：

SELECT * FROM users WHERE 1=1 AND username IN ('John', 'Jane') AND email IN ('john@example.com', 'jane@example.com');

3. 注意事项

空集合处理：如果传入的集合为空，<foreach>标签不会生成任何SQL片段。为了避免产生语法错误，可以在调用Mapper方法前进行空集合检查，或者在SQL中增加条件处理。
SQL注入风险：虽然<foreach>标签能够动态生成SQL片段，但要注意不要直接将用户输入的内容拼接到SQL中，以避免SQL注入风险。应使用#{}占位符进行参数绑定。
效率问题：批量更新操作时，要注意生成的SQL语句的数量，如果批量操作的数据量非常大，可能会产生大量的SQL语句，导致执行效率下降。在这种情况下，可以考虑使用JDBC的批处理能力来提高效率。

总结

<foreach>标签是MyBatis中非常灵活且实用的动态SQL生成工具，常用于处理批量插入、批量更新、动态IN查询和动态条件生成等场景。通过<foreach>标签，开发者可以有效地减少重复代码，提高SQL语句的可维护性和灵活性。