MyBatis传入参数为集合 list 数组 map写法

WindCoder

发布于 2018-09-20 15:32:48

17.9K00

代码可运行

文章被收录于专栏：WindCoderWindCoder

运行总次数：0

代码可运行

这几天需要or和拼接in的特定查询条件来做查询，想看看mybatis是否可以通过传递list集合实现，于是找到了他的foreach标签。

详情

foreach标签

属性	描述
item	循环体中的具体对象。支持属性的点路径访问，如item.age,item.info.details。具体说明：在list和数组中是其中的对象，在map中是value。该参数为必选。
collection	要做foreach的对象，作为入参时，List<?>对象默认用list代替作为键，数组对象有array代替作为键，Map对象用map代替作为键。当然在作为入参时可以使用@Param("keyName")来设置键，设置keyName后，list,array,map将会失效。除了入参这种情况外，还有一种作为参数对象的某个字段的时候。举个例子：如果User有属性List ids。入参是User对象，那么这个collection = "ids" 如果User有属性Ids ids;其中Ids是个对象，Ids有个属性List id;入参是User对象，那么collection = "ids.id" 上面只是举例，具体collection等于什么，就看你想对那个元素做循环。该参数为必选。
separator	元素之间的分隔符，例如在in()的时候，separator=","会自动在元素中间用“,“隔开，避免手动输入逗号导致sql错误，如in(1,2,)这样。该参数可选。
open	foreach代码的开始符号，一般是(和close=")"合用。常用在in(),values()时。该参数可选。
close	foreach代码的关闭符号，一般是)和open="("合用。常用在in(),values()时。该参数可选。
index	在list和数组中,index是元素的序号，在map中，index是元素的key，该参数可选。

用法

1、List(array)

<select id="findAllPostsLikeOfPage" resultMap="posts">
	SELECT tp.id,tp.imgurl,tp.like_num,tp.available,tp.createtime
	FROM `tod_posts` tp,`tod_terms` tt,tod_terms_posts ttp
	<where>
		tp.available = 1
		<if test="keys!= null and keys.size()>0">
			 AND ttp.tid = tt.id AND ttp.pid = tp.id  AND (
			<foreach collection="keys" item="item" index="index" separator="OR">
				tt.term_name LIKE
				CONCAT('%',#{item},'%')
			</foreach>
			)
		</if>
	</where>
	ORDER BY tp.createtime DESC,tp.id DESC
</select>

此例中，keys为List<String>类型的参数；
foreach中collection属性的keys本处写的和参数同名，据说可以直接写成list，若参数是array类型的也可以直接写成array。
item可以自定义，类似增强型的for循环中的变量，即 for (String str : set)中的str；
index 在list中为元素序号，类似for(int i;i<n;i++)中的i；
separator 为元素之间的分隔符，如in(1,2)中的",";
open 为foreach代码的开始符号，可以将此例中的AND之后，foreach之前的“(”去掉，在foreach中用open=“(”代替；
close 为foreach代码的结束符号，可以将本例中</foreach>标签之后的“)”去掉，在<foreach>标签中用 close=“)”代替；
CONCAT('%',#{item},'%') 为mybatis中like语句的一种拼接写法，里面的#{item}即为foreach标签item属性定义的值。

2、Map（来源网络）

map和List,array相比，map是用K,V存储的，在foreach中，使用map时，index属性值为map中的Key的值。

因为map中的Key不同于list,array中的索引，所以会有更丰富的用法。

<insert id="ins_string_string">
        insert into string_string (key, value) values
        <foreach item="item" index="key" collection="map"
            open="" separator="," close="">(#{key}, #{item})</foreach>
</insert>

可以看到这个例子相当简单，表中需要两个值，正好和K,V对应，因而map中的一个K,V就对应一条数据，如果map中有多个K,V，就会保存多个结果。

如果map中有两对K,V，那么执行SQL如下：

DEBUG [main] - ==>  Preparing: insert into string_string (key, value) values (?, ?) , (?, ?) 
DEBUG [main] - ==> Parameters: key 1(String), value 1(String), key 2(String), value 2(String)
DEBUG [main] - <==    Updates: 2

下面再看一个select的例子：

<select id="sel_key_cols" resultType="int">
        select count(*) from key_cols where
        <foreach item="item" index="key" collection="map"
            open="" separator="AND" close="">${key} = #{item}</foreach>
</select>

可以看到这里用key=value来作为查询条件，对于动态的查询，这种处理方式可以借鉴。一定要注意到$和#的区别，$的参数直接输出，#的参数会被替换为?，然后传入参数值执行。

DEBUG [main] - ==>  Preparing: select count(*) from key_cols where col_a = ? AND col_b = ? 
DEBUG [main] - ==> Parameters: 22(Integer), 222(Integer)
DEBUG [main] - <==      Total: 1

最后，如果不考虑元素的顺序和map中Key，map和list,array可以拥有一样的效果，都是存储了多个值，然后循环读取出来。