mybatis 中 foreach collection的三种用法

本文详细介绍了MyBatis中foreach元素的应用方法,包括如何通过foreach构建SQL IN条件,解释了item、index、collection等属性的作用,并通过具体示例展示了不同参数类型下的配置方式。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

oreach的主要用在构建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 dynamicForeachTest(List ids);
测试代码:
      @Test
    public void dynamicForeachTest() {
        SqlSession session = Util.getSqlSessionFactory().openSession();      
        BlogMapper blogMapper = session.getMapper(BlogMapper.class);
         List ids = new ArrayList();
         ids.add(1);
         ids.add(3);
          ids.add(6);
        List 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 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 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 dynamicForeach3Test(Map params);
对应测试代码:
      @Test
    public void dynamicForeach3Test() {
        SqlSession session = Util.getSqlSessionFactory().openSession();
         BlogMapper blogMapper = session.getMapper(BlogMapper.class);
          final List ids = new ArrayList();
          ids.add(1);
          ids.add(2);
          ids.add(3);
          ids.add(6);
         ids.add(7);
         ids.add(9);
        Map params = new HashMap();
         params.put("ids", ids);
         params.put("title", "中国");
        List blogs = blogMapper.dynamicForeach3Test(params);
         for (Blog blog : blogs)
             System.out.println(blog);
         session.close();
     }

### MyBatis `foreach` 标签与 `collection` 属性的使用方法 #### 1. 单参数为 List 类型的情况 当传递给 SQL 映射文件中的唯一参数是一个 `List` 集合时,`collection` 属性应设置为 `"list"`。这适用于大多数批量操作场景。 ```xml <select id="selectPostsByIds" resultType="domain.blog.Post"> SELECT * FROM POST P WHERE ID IN <foreach item="id" index="index" collection="list" open="(" separator="," close=")"> #{id} </foreach> </select> ``` 此配置允许通过传入一个整数列表来获取多篇帖子的信息[^5]。 #### 2. 参数为数组的情况 对于数组类型的输入参数,同样可以利用 `foreach` 实现循环遍历。此时需将 `collection` 设置为 `"array"` 来指示这是一个数组而非其他形式的数据结构。 ```xml <delete id="batchDeletePostsByArray" parameterType="int[]"> DELETE FROM POST WHERE ID IN <foreach item="id" index="idx" collection="array" open="(" separator="," close=")"> #{id} </foreach> </delete> ``` 这段代码展示了如何基于一组ID删除记录。 #### 3. 多个参数的情况下 当存在多个参数时,这些参数会被自动打包成一个 `Map` 对象。在这种情况下,`collection` 的值应当是指定集合所对应的键名。可以通过 `@Param` 注解显式定义键名称;如果不提供自定义名字,默认会按照位置顺序编号(如 param1, param2...)。 ```java // Java 方法签名示例 public List<Post> findPosts(@Param("ids") List<Integer> ids, @Param("status") String status); ``` 相应的 XML 映射如下: ```xml <select id="findPosts" resultMap="postResultMap"> SELECT * FROM POST p WHERE STATUS = #{status} AND ID IN <foreach item="id" index="i" collection="ids" open="(" separator="," close=")"> #{id} </foreach> </select> ``` 这里不仅实现了对特定状态的文章筛选,还支持按ID列表进一步过滤[^4]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值