mybatis 中 foreach collection 的用法介绍

2019 Java 开发者跳槽指南.pdf (吐血整理)….>>>

首先看一个用法示例:

1
2
3
<foreach collection="list" item="item" open="(" close=")" separator="," index="">
    #{item.studentId}
</foreach>

每个参数代表的含义:

foreach的主要用在构建in条件中,它可以在SQL语句中进行迭代一个集合。
foreach元素的属性主要有 item,index,collection,open,separator,close。

item集合中每一个元素进行迭代时的别名,index表示在迭代过程中,每次迭代到的位置,open该语句以什么开始,separator在每次进行迭代之间以什么符号作为分隔 符,close以什么结束。

在使用foreach的时候最关键的也是最容易出错的就是collection属性,该属性是必须指定的,但是在不同情况 下,该属性的值是不一样的。

主要有一下3种情况:
1.     如果传入的是单参数且参数类型是一个List的时候,collection属性值为list
2.     如果传入的是单参数且参数类型是一个array数组的时候,collection的属性值为array
3.     如果传入的参数是多个的时候,我们就需要把它们封装成一个Map了

列举一些示例帮助理解

foreach如果传入的是单参数且参数类型是一个array数组的时候:

1
2
3
4
5
6
<select id="dynamicForeach2Test" parameterType="java.util.ArrayList" resultType="Blog">
     select * from t_blog where id in
     <foreach collection="array" index="index" item="item" open="(" separator="," close=")">
          #{item}
     </foreach>
</select>

XML对应的方法

1
2
3
4
5
6
7
8
9
10
@Test
public void dynamicForeach2Test() {
        SqlSession session = Util.getSqlSessionFactory().openSession();
        BlogMapper blogMapper = session.getMapper(BlogMapper.class);
        int[] ids = new int[] {1,3,6,9};
        List blogs = blogMapper.dynamicForeach2Test(ids);
        for (Blog blog : blogs)
        System.out.println(blog);    
        session.close();
}

 当查询的参数只有一个时:

findByIds(List<Long> ids)
如果参数的类型是List, 则在使用时,collection属性要必须指定为 list

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<select id="findByIdsMap" resultMap="BaseResultMap">     
Select     
<include refid="Base_Column_List" />    
from jria where ID in
         <foreach item="item" index="index" collection="list"
             open="(" separator="," close=")">
            #{item}
        </foreach>
 </select>  
 findByIds(Long[] ids) 1.b 如果参数的类型是Array,则在使用时,collection属性要必须指定为 array <select id="findByIdsMap" resultMap="BaseResultMap">
         select
         <include refid="Base_Column_List" />
     from jria where ID in
         <foreach item="item" index="index" collection="array"
             open="(" separator="," close=")">
            #{item}
        </foreach>
 </select>

当查询的参数有多个时:

例如 findByIds(String name, Long[] ids) 这种情况需要特别注意,在传参数时,一定要改用Map方式, 这样在collection属性可以指定名称

1
2
3
4
Map<String, Object> params = new HashMap<String, Object>(2);    
params.put("name", name);     
params.put("ids", ids);    
mapper.findByIdsMap(params);
1
2
3
4
5
6
7
8
9
<select id="findByIdsMap" resultMap="BaseResultMap">
        select
        <include refid="Base_Column_List" />
    from jria where ID in
        <foreach item="item" index="index" collection="ids"
            open="(" separator="," close=")">
           #{item}
       </foreach>
 </select>