MyBatis foreach 标签常用方法总结

一、前言

  在 MyBatis 中，常常会遇到集合类型的参数，虽然我们可以通过 OGNL 表达式来访问集合的某一个元素，但是 OGNL 表达式无法遍历集合。foreach 标签就是专门用来解决这类问题的，foreach 标签可以用来遍历数组、列表和 Map 等集合参数，实现批量操作或一些简单 SQL 操作。

二、foreach 元素属性简介

  foreach 元素的属性主要有 item，index，open，separator，close，collection。各属性含义如下所示。

2.1 item

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

2.2 index

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

2.3 open

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

2.4 separator

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

2.5 close

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

2.6 collection

  要被 foreach 标签循环解析的对象。

  foreach 标签的 collection 属性在接受参数名时，有两种情况：

• 匿名参数
  当在 java 方法中没有通过 @Param 注解指定参数名时，列表类型默认参数名为 ”list“，数组类型默认参数名为 ”array“，Map 对象没有默认值。

• 具名参数
  java 方法中使用了 @Param 注解指定了参数名称，则 foreach 中的 collection 属性必须为参数名。

  在作为入参时可以使用 @Param(“keyName”) 来设置该键值，设置 keyName 后，list、array 将会失效。除了入参这种情况外，还有一种是作为参数对象的某个字段，例子如下。如果 User 有属性 List ids。入参是 User 对象，那么这个collection = “ids”。如果 User 有属性 Ids ids，其中 Ids 是个对象，Ids 有个属性 List id，入参是 User 对象，那么 collection = “ids.id”。

  注意点：在使用 foreach 的时候，最关键的就是 collection 属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有以下 3 种情况（未通过 @Param 指定别名时）。

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

三、#{} 与 ${} 的区别

  在使用参数的过程中，会遇到 #{} 与 ${} 的问题，因此简单总结下两者之间的区别。

1. ${param} 传递的参数会被当成 SQL 语句中的一部分，比如传递表名，字段名，字段类型等数据。
   例如，传入值为 id，order by ${param} 则解析成 SQL：order by id。

2. #{parm} 传入的数据都当成一个字符串，会对自动传入的数据加一个双引号。
   例如，传入值为 id，select * from table where name = #{param} 则解析成 SQL：select * from table where name = ? （其中问号在执行时传入值 “id”）。

  为了安全，能用 # 的地方就用 # 方式传参，这样可以有效的防止 SQL 注入攻击。

  官方说明：mybatis 在处理 #{} 时，会将 SQL 中的 #{} 替换为 “?”，调用 PreparedStatement 的 set 方法来赋值；mybatis 在处理 ${} 时，就是把 ${} 替换成变量的值。使用 #{} 可以有效的防止 SQL 注入，提高系统安全性。

四、实例实战

  本文以如下几个例子简单总结下 foreach 是如何遍历列表、数组和 Map 的。

4.1 遍历 List 列表

  Java 层接口

List<Rule> selectRulesByList(List<String> ids);
1

  XML

  <select id="selectRulesByList" resultMap="BaseResultMap">
    SELECT
    <include refid="Base_Column_List" />
    FROM tbl_test_rule WHERE rule_id IN
    <foreach collection="list" open="(" close=")" separator="," item="item" index="index">
      #{item}
    foreach>
  select>
1
2
3
4
5
6
7
8

  运行时 SQL 语句

==>  Preparing: SELECT rule_id, rule_name, rule_type FROM tbl_test_rule WHERE rule_id IN ( ? , ? )
==> Parameters: 10001(String), 20002(String)
<==      Total: 2
1
2
3

4.2 遍历 List