MyBatis的Mapper文件的foreach标签详解

àì夳堔傛蜴生んèń 2021-09-28 06:12 547阅读 0赞

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

foreach元素的属性主要有 item，index，collection，open，separator，close：

item：表示集合中每一个元素进行迭代时的别名；

index：指定一个名字，用于表示在迭代过程中，每次迭代到的位置；

open：表示该语句以什么开始；

separator：表示在每次进行迭代之间以什么符号作为分隔 符；

close：表示以什么结束；

collection：

在使用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<User> 我需要迭代User的name  那么写法应该是  **\#\{item.name\}**

**演示 传入的是一个map 的情况：**

多参数封装成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);  
                 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();  
        \}

嵌套foreach的使用：

map 数据如下 Map<String,List<Long>>

测试代码如下：

public void getByMap()\{

Map<String,List<Long>> params=new HashMap<String, List<Long>>();
            List<Long> orgList=new ArrayList<Long>();
            orgList.add(10000003840076L);
            orgList.add(10000003840080L);
            
            List<Long> roleList=new ArrayList<Long>();
            roleList.add(10000000050086L);
            roleList.add(10000012180016L);
            
            params.put("org", orgList);
            params.put("role", roleList);
            
            List<BpmDefUser> list= bpmDefUserDao.getByMap(params);
            System.out.println(list.size());
        }
       dao代码如下：

public List<BpmDefUser> getByMap(Map<String,List<Long>> map){
                Map<String,Object> params=new HashMap<String, Object>();
                params.put("relationMap", map);
                return this.getBySqlKey("getByMap", params);
        }
       xml代码如下：

<select id="getByMap" resultMap="BpmDefUser">
            
                <foreach collection="relationMap" index="key"  item="ent" separator="union">
                    SELECT *
                    FROM BPM_DEF_USER
                    where  RIGHT_TYPE=#{key}
                    and OWNER_ID in 
                    <foreach collection="ent"  item="id" separator="," open="(" close=")">
                        #{id}
                    </foreach>
                </foreach>
            
        </select>
    
    index 作为map 的key。item为map的值，这里使用了嵌套循环，嵌套循环使用ent。

[breast]: http://www.breast-chest.com/