MyBatis的foreach语句详解

迷南。 2022-05-26 02:09 218阅读 0赞

*  [foreach 属性介绍][foreach]
 *  [单参数是 array 类型][array]
 *  [单参数是 List 类型][List]
 *  [单参数是 Map 类型][Map]
 *  [多参数][Link 1]

# foreach 属性介绍 #

foreach 用于迭代传入过来的参数。   
它的属性介绍分别是

*  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”   
    
    
     *  如果传入的是单参数且参数类型是一个 List 的时候，collection 属性值为 list
     *  如果传入的是单参数且参数类型是一个 array 数组的时候，collection 的属性值为 array
     *  如果传入的参数是多个的时候，我们就需要把它们封装成一个 Map 了，当然单参数也可以封装成 map。
 *  item： 循环体中的具体对象。支持属性的点路径访问，如 item.age,item.info.details。具体说明：在 list 和数组中是其中的对象，在 map 中是 value，该参数为必选。（它是每一个元素进行迭代时的别名）
 *  index：在 list 和数组中,index 是元素的序号；在 map 中，index 是元素的 key。
 *  open：表示该语句以什么开始
 *  close：表示该语句以什么结束
 *  separator：表示在每次进行迭代之间以什么符号作为分隔符

介绍完属性之后，下面就进入实践。首先先来看一个简单到爆炸的表（表名：t\_test\_foreach）

![这里写图片描述][SouthEast]

# 单参数是 array 类型 #

测试类

// ids = {1,2,3}
    public List<User> testFindByArray(int[] ids) throws Exception {
        SqlSession sqlSession = getSession().openSession();
        userList = sqlSession.selectList(NameSpace + ".findByArray", ids);
        System.out.println(userList.toString());
        sqlSession.close();
        return userList;
    }
    
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9

mapper.xml

</foreach>
    -->
    <select id="findByArray" resultType="com.test.foreach.User">
        SELECT id,`name` FROM t_test_foreach WHERE id IN
        <foreach collection="array" item="ids" index="index" open="(" close=")" separator=",">
            #{ids}
        </foreach>
    </select>
    
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12

输出结果

DEBUG - ==>  Preparing: SELECT id,`name` FROM t_test_foreach WHERE id IN ( ? , ? , ? ) 
    DEBUG - ==> Parameters: 1(Integer), 2(Integer), 3(Integer)
    DEBUG - <==      Total: 3
    [User{name='n1', id='1'}, User{name='n2', id='2'}, User{name='n3', id='3'}]
     
      
       1
       2
       3
       4

# 单参数是 List 类型 #

测试类

// List 元素有 1，3，5
    public List<User> testFindByList(List<Integer> ids) throws Exception {
        SqlSession sqlSession = getSession().openSession();
        userList = sqlSession.selectList(NameSpace + ".findByList", ids);
        System.out.println(userList.toString());
        sqlSession.close();
        return userList;
    }
    
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9

mapper.xml

<select id="findByList" resultType="com.test.foreach.User">
        SELECT id,`name` FROM t_test_foreach WHERE id IN
        <foreach collection="list" item="ids" index="index" open="(" close=")" separator=",">
            #{ids}
        </foreach>
    </select>
    
     
      
       1
       2
       3
       4
       5
       6
       7

输出结果

DEBUG - ==>  Preparing: SELECT id,`name` FROM t_test_foreach WHERE id IN ( ? , ? , ? ) 
    DEBUG - ==> Parameters: 1(Integer), 3(Integer), 5(Integer)
    DEBUG - <==      Total: 3
    [User{name='n1', id='1'}, User{name='n3', id='3'}, User{name='n5', id='5'}]
     
      
       1
       2
       3
       4

# 单参数是 Map 类型 #

测试类

// Map<String, Object> 中的元素有 int[] ids = {
       2, 4};map.put("ids", ids);
    public List<User> testFindByMap(Map map) throws Exception {
        SqlSession sqlSession = getSession().openSession();
        System.out.println(map.toString());
        List<Object> objects = sqlSession.selectList(NameSpace + ".findByMap", map);
        System.out.println(objects.toString());
        sqlSession.close();
        return userList;
    }
    
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10

mapper.xml

<select id="findByMap" resultType="com.test.foreach.User">
        SELECT id,`name` FROM t_test_foreach WHERE id IN
        <foreach collection="ids" item="id" index="index" open="(" close=")" separator=",">
            #{id}
        </foreach>
    </select>
    
     
      
       1
       2
       3
       4
       5
       6
       7
       8

输出结果

DEBUG - ==>  Preparing: SELECT id,`name` FROM t_test_foreach WHERE id IN ( ? , ? ) 
    DEBUG - ==> Parameters: 2(Integer), 4(Integer)
    DEBUG - <==      Total: 2
    [User{name='n2', id='2'}, User{name='n4', id='4'}]
     
      
       1
       2
       3
       4

# 多参数 #

这种情况在传参数时，一定要改用 Map 方式

测试类

public void testUpdateByParams(int[] ids,String name) throws Exception {
        SqlSession sqlSession = getSession().openSession();
        Map<String,Object> map = new HashMap<String, Object>();
        map.put("ids",ids); // ids = {1,2,4}
        map.put("name",name);// name = "updated"
        sqlSession.selectList(NameSpace + ".findByParams", map);
        sqlSession.close();
    }
    
    
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10

mapper.xml

<select id="findByParams">
        UPDATE t_test_foreach SET `name` = '#{name}' WHERE id IN
        <foreach collection="ids" item="item" index="index" open="(" close=")" separator=",">
            #{item}
        </foreach> </select>
    
     
      
       1
       2
       3
       4
       5
       6
       7

输出结果

DEBUG - ==>  Preparing: UPDATE t_test_foreach SET `name` = ? WHERE id IN ( ? , ? , ? ) 
    DEBUG - ==> Parameters: updated(String), 1(Integer), 2(Integer), 4(Integer)
     
      
       1
       2

![这里写图片描述][SouthEast 1]

尊重他人劳动成果，转载请注明出处：   
[http://blog.csdn.net/czd3355/article/details/75340080][http_blog.csdn.net_czd3355_article_details_75340080]

参考文章：   
[http://blog.csdn.net/isea533/article/details/21237175][http_blog.csdn.net_isea533_article_details_21237175]   
[http://blog.csdn.net/u011029071/article/details/18504633][http_blog.csdn.net_u011029071_article_details_18504633]

[foreach]: https://blog.csdn.net/czd3355/article/details/75340080#foreach-属性介绍
[array]: https://blog.csdn.net/czd3355/article/details/75340080#单参数是-array-类型
[List]: https://blog.csdn.net/czd3355/article/details/75340080#单参数是-list-类型
[Map]: https://blog.csdn.net/czd3355/article/details/75340080#单参数是-map-类型
[Link 1]: https://blog.csdn.net/czd3355/article/details/75340080#多参数
[SouthEast]: /images/20220526/8b5f6fc98f9b44618fd2caa47b460d4e.png
[SouthEast 1]: /images/20220526/f6374fad449644dcbfe43583733355cb.png
[http_blog.csdn.net_czd3355_article_details_75340080]: http://blog.csdn.net/czd3355/article/details/75340080
[http_blog.csdn.net_isea533_article_details_21237175]: http://blog.csdn.net/isea533/article/details/21237175
[http_blog.csdn.net_u011029071_article_details_18504633]: http://blog.csdn.net/u011029071/article/details/18504633