操作前先了解 foreach 参数,foreach 的主要用在构建 in 条件,它可以在 SQL 语句中迭代一个集合。

foreach 元素的属性

  • item:集合中元素迭代时的别名(必选)
  • index:用于表示在迭代过程中,每次迭代到的位置(可选)
  • open:开始符号,一般是(和close=")"合用。常用在in(),values()时(可选)
  • separator:元素之间的分隔符,在in()的时候,separator=","会自动在元素中间用“,“隔开,如in(1,2,)(可选)
  • close:关闭符号,一般是)和open="("合用。常用在in(),values()时(可选)
  • collection:要做foreach的对象类型(必选)

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

1、传入的参类型 List 集合时

List<PaperEntity> listBy(List<Integer> courseIds);

xml 配置文件中的 foreach collection 属性值为 list,如:collection = "list"(默认) 

<select id="listBy" resultMap="PaperResult">
SELECT <include refid="selectPaperVo"/>
FROM ly_paper p
WHERE p.del_flag=0 AND p.course_id IN
<foreach collection="list" item="courseId" open="(" separator="," close=")">
#{courseId}
</foreach>
</select>

2、传入参数为 Set 集合时

List<PaperEntity> listBy(Set<Integer> courseIds);

xml 配置文件中的 foreach collection 的属性值为 collection,如:collection = "collection"

<select id="listBy" resultMap="PaperResult">
SELECT <include refid="selectPaperVo"/>
FROM ly_paper p
WHERE p.del_flag=0 AND p.course_id IN
<foreach collection="collection" item="courseId" open="(" separator="," close=")">
#{courseId}
</foreach>
</select>

3、传入参数为 Array 数组的时候

List<PaperEntity> listBy(Integer[] courseIds);

xml 配置文件中的 foreach collection 的属性值为 array,如:collection = "array"

<select id="listBy" resultMap="PaperResult">
SELECT <include refid="selectPaperVo"/>
FROM ly_paper p
WHERE p.del_flag=0 AND p.course_id IN
<foreach collection="array" item="courseId" open="(" separator="," close=")">
#{courseId}
</foreach>
</select>

4、传入参数为 Map 或者 bean 的时候

List<Integer> courseIds= new ArrayList();

courseIds.add(1);
courseIds.add(2);
courseIds.add(3);
// ....

Map paramMap= new HashMap();

paramMap.put("courseIds", courseIds);

List<PaperEntity> listBy(Map<String, Object> paramMap);

如果传入的参数是多个时就需要把封装成一个 Map ,实际上如果你在传入参数的时候,在 breast里面也是会把它封装成一个 Map 的,map 的 key 就是参数名,所以这个时候 collection 属性值就是传入的 List 或 array 对象在自己封装的 map 里面的 key 了。

<select id="listBy" parameterType="java.util.HashMap" resultMap="PaperResult">
SELECT <include refid="selectPaperVo"/>
FROM ly_paper p
WHERE p.del_flag=0 AND p.course_id IN
<foreach collection="courseIds" item="courseId" open="(" separator="," close=")">
#{courseId}
</foreach>
</select>