Mybatis foreach用法解析--对于list和array

更新时间：2022年03月23日 09:38:50 作者：二十六画生的博客

这篇文章主要介绍了Mybatis foreach用法解析--对于list和array，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

foreach用法--对于list和array

foreach的主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。

foreach元素的属性主要有 item，index，collection，open，separator，close。

item表示集合中每一个元素进行迭代时的别名，
index指定一个名字，用于表示在迭代过程中，每次迭代到的位置，
open表示该语句以什么开始，
separator表示在每次进行迭代之间以什么符号作为分隔符，
close表示以什么结束。

在使用foreach的时候最关键的也是最容易出错的就是collection属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有一下3种情况：

1.如果传入的是单参数且参数类型是一个List的时候，collection属性值为list

2.如果传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array

3.如果使用Map封装了，collection的属性值为对应的Key

4.parameterType为list，java.util.List，java.util.ArrayList均可以，切记不可以为Array.

建表语句和表的数据，以及范例如下

第1种

DAO:

public List<User> findByIdList(List<String> idList);

SQL:

<select id="findByIdList" resultMap="resultMap" parameterType="list">  <!-- parameterType="java.util.List" 也正确 -->
    SELECT
    <include refid="columnSql"></include>
    FROM t_user
    WHERE id in
    <foreach collection="list" item="id" open="(" separator="," close=")">
        #{id}
    </foreach>
</select>

2018-02-04 14:44:18,015 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (66277ms)] - ==>
Preparing: SELECT id, username, password, sex FROM t_user WHERE id in ( ? , ? , ? )
2018-02-04 14:44:18,015 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (66277ms)] - ==>
Parameters: 1(String), 2(String), 3(String)
2018-02-04 14:44:18,062 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (66324ms)] - <==
Total: 3

第2种

DAO:

public List<User> findByIdList(List<String> idList);

SQL:

<select id="findByIdList" resultMap="resultMap" parameterType="list">  <!-- parameterType="java.util.List" 也正确 -->
    SELECT
    <include refid="columnSql"></include>
    FROM t_user
    WHERE id in
    <foreach collection="list" item="item123" open="(" separator="," close=")">
        #{item123}
    </foreach>
</select>

2018-02-04 14:48:25,654 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (16876ms)] - ==>
Preparing: SELECT id, username, password, sex FROM t_user WHERE id in ( ? , ? , ? )
2018-02-04 14:48:25,654 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (16876ms)] - ==>
Parameters: 1(String), 2(String), 3(String)
2018-02-04 14:48:25,654 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (16876ms)] - <==
Total: 3

第3种

DAO:

public List<User> findByIdList(List<String> idList);

SQL:

<select id="findByIdList" resultMap="resultMap" parameterType="java.util.List">
    SELECT
    <include refid="columnSql"></include>
    FROM t_user
    WHERE id in
    <foreach collection="List" item="item123" open="(" separator="," close=")">   <!-- 这里collection="List"报错 -->
        #{item123}
    </foreach>
</select>

org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.binding.BindingException:
Parameter 'List' not found. Available parameters are [list]

第4种

SERVICE:

public List<User> findByIdList(List<String> idList) {
    Map<String, Object> map = new HashMap<String, Object>();
    map.put("List123", idList);
    return userDao.findByIdList(map);
}

DAO:

public List<User> findByIdList(Map<String, Object> map);

SQL:

<select id="findByIdList" resultMap="resultMap" parameterType="java.util.List">
    SELECT
    <include refid="columnSql"></include>
    FROM t_user
    WHERE id in
    <foreach collection="List123" item="item123" open="(" separator="," close=")">   <!-- 使用Map封装，key是List123 -->
        #{item123}
    </foreach>
</select>

2018-02-04 15:10:46,794 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (14878ms)] - ==>
Preparing: SELECT id, username, password, sex FROM t_user WHERE id in ( ? , ? , ? )
2018-02-04 15:10:46,794 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (14878ms)] - ==>
Parameters: 1(String), 2(String), 3(String)
2018-02-04 15:10:46,809 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (14893ms)] - <==
Total: 3

第5种

SERVICE:

public List<User> findByIdList(String[] idArray) {
    Map<String, Object> map = new HashMap<String, Object>();
    map.put("Array123", idArray);
    return userDao.findByIdList(map);
}

DAO:

public List<User> findByIdList(Map<String, Object> map);

SQL:

<select id="findByIdList" resultMap="resultMap" parameterType="array">  <!-- 这里使用array会报错 -->
    SELECT
    <include refid="columnSql"></include>
    FROM t_user
    WHERE id in
    <foreach collection="Array123" item="item123" open="(" separator="," close=")">
        #{item123}
    </foreach>
