mybatis 中 foreach 及 collection 的用法

一时失言乱红尘 2022-03-31 12:38 270阅读 0赞

### [链接：mybatis的select、insert、update、delete语句][mybatis_select_insert_update_delete] ###

foreach的主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。

或者批量插入数据；

--------------------

**foreach的说明：**  
**collection**：指定要遍历的集合  
**list**类型的参数会特殊处理封装在map中，map的key就叫list  
**item**：将当前遍历出的元素赋值给指定的变量  
**separator**:每个元素之间的分隔符  
**open**：遍历出所有结果拼接一个开始的字符（表示该语句以什么开始）  
**close**:遍历出所有结果拼接一个结束的字符（表示以什么结束）  
**index**:索引。遍历list的时候是index就是索引，item就是当前值  
遍历map的时候index表示的就是map的key，item就是map的值。

--------------------

在使用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" parameterType="java.util.List" 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" 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>

上述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" parameterType="java.util.HashMap" 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();
>     }

--------------------

# 利用foreach insert 批量插入数据 #

插入语句为：INSERT INTO table\_name (列1, 列2,...) VALUES (值1, 值2,....)

> <insert id="insertAll" parameterType="List">  
>             INSERT INTO oa\_notify\_record( ID, OA\_NOTIFY\_ID, USER\_ID, READ\_FLAG, READ\_DATE )  
>            <if test="list.get(0).dbName == 'oracle'">  
>                  <foreach collection="list" item="e" separator=" union all ">  
>                          SELECT \#\{e.id\}, \#\{e.oaNotify.id\}, \#\{e.user.id\}, \#\{e.readFlag\}, \#\{e.readDate\} FROM dual  
>                  </foreach>  
>            </if>  
>            <if test="list.get(0).dbName == 'mssql' or list.get(0).dbName == 'mysql'">  
>                   VALUES  
>                  <foreach collection="list" item="e" open="" separator="," close="">  
>                          (\#\{e.id\}, \#\{e.oaNotify.id\}, \#\{e.user.id\}, \#\{e.readFlag\}, \#\{e.readDate\})  
>                  </foreach>  
>             </if>  
> </insert>

[mybatis_select_insert_update_delete]: https://www.cnblogs.com/yufeng218/p/6622644.html