详解mybatis foreach collection示例
在SQL开发过程中，动态构建In集合条件查询是比较常见的用法，在Mybatis中提供了foreach功能，该功能比较强大，它允许你指定一个集合，声明集合项和索引变量，它们可以用在元素体内。它也允许你指定开放和关闭的字符串，在迭代之间放置分隔符。这个元素是很智能的，它不会偶然地附加多余的分隔符。
下面是一个演示示例：
<select id="findByIdsMap" resultMap="BaseResultMap">
Select
<include refid="Base_Column_List" />
from jria where ID in <foreach item="item" index="index" collection="list"
open="(" separator="," close=")">
#{item}
</foreach>
</select>
但由于官方文档对这块的使用，描述的比较简短，细节上也被忽略掉了(可能是开源项目文档一贯的问题吧)，也使用不少同学在使用中遇到了问题。特别是foreach这个函数中，collection属性做什么用，有什么注意事项。由于文档不全，这块只能通过源代码剖析的方式来分析一下各个属性的相关要求。
collection属性的用途是接收输入的数组或是List接口实现。但对于其名称的要求，Mybatis在实现中还是有点不好理解的，所以需要特别注意这一点。
下面开始分析源代码(笔记使用的是Mybatis 3.0.5版本)
先找到Mybatis执行SQL配置解析的入口
MapperMethod.Java类中 public Object execute(Object[] args) 该方法是执行的入口.
针对in集合查询，对应用就是 selectForList或SelctForMap方法。
但不管调用哪个方法，都会对原来JDK传入的参数 Object[]类型，通过 getParam方法转换成一个Object,那这个方法是做什么的呢？分析源码如下：
上图中标红的两处，很惊讶的发现，一个参数与多个参数的处理方式是不同的(后续很多同学遇到的问题，就有一大部分出自这个地方)。如果参数个数大于一个，则会被封装成Map, key值如果使用了Mybatis的 Param注解，则会使用该key值，否则默认统一使用数据序号,从1开始。这个问题先记下，继续分析代码，接下来如果是selectForList操作(其它操作就对应用相应方法),会调用DefaultSqlSession的public List selectList(String statement, Object parameter, RowBounds rowBounds) 方法
又一个发现，见源代码如下：
上图标红部分，对参数又做了一次封装，我们看一下代码
现在有点清楚了，如果参数类型是List,则必须在collecion中指定为list, 如果是数据组，则必须在collection属性中指定为 array.
现在就问题就比较清楚了，如果是一个参数的话，collection的值取决于你的参数类型。
如果是多个值的话，除非使用注解Param指定，否则都是数字开头，所以在collection中指定什么值都是无用的。下图是debug显示结果。
针对上面分析的结果，下面给出了一个使用的解决方案，希望对大家对帮助。
在使用这个功能是需要特别注意以下规则：
1. 当查询的参数只有一个时
findByIds(List<Long> ids)
1.a 如果参数的类型是List, 则在使用时，collection属性要必须指定为
list <select id="findByIdsMap" resultMap="BaseResultMap">
Select
<include refid="Base_Column_List" />
from jria where ID in
<foreach item="item" index="index" collection="list"
open="(" separator="," close=")">
#{item}
</foreach>
</select>
findByIds(Long[] ids) 1.b 如果参数的类型是Array,则在使用时，collection属性要必须指定为 array <select id="findByIdsMap" resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from jria where ID in
<foreach item="item" index="index" collection="array"
open="(" separator="," close=")">
#{item}
</foreach>
</select>
2. 当查询的参数有多个时,例如 findByIds(String name, Long[] ids) 这种情况需要特别注意，在传参数时，一定要改用Map方式, 这样在collection属性可以指定名称
下面是一个示例
Map<String, Object> params = new HashMap<String, Object>(2); params.put("name", name); params.put("ids", ids); mapper.findByIdsMap(params); <select id="findByIdsMap" resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from jria where ID in
<foreach item="item" index="index" collection="ids"
open="(" separator="," close=")">
#{item}
</foreach>
</select>
完整的示例如下:例如有一个查询功能，Mapper接口文件定义如下方法:
List<Jria> findByIds(Long... ids);
使用 in 查询的sql拼装方法如下:
<select id="findbyIds" resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from jria where ID in
<foreach item="item" index="index" collection="array"
open="(" separator="," close=")">
#{item}
</foreach>
</select>
总结
以上所述是小编给大家介绍的mybatis foreach collection，希望对大家有所帮助！
相关文章
这篇文章主要介绍了Jsoup如何解析一个HTML文档、从文件加载文档、从URL加载Document等方法，对Jsoup常用方法做了详细讲解，最近提供了一个示例供大家参考 使用DOM方法来遍历一个文档 从元素抽取属性，文本和HTML 获取所有链接2013-11-11
Spring Cloud使用Feign进行远程调用的操作指南
本文介绍了Feign作为声明式HTTP客户端在SpringCloud中的使用,从简介、对比RestTemplate的问题、使用步骤,到日志配置、性能优化和实际应用进行了详细讲解,包括如何通过Feign简化接口调用,以及解决启动时找不到FeignClient的问题,需要的朋友可以参考下2025-02-02
SpringBoot配置开发环境的详细步骤(JDK、Maven、IDEA等)
文章介绍了如何配置SpringBoot开发环境,包括安装JDK、Maven和IDEA,并提供了详细的步骤和配置方法,感兴趣的朋友一起看看吧2024-12-12
SpringBoot+WebSocket实现即时通讯功能(Spring方式)
今天给大家分享一个SpringBoot+WebSocket实现即时通讯功能(Spring方式),WebSocket是一种在单个TCP连接上进行全双工通信的协议,文章通过代码示例给大家介绍的非常详细,需要的朋友可以参考下2023-10-10
这篇文章主要介绍了java实现斐波那契数列的3种方法，有需要的朋友可以参考一下2014-01-01
这篇文章主要为大家详细介绍了如何基于Java实现一个回调监听工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下2025-04-04
今天咱们要聊的是Guava在异步编程中的应用,让我们搞清楚为什么要用Guava来处理异步任务,在Java的世界里，异步编程是个老话题了，但它依旧非常关键,它能让咱们的应用更高效，尤其是在处理那些耗时的I/O操作2023-12-12
这篇文章主要为大家详细介绍了java简单实现桌球滚动效果，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2019-10-10
这篇文章主要介绍了Java Parser使用指南,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2023-05-05
在本篇文章里小编给大家整理的是关于java虚拟机学习笔记的相关内容，分享了一些基础知识点，需要的朋友们参考下。2019-06-06
最新评论