foreach元素的属性

  • collection:需做foreach(遍历)的对象，作为入参时，list、array对象时，collection属性值分别默认用"list"、"array"代替，Map对象没有默认的属性值。但是，在作为入参时可以使用@Param(“keyName”)注解来设置自定义collection属性值，设置keyName后，list、array会失效；
  • item：集合元素迭代时的别名称，该参数为必选项；
  • index：在list、array中，index为元素的序号索引。但是在Map中，index为遍历元素的key值，该参数为可选项；
  • open：遍历集合时的开始符号，通常与close=")"搭配使用。使用场景IN(),values()时，该参数为可选项；
  • separator：元素之间的分隔符，类比在IN()的时候，separator=",",最终所有遍历的元素将会以设定的（,）逗号符号隔开，该参数为可选项；
  • close：遍历集合时的结束符号，通常与open="("搭配使用，该参数为可选项；


foreach时，collection属性值的三种情况

  • 如果传入的参数类型为List时，collection的默认属性值为list,同样可以使用@Param注解自定义keyName;
  • 如果传入的参数类型为array时，collection的默认属性值为array,同样可以使用@Param注解自定义keyName;
  • 如果传入的参数类型为Map时，collection的属性值可为三种情况：（1.遍历map.keys;2.遍历map.values;3.遍历map.entrySet()）


代码示例：

collection属性值类型为List:

使用@Param注解自定义keyName;
List<UserList> getUserInfo(@Param("userName") List<String> userName);
<select id="getUserInfo" resultType="com.test.UserList">
        SELECT
          *
        FROM user_info
          where
          <if test="userName!= null and userName.size() >0">
              USERNAME IN
              <foreach collection="userName" item="value" separator="," open="(" close=")">
                  #{value}
              </foreach>
          </if>
</select>
使用默认属性值list作为keyname
public List<User> selectByIds(List<Integer> userIds);
<select id="selectByIds" resultType="com.olive.pojo.User">
        select * from t_user where id in
        <foreach collection="list" index="index" item="item" open="(" separator="," close=")">
            #{item}
        </foreach>
</select>

collection属性值类型为Array:

使用默认属性值array作为keyname
<select id="selectByIds" resultType="com.olive.pojo.User">
        select * from t_user where id in
        <foreach collection="array" index="index" item="item" open="(" separator="," close=")">
            #{item}
        </foreach>
    </select>

collection属性值类型为Map

<select id="selectByIds" resultType="com.olive.pojo.User">
        select * from t_user where id in
        <foreach collection="array" index="index" item="item" open="(" separator="," close=")">
            #{item}
        </foreach>
    </select>
第一种：获取Map的键值对
eg: SELECT * FROM user_info WHERE (USERNAME,AGE) IN (('张三','26'),('李四','58'),('王五','27'),......);
第二种：参数Map类型，只需要获取key值或者value值

key：

<select id="getUserInfo" resultType="com.test.UserList">
          SELECT
            *
          FROM user_info
          where
          <if test="user!= null and user.size() >0">
              (USERNAME) IN
              <foreach collection="user.keys" item="key"  separator="," open="(" close=")">
                  #{key}
              </foreach>
          </if>
</select>

value：

<select id="getUserInfo" resultType="com.test.UserList">
          SELECT
            *
          FROM user_info
          where
          <if test="user!= null and user.size() >0">
              (USERNAME) IN
              <foreach collection="user.values" item="value"  separator="," open="(" close=")">
                  #{key}
              </foreach>
          </if>
</select>