MyBatis的foreach语句详解

转载 已于 2024-04-11 09:54:21 修改 · 1.3w 阅读 · 1 ·
CC 4.0 BY-SA版权
原文链接：https://blog.youkuaiyun.com/lixiang987654321/article/details/83585508
文章标签：

#mybatis #windows

于 2018-04-23 14:34:59 首次发布
本文详细介绍了MyBatis中foreach属性的使用方法，包括单参数为array、List和Map类型的情况，并提供了相应的XML配置示例。

foreach 属性介绍

foreach 用于迭代传入过来的参数。 
它的属性介绍分别是

  • collection：表示传入过来的参数的数据类型。该参数为必选。要做 foreach 的对象，作为入参时，List 对象默认用 list 代替作为键，数组对象有 array 代替作为键，Map 对象没有默认的键。当然在作为入参时可以使用 @Param(“keyName”) 来设置键，设置 keyName 后，list,array 将会失效。 除了入参这种情况外，还有一种作为参数对象的某个字段的时候。举个例子： 
    如果 User 有属性 List ids。入参是 User 对象，那么这个 collection = “ids” 如果 User 有属性 Ids ids;其中 Ids 是个对象，Ids 有个属性 List id;入参是 User 对象，那么 collection = “ids.id” 
    • 如果传入的是单参数且参数类型是一个 List 的时候，collection 属性值为 list
    • 如果传入的是单参数且参数类型是一个 array 数组的时候，collection 的属性值为 array
    • 如果传入的参数是多个的时候，我们就需要把它们封装成一个 Map 了，当然单参数也可以封装成 map。
  • item： 循环体中的具体对象。支持属性的点路径访问，如 item.age,item.info.details。具体说明：在 list 和数组中是其中的对象，在 map 中是 value，该参数为必选。（它是每一个元素进行迭代时的别名）
  • index：在 list 和数组中,index 是元素的序号；在 map 中，index 是元素的 key。
  • open：表示该语句以什么开始
  • close：表示该语句以什么结束
  • separator：表示在每次进行迭代之间以什么符号作为分隔符

介绍完属性之后，下面就进入实践。首先先来看一个简单到爆炸的表（表名：t_test_foreach）

这里写图片描述

（1）array

List<CarnumberAlarm> selectByDeviceIdAndTime(String[] ids);

xml配置：
    <if test="ids != null and ids.length > 0" >
        deviceId in 
        <foreach collection="array" open="(" separator="," close=")" item="item" index="index">
            #{item,jdbcType=VARCHAR}
        </foreach>
    </if>

（2）list

List<CarnumberAlarm> selectByDeviceIdAndTime(List<String> ids);

xml配置：
    <if test="ids != null and ids.size() > 0" >
        deviceId in 
        <foreach collection="list" open="(" separator="," close=")" item="item" index="index">
            #{item,jdbcType=VARCHAR}
        </foreach>
    </if>


   <!--list<String>-->
    <select id="getSocketNumList" parameterType="com.ex.application.model.dto.ScoketNumDTO" resultType="com.ex.application.model.dto.ScoketNumDTO">
        select sn,station_sn,socket_number,member_sn,state from socket where 1=1
        <if test="station_sn != null and station_sn != ''">
        station_sn = #{station_sn}
        </if>
        <if test="station_sns != null and station_sns.size() > 0" >
           and station_sn in
            <foreach collection="station_sns" open="(" separator="," close=")" item="item" index="index">
                #{item,jdbcType=VARCHAR}
            </foreach>
        </if>
    </select>

（3）map

List<CarnumberAlarm> selectByDeviceIdAndTime(Map<String, Object> params);

xml配置：
    <if test="ids != null and ids.size() > 0" >
        deviceId in 

        <!--collection属性是map.key,其它所有属性都是map.key-->
        <foreach collection="ids" open="(" separator="," close=")" item="item" index="index">
            #{item,jdbcType=VARCHAR}
        </foreach>
    </if>