</select>

Caused by: org.apache.ibatis.builder.BuilderException: Error parsing Mapper XML.
Cause: org.apache.ibatis.builder.BuilderException: Error resolving class.
Cause: org.apache.ibatis.type.TypeException: Could not resolve type alias 'array'.
Cause: java.lang.ClassNotFoundException: Cannot find class: array

第6种

SERVICE:

public List<User> findByIdList(String[] idArray) {
    Map<String, Object> map = new HashMap<String, Object>();
    map.put("Array123", idArray);
    return userDao.findByIdList(map);
}

DAO:

public List<User> findByIdList(Map<String, Object> map);

SQL:

<select id="findByIdList" resultMap="resultMap" parameterType="list">   <!-- parameterType="java.util.List" 或者 parameterType="java.util.ArrayList" 均正确 --> 
    SELECT
    <include refid="columnSql"></include>
    FROM t_user
    WHERE id in
    <foreach collection="Array123" item="item123" open="(" separator="," close=")">
        #{item123}
    </foreach>
</select>

2018-02-04 15:23:07,928 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (43730ms)] - ==>
Preparing: SELECT id, username, password, sex FROM t_user WHERE id in ( ? , ? , ? )
2018-02-04 15:23:07,928 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (43730ms)] - ==>
Parameters: 1(String), 2(String), 3(String)
2018-02-04 15:23:07,928 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (43730ms)] - <==
Total: 3

第7种

DAO:

public List<User> findByIdList(String[] idArray);

SQL:

<select id="findByIdList" resultMap="resultMap" parameterType="java.util.ArrayList">
    SELECT
    <include refid="columnSql"></include>
    FROM t_user
    WHERE id in
    <foreach collection="array" item="item123" open="(" separator="," close=")">
        #{item123}
    </foreach>
</select>

2018-02-04 15:32:44,682 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (21575ms)] - ==>
Preparing: SELECT id, username, password, sex FROM t_user WHERE id in ( ? , ? , ? )
2018-02-04 15:32:44,682 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (21575ms)] - ==>
Parameters: 1(String), 2(String), 3(String)
2018-02-04 15:32:44,682 -[DEBUG] method:[com.springmvc.dao.UserDao.findByIdList (21575ms)] - <==
Total: 3

    <sql id="columnSql">
        <trim suffixOverrides=","> <!-- suffixOverrides此时的作用是去除最后一个逗号 -->
            id,
            username,
            password,
            sex,
        </trim>
    </sql>

以上基于JDK1.8。日志为亲测。仅为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

深入学习java8 中的CompletableFuture
本文主要介绍了java8中的CompletableFuture,CompletableFuture实现了CompletionStage接口和Future接口,前者是对后者的一个扩展，增加了异步回调、流式处理、多个Future组合处理的能力，使Java在处理多任务的协同工作时更加顺畅便利,下文需要的朋友可以参考一下
2022-05-05
Java实现英文猜词游戏的示例代码
这篇文章主要介绍了如何用Java编写一个英文猜词游戏，可以用来背英语单词。文中的示例代码讲解详细，感兴趣的小伙伴可以了解一下
2022-02-02
盘点MQ中的异常测试
这篇文章主要为大家介绍了盘点MQ中的异常测试，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-05-05
Spring Cloud Alibaba负载均衡实现方式
这篇文章主要为大家介绍了Spring Cloud Alibaba负载均衡实现方式详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-10-10
Java语言实现简单FTP软件 FTP连接管理模块实现（8）
这篇文章主要为大家详细介绍了Java语言实现简单FTP软件，FTP连接管理模块的实现方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-04-04
分布式医疗挂号系统EasyExcel导入导出数据字典的使用
这篇文章主要为大家介绍了分布式医疗挂号系统EasyExcel导入导出数据字典的使用，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-04-04
SpringBoot集成slf4j日志配置的方法
本文主要介绍了SpringBoot集成slf4j日志配置的方法，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-09-09
SpringBoot基于Redis实现短信登录的操作
验证码登录是非常常见的一种登录方式,能够简化用户登录的过程,本文主要介绍了SpringBoot基于Redis实现短信登录的操作,具有一定的参考价值,感兴趣的可以了解一下
2023-12-12
Java源码跟踪阅读技巧【值得收藏】
今天跟大家分享一下我平时阅读源码的几个小技巧，对于阅读Java中间件如Spring、Dubbo等框架源码的同学有一定帮助。本文基于Eclipse IDE，感兴趣的朋友跟随小编一起看看吧
2018-11-11
JAVA中终止线程的方法介绍
JAVA中终止线程的方法介绍，需要的朋友可以参考一下
2013-03-03