mybatis动态sql中的foreach标签的使用

mybatis动态sql中的foreach标签的使用

动态 SQL 的另一个常见使用场景是对集合进行遍历（尤其是在构建 IN 条件语句的时候）

  SELECT P.*
  FROM POST P
  
    
          #{item}
    
  

foreach 元素的功能非常强大，它允许你指定一个集合，声明可以在元素体内使用的集合项（item）和索引（index）变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。这个元素也不会错误地添加多余的分隔符！具体如下:

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"

item :集合中元素迭代时的别名。该参数为必选

index :在list和数组中,index是元素的序号，在map中，index是元素的key。该参数可选

open :foreach代码的开始符号，一般是(和close=")"合用。常用在in(),values()时。该参数可选

separator :元素之间的分隔符，例如在in()的时候，separator=","会自动在元素中间用“,“隔开，避免手动输入逗号导致sql错误，如in(1,2,)这样。该参数可选。

close :foreach代码的关闭符号，一般是)和open="("合用。常用在in(),values()时。该参数可选

nullable :是否为空开关。该参数可选

提示 你可以将任何可迭代对象（如 List、Set 等）、Map 对象或者数组对象作为集合参数传递给 foreach。当使用可迭代对象或者数组时，index 是当前迭代的序号，item 的值是本次迭代获取到的元素。当使用 Map 对象（或者 Map.Entry 对象的集合）时，index 是键，item 是值。

在使用foreach的时候最关键的也是最容易出错的就是collection属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有一下3种情况：

• 如果传入的是单参数且参数类型是一个List的时候，collection属性值为list .
• 如果传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array .
• 如果传入的参数是多个的时候，我们就需要把它们封装成一个Map了，当然单参数也可以封装成map，实际上如果你在传入参数的时候，在MyBatis里面也是会把它封装成一个Map的，map的key就是参数名，所以这个时候collection属性值就是传入的List或array对象在自己封装的map里面的key.

针对最后一条，我们来看一下官方说法：

注意 你可以将一个 List 实例或者数组作为参数对象传给 MyBatis，当你这么做的时候，MyBatis 会自动将它包装在一个 Map 中并以名称为键。List 实例将会以“list”作为键，而数组实例的键将是“array”。

所以，不管是多参数还是单参数的list,array类型，都可以封装为map进行传递。如果传递的是一个List，则mybatis会封装为一个list为key，list值为object的map，如果是array，则封装成一个array为key，array的值为object的map，如果自己封装呢，则colloection里放的是自己封装的map里的key值。

List 类型参数

@Test
public void selectPostIn() {
    List ids = new ArrayList();
    ids.add(1L);
    ids.add(2L);
    ids.add(3L);
    List posts = postMapper.selectPostIn(ids);
}

对应的xml

  SELECT P.* FROM POST P
  
    
          #{item}
    
  

Array类型参数

@Test
public void selectPostIn() {
    long[] ids = new long[] {1L,2L,3L};
    List posts = postMapper.selectPostIn(ids);
}

对应的xml

  SELECT P.* FROM POST P
  
    
          #{item}
    
  

封装为Map的类型参数

@Test
public void selectPostIn() {
    final List ids = new ArrayList();
    ids.add(1L);
    ids.add(2L);
    ids.add(3L);
    Map maps = new HashMap();
    params.put("ids", ids);
    params.put("address", "北京");
    List posts = postMapper.selectPostIn(maps);
}

对应的xml

  SELECT P.* FROM POST P
  
    
          #{item}
    
  

=====>mybatis