<foreach>
元素是MyBatis 提供的一种用于数组和集合循环遍历的方式,我们可以用它来对批量查询进行简化。例如当我们需要查询数据库中id在10到20之间的数据,我们可以将查询语句放入for循环中,循环id,再根据id进行查询。但是这种方式需要不断的查询数据库,现在只是10条数据,如果是100条1000条,甚至是10000条,这种查询方式的效率是非常低的。
通过 <foreach>
元素,就可以很好的解决上面的问题。
<!-- foreach元素使用 -->
<select id="findCustomerByIds" parameterType="List" resultType="com.gx.po.Customer">
select * from t_customer where id in
<foreach collection="list" item="id" index="index" open="(" separator="," close=")">
#{id}
</foreach>
</select>
在上述代码中,使用了<foreach>
元素对传入的集合进行遍历并进行了动态SOL组装。 关于
<foreach>
元素中使用的几种属性的描述具体如下。
item:
配置的是循环中当前的元素。index:
配置的是当前元素在集合的位置下标。collection:
配置的list 是传递过来的参数类型(首字母小写),它可以是一个array、list (或collection)、 Map集合的键、POJO包装类中数组或集合类型的属性名等。open和close:
配置的是以什么符号将这些集合元素包装起来。separator:
配置的是各个元素的间隔符。
需要注意的是,我们可以将任何可选代对象(如列表、 集合等)和任何的字典或者数组对象传递给<foreach>
作为集合参数。 当使用可选代对象或者数组肘,index是当前选代的次数,item的值是本次选代获取的元素。当使用字典(或者Map.Entry对象的集合)时,index是键,item是值。
之后我们可以在测试类中测试动态SQL代码
@Test
public void findCustomerByIdsTest(){
//获取SqlSession
SqlSession sqlSession = MyBatisConfig.getSqlSession();
//创建List集合,用来封装查询id
List<Integer> list = new ArrayList<Integer>();
for(int i=10;i<=20;i++){
//循环遍历查询条件id,并添加到List中
list.add(i);
}
//执行SqlSession查询
List<Customer> customers = sqlSession.selectList("com.gx.mapper.CustomerMapper.findCustomerByIds",list);
for (Customer customer : customers) {
//输出查询结果
System.out.println(customer);
}
//关闭连接
sqlSession.close();
}
运行结果是id为10—20的数据:
使用 <foreach>
元素最需要注意的也是最容易出错的就是 collection 属性,该属性是必须指定的,而且在不同的情况下的属性值是不一样的。
- 如果传入的是单参数且参数类型一个数组或者List 的时候, collection 属性值分别为array和Iist (或collection)。
- 如果如果传入的参数是多小的时候,就需要把它们封装成一个Map 了,当然单参数也可以封装成Map集合, 这时候collection属性值就为Map的键。
- 如果传入的参数是POJO包装类的时候,collection属性值就为该包装类中需要进行遍历的数组或集合的属性名。
所以在设置collection属性值的时候,必须按照实际情况配直,否则程序就会出现异常。