最近有时需要用到mybatis的in查询,总忘记这个foreach怎么查。顺便记录下笔记。
一、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;
Mapper接口定义的方法:UserList为模拟返回的数据对象
代码语言:javascript复制List<UserList> getUserInfo(@Param("userName") List<String> userName);
Mapper.xml 动态sql构建,Mapper接口的方法名和xml文件的id值,必须一一对应,否则会报错:
-----建议做if test="xxxx !=null and xxxx.size()>0"的校验,比较严谨。array为.length();
代码语言:javascript复制 <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
对应的Dao中的Mapper文件是:
代码语言:javascript复制public List<User> selectByIds(List<Integer> userIds);
xml文件代码片段:
代码语言:javascript复制<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:
使用@Param注解自定义keyName;
Mapper接口定义的方法:UserList为模拟返回的数据对象
代码语言:javascript复制List<UserList> getUserInfo(@Param("userName") String[] userName);
Mapper.xml 动态sql构建,Mapper接口的方法名和xml文件的id值,必须一一对应,否则会报错:
代码语言:javascript复制 <select id="getUserInfo" resultType="com.test.UserList">
SELECT
*
FROM user_info
where
<if test="userName!= null and userName.length() >0">
USERNAME IN
<foreach collection="userName" item="value" separator="," open="(" close=")">
#{value}
</foreach>
</if>
</select>
-----建议做if test="xxxx !=null and xxxx.length()>0"的校验,比较严谨。
使用默认属性值array作为keyname
对应的Dao中的Mapper文件是:
代码语言:javascript复制public List<User> selectByIds(int[] userIds);
xml文件代码片段:
代码语言:javascript复制<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>
案例
完!
参考文章:
https://blog.csdn.net/m0_37965811/article/details/117635299
腾云先锋(TDP,Tencent Cloud Developer Pioneer)是腾讯云GTS官方组建并运营的技术开发者群体。这里有最专业的开发者&客户,能与产品人员亲密接触,专有的问题&需求反馈渠道,有一群志同道合的兄弟姐妹。来加入属于我们开发者的社群吧!