单参数是 array /list类型

  <delete id="deleteByList">
        delete from goods where id in
        <foreach collection="list" open="(" separator="," close=")" item="haha">
            #{haha}
        </foreach>
        
    </delete>


//批量操作  (返回影响了几条数据的一个int 数字)
    public Integer deleteByList(List<GoodsInfo> list);

测试类

// ids = {1,2,3}
public List<User> testFindByArray(int[] ids) throws Exception {
    SqlSession sqlSession = getSession().openSession();
    userList = sqlSession.selectList(NameSpace + ".findByArray", ids);
    System.out.println(userList.toString());
    sqlSession.close();
    return userList;
}

mapper.xml

<!--这里的 item 值可以和传递过来的参数名不一样，在介绍属性的时候已经说过这是一个别名了。比如可以修改成如下代码：
    <foreach collection="array" item="id" index="index" open="(" close=")" separator=",">
        #{id}   <!--这里要和 item 值保持一致-->
    </foreach>
-->
<select id="findByArray" resultType="com.test.foreach.User">
    SELECT id,`name` FROM t_test_foreach WHERE id IN
    <foreach collection="array" item="ids" index="index" open="(" close=")" separator=",">
        #{ids}
    </foreach>
</select>

输出结果

DEBUG - ==>  Preparing: SELECT id,`name` FROM t_test_foreach WHERE id IN ( ? , ? , ? ) 
DEBUG - ==> Parameters: 1(Integer), 2(Integer), 3(Integer)
DEBUG - <==      Total: 3
[User{name='n1', id='1'}, User{name='n2', id='2'}, User{name='n3', id='3'}]

单参数是 List 类型

测试类

// List 元素有 1，3，5
public List<User> testFindByList(List<Integer> ids) throws Exception {
    SqlSession sqlSession = getSession().openSession();
    userList = sqlSession.selectList(NameSpace + ".findByList", ids);
    System.out.println(userList.toString());
    sqlSession.close();
    return userList;
}

mapper.xml

<select id="findByList" resultType="com.test.foreach.User">
    SELECT id,`name` FROM t_test_foreach WHERE id IN
    <foreach collection="list" item="ids" index="index" open="(" close=")" separator=",">
        #{ids}
    </foreach>
</select>

输出结果

DEBUG - ==>  Preparing: SELECT id,`name` FROM t_test_foreach WHERE id IN ( ? , ? , ? ) 
DEBUG - ==> Parameters: 1(Integer), 3(Integer), 5(Integer)
DEBUG - <==      Total: 3
[User{name='n1', id='1'}, User{name='n3', id='3'}, User{name='n5', id='5'}]

单参数是 Map 类型

测试类

// Map<String, Object> 中的元素有 int[] ids = {2, 4};map.put("ids", ids);
public List<User> testFindByMap(Map map) throws Exception {
    SqlSession sqlSession = getSession().openSession();
    System.out.println(map.toString());
    List<Object> objects = sqlSession.selectList(NameSpace + ".findByMap", map);
    System.out.println(objects.toString());
    sqlSession.close();
    return userList;
}

mapper.xml

<!--注意 collection 值是 ids，即要进行迭代的对象。觉得有点懵的伙伴可以回到最开始介绍 collection 属性那里看看,不要急-->
<select id="findByMap" resultType="com.test.foreach.User">
    SELECT id,`name` FROM t_test_foreach WHERE id IN
    <foreach collection="ids" item="id" index="index" open="(" close=")" separator=",">
        #{id}
    </foreach>
</select>

输出结果

DEBUG - ==>  Preparing: SELECT id,`name` FROM t_test_foreach WHERE id IN ( ? , ? ) 
DEBUG - ==> Parameters: 2(Integer), 4(Integer)
DEBUG - <==      Total: 2
[User{name='n2', id='2'}, User{name='n4', id='4'}]

多参数

这种情况在传参数时，一定要改用 Map 方式

测试类

