Mybatis 示例之 foreach （上）

最新推荐文章于 2025-12-19 15:39:34 发布

原创最新推荐文章于 2025-12-19 15:39:34 发布 · 139 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

Mybatis 专栏收录该内容

10 篇文章

订阅专栏

本文详细介绍了MyBatis中foreach的使用方法，包括其三种类型：List、数组和Map，并通过具体的例子展示了如何配置foreach的不同属性，如item、collection、separator等。

foreach一共有三种类型，分别为List,[](array),Map三种。

foreach的第一篇用来将List和数组(array)。

下面表格是我总结的各个属性的用途和注意点。

foreach属性

属性	描述
`item`	循环体中的具体对象。支持属性的点路径访问，如item.age,item.info.details。具体说明：在list和数组中是其中的对象，在map中是value。该参数为必选。
`collection`	要做foreach的对象，作为入参时，List<?>对象默认用list代替作为键，数组对象有array代替作为键，Map对象用map代替作为键。当然在作为入参时可以使用@Param("keyName")来设置键，设置keyName后，list,array,map将会失效。除了入参这种情况外，还有一种作为参数对象的某个字段的时候。举个例子：如果User有属性List ids。入参是User对象，那么这个collection = "ids" 如果User有属性Ids ids;其中Ids是个对象，Ids有个属性List id;入参是User对象，那么collection = "ids.id" 上面只是举例，具体collection等于什么，就看你想对那个元素做循环。该参数为必选。
`separator`	元素之间的分隔符，例如在in()的时候，separator=","会自动在元素中间用“,“隔开，避免手动输入逗号导致sql错误，如in(1,2,)这样。该参数可选。
`open`	foreach代码的开始符号，一般是(和close=")"合用。常用在in(),values()时。该参数可选。
`close`	foreach代码的关闭符号，一般是)和open="("合用。常用在in(),values()时。该参数可选。
`index`	在list和数组中,index是元素的序号，在map中，index是元素的key，该参数可选。

下面是测试。

SQL

[sql] view plain copy

drop table users if exists;
create table users (
id int,
name varchar(20)
);
insert into users (id, name) values(1, 'User1');
insert into users (id, name) values(2, 'User2');
insert into users (id, name) values(3, 'User3');
insert into users (id, name) values(4, 'User4');
insert into users (id, name) values(5, 'User5');
insert into users (id, name) values(6, 'User6');

User类

Mapper.xml

[html] view plain copy

<select id="countByUserList" resultType="_int" parameterType="list">
select count(*) from users
<where>
id in
<foreach item="item" collection="list" separator="," open="(" close=")" index="">
#{item.id, jdbcType=NUMERIC}
</foreach>
</where>
</select>

测试代码：

[java] view plain copy

@Test
public void shouldHandleComplexNullItem() {
SqlSession sqlSession = sqlSessionFactory.openSession();
try {
Mapper mapper = sqlSession.getMapper(Mapper.class);
User user1 = new User();
user1.setId(2);
user1.setName("User2");
List<User> users = new ArrayList<User>();
users.add(user1);
users.add(null);
int count = mapper.countByUserList(users);
Assert.assertEquals(1, count);
} finally {
sqlSession.close();
}
}

测试日志：

DEBUG [main] - Logging initialized using 'class org.apache.ibatis.logging.slf4j.Slf4jImpl' adapter.
DEBUG [main] - Opening JDBC Connection
DEBUG [main] - Setting autocommit to false on JDBC Connection [org.hsqldb.jdbc.JDBCConnection@4b83b34e]
DEBUG [main] - Resetting autocommit to true on JDBC Connection [org.hsqldb.jdbc.JDBCConnection@4b83b34e]
DEBUG [main] - Closing JDBC Connection [org.hsqldb.jdbc.JDBCConnection@4b83b34e]
DEBUG [main] - Opening JDBC Connection
DEBUG [main] - Setting autocommit to false on JDBC Connection [org.hsqldb.jdbc.JDBCConnection@763d1932]
DEBUG [main] - ==> Preparing: select count(*) from users WHERE id in ( ? , ? )
DEBUG [main] - ==> Parameters: 2(Integer), null
DEBUG [main] - <== Total: 1
DEBUG [main] - Resetting autocommit to true on JDBC Connection [org.hsqldb.jdbc.JDBCConnection@763d1932]
DEBUG [main] - Closing JDBC Connection [org.hsqldb.jdbc.JDBCConnection@763d1932]