详解MyBatis的foreach语句

原创文章，转载请务必注明地址：http://www.54tianzhisheng.cn/2017/04/09/MyBatis-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 了，当然单参数也可以封装成map，实际上如果你在传入参数的时候，在 breast 里面也是会把它封装成一个 Map 的，map 的 key 就是参数名，所以这个时候 collection 属性值就是传入的 List 或 array 对象在自己封装的 map 里面的 key 。

下面分别来看看上述三种情况的示例代码：

1.单参数 List 的类型：

<select id="dynamicForeachTest" resultType="Blog"> 
        select * from t_blog where id in 
        <foreach collection="list" index="index" item="item" open="(" separator="," close=")"> 
            #{item} 
        </foreach> 
</select> 

上述 collection 的值为list，对应的 Mapper 是这样的

public List<Blog> dynamicForeachTest(List<Integer> ids);

测试代码：

@Test 
    public void dynamicForeachTest() { 
        SqlSession session = Util.getSqlSessionFactory().openSession(); 
        BlogMapper blogMapper = session.getMapper(BlogMapper.class); 
        List<Integer> ids = new ArrayList<Integer>(); 
        ids.add(1); 
        ids.add(3); 
        ids.add(6); 
        List<Blog> blogs = blogMapper.dynamicForeachTest(ids); 
        for (Blog blog : blogs) 
            System.out.println(blog); 
        session.close(); 
    } 

2.单参数array数组的类型：

<select id="dynamicForeach2Test" resultType="Blog"> 
        select * from t_blog where id in 
        <foreach collection="array" index="index" item="item" open="(" separator="," close=")"> 
            #{item} 
        </foreach> 
</select> 

上述collection为array，对应的Mapper代码：

public List<Blog> dynamicForeach2Test(int[] ids); 

对应的测试代码：

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

3.自己把参数封装成Map的类型

<select id="dynamicForeach3Test" resultType="Blog"> 
        select * from t_blog where title like "%"#{title}"%" and id in 
        <foreach collection="ids" index="index" item="item" open="(" separator="," close=")"> 
            #{item} 
        </foreach> 
</select> 

上述collection的值为ids，是传入的参数Map的key，对应的Mapper代码：

public List<Blog> dynamicForeach3Test(Map<String, Object> params);

对应测试代码：

@Test 
    public void dynamicForeach3Test() { 
        SqlSession session = Util.getSqlSessionFactory().openSession(); 
        BlogMapper blogMapper = session.getMapper(BlogMapper.class); 
        final List<Integer> ids = new ArrayList<Integer>(); 
        ids.add(1); 
        ids.add(2); 
        ids.add(3); 
        ids.add(6); 
        ids.add(7); 
        ids.add(9); 
        Map<String, Object> params = new HashMap<String, Object>(); 
        params.put("ids", ids); 
        params.put("title", "中国"); 
        List<Blog> blogs = blogMapper.dynamicForeach3Test(params); 
        for (Blog blog : blogs) 
            System.out.println(blog); 
        session.close(); 
    }