public void testUpdateByParams(int[] ids,String name) throws Exception {
    SqlSession sqlSession = getSession().openSession();
    Map<String,Object> map = new HashMap<String, Object>();
    map.put("ids",ids); // ids = {1,2,4}
    map.put("name",name);// name = "updated"
    sqlSession.selectList(NameSpace + ".findByParams", map);
    sqlSession.close();
}

mapper.xml

<select id="findByParams">
    UPDATE t_test_foreach SET `name` = '#{name}' WHERE id IN
    <foreach collection="ids" item="item" index="index" open="(" close=")" separator=",">
        #{item}
    </foreach>
</select>

输出结果

DEBUG - ==>  Preparing: UPDATE t_test_foreach SET `name` = ? WHERE id IN ( ? , ? , ? ) 
DEBUG - ==> Parameters: updated(String), 1(Integer), 2(Integer), 4(Integer)

这里写图片描述

尊重他人劳动成果，转载请注明出处： 
mybatis foreach 属性及其三种使用情况_mybatis foreach object-优快云博客

参考文章： 
Mybatis 示例之 foreach （上）_mybatis的foreach-优快云博客 
MyBatis的foreach语句详解-优快云博客

mybatis中foreach使用
冬阳
04-25 3678
mybatis使用foreach标签
mybatis 批量更新update详解
GSON的博客
07-03 2万+
1 更新单条记录 UPDATE course SET name='course1'WHEREid='id1'; 2 更新多条记录的同一个字段为同一个值 UPDATEcourseSETname='course1'WHEREidin('id1','id2','id3); 3更新多条记录为多个字段为不同的值 比较普通的写法，是通过循环，依次执行update语句。 Mybatis写法如下： <update id="updateBatch" paramete...
MyBatis foreach循环Map实战：5分钟掌握key-value遍历的3种写法
最新发布
VarFun的博客
11-17 395
掌握MyBatis foreach循环Map的key-value遍历技巧，解决动态SQL拼接难题。详解三种写法适用不同场景，支持List、Map参数灵活传参，提升SQL可读性与执行效率。语法清晰、易于维护，值得收藏。
Mybatis之foreach遍历Map实现
it_lxg123的博客
11-17 1万+
动态生成sql语句的查询条件，可以用mybatis的foreach 实现。 foreach元素的属性主要有item，index，collection，open，separator，close。 （1）item：集合中元素迭代时的别名，该参数为必选。 （2）index：在list和数组中,index是元素的序号，在map中，index是元素的key，该参数可选 （3）open：foreach代码的开始符号，一般是(和close=")"合用。常...
mybatis foreach 属性及其三种使用情况
七淅的博客
07-19 2万+
foreach 属性介绍 单参数是 array 类型 单参数是 List 类型 单参数是 Map 类型 多参数foreach 属性介绍foreach 用于迭代传入过来的参数。 它的属性介绍分别是 collection：表示传入过来的参数的数据类型。该参数为必选。要做 foreach 的对象，作为入参时，List 对象默认用 list 代替作为键，数组对象有 array 代替作为键，Map 对象没有
Myibatis foreach
一生有你(Java)
07-06 1967
foreach的主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。foreach元素的属性主要有item，index，collection，open，separator，close。item表示集合中每一个元素进行迭代时的别名，index指定一个名字，用于表示在迭代过程中，每次迭代到的位置，open表示该语句以什么开始，separator表示在每次进行迭代之间以什么符号作为分隔符，cl
mybatis foreach标签的使用详解
08-19
MyBatis foreach 标签的使用详解 MyBatis 中的 foreach 标签是非常常用的标签之一，它可以用来遍历集合，构建 in 条件语句或者批量操作语句。本文将详细介绍 MyBatis foreach 标签的使用详解。 foreach 标签的基本...
mybatis之foreach用法详解
08-25
MyBatis Foreach用法详解 MyBatis是当前最流行的持久层框架之一，提供了强大灵活的SQL映射功能。其中，foreach元素是MyBatis中一个非常强大且灵活的元素，能够动态生成SQL语句的查询条件。但是，foreach元素的使用...
mybatis foreach标签的说明
11-11
MyBatis foreach 标签的详解MyBatis 中的 foreach 标签是一种常用标签，常用于遍历集合并构建 SQL 语句。本文旨在深入解析该标签的使用方法及应用场景。foreach 标签的基本语法如下所示：```xml<foreach collection=...
mybatis动态sql语句详解
04-28
### MyBatis动态SQL语句详解 #### 一、MyBatis简介 MyBatis是一个优秀的持久层框架，它支持自定义SQL语句、存储过程以及高级映射功能。通过使用MyBatis，开发人员可以避免编写大量的JDBC代码和手动设置参数以及...
mybatis注解开发使用foreach
xzj80927的博客
06-05 1万+
写法看代码： @Select( " <script>" + " select id, user_id userId, batch_number batchNumber, unit_name unitName, word_detail wordDetail,word, score, create_time createTime " + ...
【MyBatis框架】Foreach详解
Java—wang的博客
04-06 258
Foreach： 用于条件是一个范围时使用。 使用： 编写接口： List<Book> queryBookByForeach(Map map); 编写xml配置文件 <select id="queryBookByForeach" parameterType="map" resultType="Book"> select * from book <where> <foreach collectio
【MyBatis】＜foreach＞ 详解
weixin_63466958的博客
02-21 1566
动态 SQL 的另一个常见使用场景是对集合进行遍历（尤其是在构建 IN 条件语句的时候）。foreach元素的功能非常强大，它允许你，声明可以在元素体内使用的以及集合项迭代之间的。这个元素也不会错误地添加多余的分隔符，看它多智能！：你可以将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象作为传递给foreach。当使用可迭代对象或者数组时，index 是当前迭代的序号，item 的值是本次迭代获取到的元素。
Mybatis 示例之 foreach （上）
热门推荐
偶尔记一下 - mybatis.io
03-14 12万+
（由于csdn抽风，所以删除两篇重复内容重发） foreach一共有三种类型，分别为List,[](array),Map三种。 foreach的第一篇用来将List和数组(array)。 下面表格是我总结的各个属性的用途和注意点。 foreach属性 属性 描述 item 循环体中的具体对象。支持属性的点路径访问，如item.age,it
MyBatis之foreach的用法
qq_20236937的博客
05-16 1万+
MyBatis提供foreach语句实现In查询。foreach语法如下：collection：该属性的对应方法的参数类型可以是List、数组、Map。如果方法的参数类型不属于前三种，则必须和方法参数@Param指定的元素名一致。item： 表示迭代过程中每个元素的别名。可以随便起名，但是必须跟元素中的#{}里面的名称一致。index：表示迭代过程中每次迭代到的位置(下标)open：前缀close：后缀separator：分隔符，表示迭代时每个元素之间以什么分隔。
mybatis forEach
03-13
<think>嗯，用户想了解MyBatis中forEach标签的用法，需要详细的使用方法和示例。首先，我得回忆一下MyBatis的foreach标签的基本结构和参数。根据引用的内容，foreach标签用于遍历集合，生成动态SQL，比如IN语句或者批量插入。 用户可能已经知道一些基础，但需要具体的示例和参数说明。比如collection属性应该对应传入的参数名称，item是每个元素的别名，还有open、separator、close这些属性控制循环生成的内容结构。引用里的示例代码显示，foreach可以放在where条件里生成多个OR条件，或者用逗号分隔的列表。 然后要分步骤讲解，可能先介绍基本语法，再讲参数含义，接着给出不同场景的例子，比如IN查询、批量插入、动态条件组合。每个例子需要结合代码片段，并且说明各个参数的作用。比如在批量插入时，使用foreach包裹插入的值，用逗号分隔。 还要注意用户可能的疑问点，比如collection属性的不同情况，当参数是List或者数组时，名称的写法可能不同。比如直接传入List的话，collection应该用"list"，而如果是Map中的某个key，就要用对应的名称。这点需要明确说明，避免用户混淆。 另外，常见应用场景也很重要，用户可能想知道什么时候该用foreach，比如批量操作、动态IN子句、多条件查询。需要结合引用中的信息，说明这些场景下的具体使用方法。 最后要确保示例代码的正确性，比如XML中的标签语法是否正确，参数占位符是否正确使用#{}。同时，提醒用户注意SQL注入的问题，虽然MyBatis的#{}是预编译的，但使用foreach时还是要注意集合参数的合法性。 可能还需要对比一下不同的循环结构，比如在批量插入和条件查询中的不同配置，separator的使用区别，以及open和close如何包裹整个循环生成的内容。比如在IN子句中，open是"("，close是")"，而separator是","，这样生成的SQL就是(值1, 值2, 值3)。 总结下来，回答的结构应该是：基本语法、参数说明、不同场景的示例、常见应用场景，以及注意事项。这样用户能逐步了解foreach的用法，并且知道如何应用到实际开发中。</think>### MyBatis中`<foreach>`标签的用法详解 `<foreach>`标签是MyBatis中用于动态生成SQL语句的核心标签之一，**主要用于遍历集合参数并拼接SQL片段**，在批量操作、动态条件查询等场景中广泛应用。以下是具体用法和示例： --- #### 一、基本语法与参数 ```xml <foreach collection="集合参数名" item="遍历元素别名" index="遍历索引别名" open="起始符号" separator="分隔符" close="结束符号"> #{item} </foreach> ``` - **`collection`**：必填，指定需遍历的集合参数名，若参数直接为`List`类型则用`list`，若为Map中的某个键则需对应键名[^4]。 - **`item`**：必填，定义集合中每个元素的引用名。 - **`open`/`close`**：定义循环体开始和结束时的符号（如`(`或`IN`语句的括号）。 - **`separator`**：定义元素间的分隔符（如逗号`,`或`OR`）。 --- #### 二、常见应用场景与示例 1. **动态IN查询** 根据用户ID列表查询用户信息： ```xml <select id="selectUsersByIds" resultType="User"> SELECT * FROM user WHERE id IN <foreach collection="ids" item="id" open="(" separator="," close=")"> #{id} </foreach> </select> ``` - 若传入`ids = [1,2,3]`，生成的SQL为：`WHERE id IN (1,2,3)`[^3]。 2. **批量插入数据** 插入多条用户记录： ```xml <insert id="batchInsertUsers"> INSERT INTO user (name, email) VALUES <foreach collection="userList" item="user" separator=","> (#{user.name}, #{user.email}) </foreach> </insert> ``` - 若传入`userList`包含3个对象，生成的SQL为：`VALUES (a,a@test.com), (b,b@test.com), (c,c@test.com)`[^1]。 3. **动态组合条件** 多条件筛选（如根据用户名或邮箱列表查询）： ```xml <select id="selectByConditions" resultType="User"> SELECT * FROM user <where> <foreach collection="names" item="name" open="AND (" separator="OR" close=")"> name = #{name} </foreach> <foreach collection="emails" item="email" open="AND (" separator="OR" close=")"> email = #{email} </foreach> </where> </select> ``` - 生成的SQL可能为：`WHERE (name = 'Alice' OR name = 'Bob') AND (email = 'a@test.com')`[^3]。 --- #### 三、注意事项 1. **集合参数类型** - 若接口方法参数为`List`，`collection`需设置为`list`。 - 若参数为`Map`中的某个键，例如`map.put("ids", list)`，则`collection="ids"`。 2. **性能优化** 批量操作时需控制单次处理的数据量（如分批次插入），避免SQL过长导致数据库性能下降。 3. **SQL注入** MyBatis通过`#{}`预编译机制防止注入，但需确保传入的集合参数合法[^2]。 ---
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值