Mybatis 示例之 foreach

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

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

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

foreach属性

属性	描述
`item`	循环体中的具体对象。支持属性的点路径访问，如item.age,item.info.details。具体说明：在list和数组中是其中的对象，在map中是value。该参数为必选。
`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" 上面只是举例，具体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

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

<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>

测试代码：

@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]

上面这个例子是List的，但是和数组的情况基本一样，所以不针对数组进行测试了。可以看到这个例子的内容是很简单的，实际上List,array,map也可以互相嵌套，可以用多个foreach去执行，如果想看这样一个例子，可以移步这里：

新人求解问题哦，被卡了两天了，悲伤..

上面这个问题就遇到了list,map一起用的问题，3楼是问题的答案，可以参考一看。

注：Map类型没有默认的map，所以不能直接写collection="map",如果这么写，需要保证传入的Map参数有@Param("map")注解。

有关参数的更详细内容，建议看：深入了解MyBatis参数

这节讲的是foreach中map的用法。

map和List,array相比，map是用K,V存储的，在foreach中，使用map时，index属性值为map中的Key的值。

因为map中的Key不同于list,array中的索引，所以会有更丰富的用法。

第一个简单例子：

    <insert id="ins_string_string">
        insert into string_string (key, value) values
        <foreach item="item" index="key" collection="map"
            open="" separator="," close="">(#{key}, #{item})</foreach>
    </insert>

可以看到这个例子相当简单，表中需要两个值，正好和K,V对应，因而map中的一个K,V就对应一条数据，如果map中有多个K,V，就会保存多个结果。

如果map中有两对K,V，那么执行SQL如下：

DEBUG [main] - ==>  Preparing: insert into string_string (key, value) values (?, ?) , (?, ?) 
DEBUG [main] - ==> Parameters: key 1(String), value 1(String), key 2(String), value 2(String)
DEBUG [main] - <==    Updates: 2

大部分数据库是支持values()()这种形式的插入语句，可以插入多条(相关链接 - 可能需翻墙)。

下面再看一个select的例子：

　　<select id="sel_key_cols" resultType="int">
        select count(*) from key_cols where
        <foreach item="item" index="key" collection="map"
            open="" separator="AND" close="">${key} = #{item}</foreach>
    </select>

可以看到这里用key=value来作为查询条件，对于动态的查询，这种处理方式可以借鉴。一定要注意到$和#的区别，$的参数直接输出，#的参数会被替换为?，然后传入参数值执行。

上述SQL执行日志如下：

DEBUG [main] - ==>  Preparing: select count(*) from key_cols where col_a = ? AND col_b = ? 
DEBUG [main] - ==> Parameters: 22(Integer), 222(Integer)
DEBUG [main] - <==      Total: 1

最后，如果不考虑元素的顺序和map中Key，map和list,array可以拥有一样的效果，都是存储了多个值，然后循环读取出来。

如果有这方面的问题，欢迎留言提问。若有宝贵意见，欢迎指出。

本文出自：http://blog.csdn.net/isea533/article/details/21237175

未整理 http://chenzhou123520.iteye.com/blog/1583407/

foreach的主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。foreach元素的属性主要有 item，index，collection，open，separator，close。item表示集合中每一个元素进行迭代时的别名，index指定一个名字，用于表示在迭代过程中，每次迭代到的位置，open表示该语句以什么开始，separator表示在每次进行迭代之间以什么符号作为分隔符，close表示以什么结束，在使用foreach的时候最关键的也是最容易出错的就是collection属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有一下3种情况：

如果传入的是单参数且参数类型是一个List的时候，collection属性值为list
如果传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array
如果传入的参数是多个的时候，我们就需要把它们封装成一个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();
    }