MyBatis系列(八)：MyBatis动态Sql之foreach标签的用法

最新推荐文章于 2023-09-07 08:00:00 发布
最新推荐文章于 2023-09-07 08:00:00 发布
阅读量1.1k 收藏 5
点赞数 1
分类专栏： MyBatis 文章标签： MyBatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zwwhnly/article/details/103343068
版权

本篇博客主要讲解如何使用foreach标签生成动态的Sql，主要包含以下3个场景：

  1. foreach 实现in集合
  2. foreach 实现批量插入
  3. foreach 实现动态update

1. foreach 实现in集合

假设有这样1个需求：根据传入的用户id集合查询出所有符合条件的用户，此时我们需要使用到Sql中的IN，如 id in (1,1001)。

首先，我们在接口SysUserMapper中添加如下方法：

/**
 * 根据用户id集合查询用户
 *
 * @param idList
 * @return
 */
List<SysUser> selectByIdList(List<Long> idList);

然后在对应的SysUserMapper.xml中添加如下代码：

<select id="selectByIdList" resultType="com.zwwhnly.mybatisaction.model.SysUser">
    SELECT id,
    user_name,
    user_password,
    user_email,
    create_time
    FROM sys_user
    WHERE id IN
    <foreach collection="list" open="(" close=")" separator=","
             item="id" index="i">
        #{id}
    </foreach>
</select>

最后，在SysUserMapperTest测试类中添加如下测试方法：

@Test
public void testSelectByIdList() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        List<Long> idList = new ArrayList<Long>();
        idList.add(1L);
        idList.add(1001L);

        List<SysUser> userList = sysUserMapper.selectByIdList(idList);
        Assert.assertEquals(2, userList.size());
    } finally {
        sqlSession.close();
    }
}

运行测试代码，测试通过，输出日志如下：

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE id IN ( ? , ? )

DEBUG [main] - ==> Parameters: 1(Long), 1001(Long)

TRACE [main] - <== Columns: id, user_name, user_password, user_email, create_time

TRACE [main] - <== Row: 1, admin, 123456, admin@mybatis.tk, 2019-06-27 18:21:07.0

TRACE [main] - <== Row: 1001, test, 123456, test@mybatis.tk, 2019-06-27 18:21:07.0

DEBUG [main] - <== Total: 2

通过日志会发现，foreach元素中的内容最终生成的Sql语句为(1,1001)。

foreach包含属性讲解：

  • open：整个循环内容开头的字符串。
  • close：整个循环内容结尾的字符串。
  • separator：每次循环的分隔符。
  • item：从迭代对象中取出的每一个值。
  • index：如果参数为集合或者数组，该值为当前索引值，如果参数为Map类型时，该值为Map的key。
  • collection：要迭代循环的属性名。

也许有人会好奇，为什么collection的值是list？该值该如何设置呢？

上面的例子中只有一个集合参数，我们把collection属性的值设置为了list，其实也可以写成collection，为什么呢？让我们看下DefaultSqlSession中的默认处理逻辑：

private Object wrapCollection(Object object) {
    DefaultSqlSession.StrictMap map;
    if (object instanceof Collection) {
        map = new DefaultSqlSession.StrictMap();
        map.put("collection", object);
        if (object instanceof List) {
            map.put("list", object);
        }

        return map;
    } else if (object != null && object.getClass().isArray()) {
        map = new DefaultSqlSession.StrictMap();
        map.put("array", object);
        return map;
    } else {
        return object;
    }
}

虽然使用默认值，代码也可以正常运行，但还是推荐使用@Param来指定参数的名字，如下所示：

List<SysUser> selectByIdList(@Param("idList") List<Long> idList);

<foreach collection="idList" open="(" close=")" separator=","
         item="id" index="i">
    #{id}
</foreach>

如果参数是一个数组参数，collection可以设置为默认值array，看了上面的源码，应该不难理解。

/**
 * 根据用户id数组查询用户
 *
 * @param idArray
 * @return
 */
List<SysUser> selectByIdArray(Long[] idArray);

<select id="selectByIdArray" resultType="com.zwwhnly.mybatisaction.model.SysUser">
    SELECT id,
    user_name,
    user_password,
    user_email,
    create_time
    FROM sys_user
    WHERE id IN
    <foreach collection="array" open="(" close=")" separator=","
             item="id" index="i">
        #{id}
    </foreach>
</select>

虽然使用默认值，代码也可以正常运行，但还是推荐使用@Param来指定参数的名字，如下所示：

List<SysUser> selectByIdArray(@Param("idArray")Long[] idArray);

<foreach collection="idArray" open="(" close=")" separator=","
         item="id" index="i">
    #{id}
</foreach>

2. foreach 实现批量插入

假设有这样1个需求：将传入的用户集合批量写入数据库。

首先，我们在接口SysUserMapper中添加如下方法：

/**
 * 批量插入用户信息
 *
 * @param userList
 * @return
 */
int insertList(List<SysUser> userList);

然后在对应的SysUserMapper.xml中添加如下代码：

<insert id="insertList" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO sys_user(user_name, user_password, user_email, user_info, head_img, create_time)
    VALUES
    <foreach collection="list" item="user" separator=",">
        (#{user.userName},#{user.userPassword},#{user.userEmail},#{user.userInfo},#{user.headImg,jdbcType=BLOB},#{user.createTime,jdbcType=TIMESTAMP})
    </foreach>
</insert>

最后，在SysUserMapperTest测试类中添加如下测试方法：

@Test
public void testInsertList() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        List<SysUser> sysUserList = new ArrayList<SysUser>();
        for (int i = 0; i < 2; i++) {
            SysUser sysUser = new SysUser();
            sysUser.setUserName("test" + i);
            sysUser.setUserPassword("123456");
            sysUser.setUserEmail("test@mybatis.tk");

            sysUserList.add(sysUser);
        }

        int result = sysUserMapper.insertList(sysUserList);

        for (SysUser sysUser : sysUserList) {
            System.out.println(sysUser.getId());
        }

        Assert.assertEquals(2, result);
    } finally {
        sqlSession.close();
    }
}

运行测试代码，测试通过，输出日志如下：

DEBUG [main] - ==> Preparing: INSERT INTO sys_user(user_name, user_password, user_email, user_info, head_img, create_time) VALUES (?,?,?,?,?,?) , (?,?,?,?,?,?)

DEBUG [main] - ==> Parameters: test0(String), 123456(String), test@mybatis.tk(String), null, null, null, test1(String), 123456(String), test@mybatis.tk(String), null, null, null

DEBUG [main] - <== Updates: 2

1035

1036

3. foreach 实现动态update

假设有这样1个需求：根据传入的Map参数更新用户信息。

首先，我们在接口SysUserMapper中添加如下方法：

/**
 * 通过Map更新列
 *
 * @param map
 * @return
 */
int updateByMap(Map<String, Object> map);

然后在对应的SysUserMapper.xml中添加如下代码：

<update id="updateByMap">
    UPDATE sys_user
    SET
    <foreach collection="_parameter" item="val" index="key" separator=",">
        ${key} = #{val}
    </foreach>
    WHERE id = #{id}
</update>

最后，在SysUserMapperTest测试类中添加如下测试方法：

@Test
public void testUpdateByMap() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        Map<String, Object> map = new HashMap<String, Object>();
        map.put("id", 1L);
        map.put("user_email", "test@mybatis.tk");
        map.put("user_password", "12345678");

        Assert.assertEquals(1, sysUserMapper.updateByMap(map));

        SysUser sysUser = sysUserMapper.selectById(1L);
        Assert.assertEquals("test@mybatis.tk", sysUser.getUserEmail());
        Assert.assertEquals("12345678", sysUser.getUserPassword());
    } finally {
        sqlSession.close();
    }
}

运行测试代码，测试通过，输出日志如下：

DEBUG [main] - ==> Preparing: UPDATE sys_user SET user_email = ? , user_password = ? , id = ? WHERE id = ?

DEBUG [main] - ==> Parameters: test@mybatis.tk(String), 12345678(String), 1(Long), 1(Long)

DEBUG [main] - <== Updates: 1

DEBUG [main] - ==> Preparing: SELECT id, user_name, user_password, user_email, create_time FROM sys_user WHERE id = ?

DEBUG [main] - ==> Parameters: 1(Long)

TRACE [main] - <== Columns: id, user_name, user_password, user_email, create_time

TRACE [main] - <== Row: 1, admin, 12345678, test@mybatis.tk, 2019-06-27 18:21:07.0

DEBUG [main] - <== Total: 1

上面示例中，collection使用的是默认值_parameter，也可以使用@Param指定参数名字，如下所示：

int updateByMap(@Param("userMap") Map<String, Object> map);

<update id="updateByMap">
    UPDATE sys_user
    SET
    <foreach collection="userMap" item="val" index="key" separator=",">
        ${key} = #{val}
    </foreach>
    WHERE id = #{userMap.id}
</update>

4. 源码及参考

源码地址：https://github.com/zwwhnly/mybatis-action.git，欢迎下载。

刘增辉《MyBatis从入门到精通》

原创不易，如果觉得文章能学到东西的话，欢迎点个赞、评个论、关个注，这是我坚持写作的最大动力。

如果有兴趣，欢迎添加我的微信：zwwhnly，等你来聊技术、职场、工作等话题（PS：我是一名奋斗在上海的程序员）。

申城异乡人
关注
  • 1
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis 动态sql及参数传递
12-14
目录 使用场景 动态标签 if标签 where标签 choose、when、otherwise 标签 set标签 trim标签 forEach标签 参数传递 单个参数传递 多个参数传递 传入单个实体(JavaBean/Map) 传入多个实体 传入集合 使用场景 在实际开发过程中，我们往往需要编写复杂的SQL语句,拼接稍有不注意就会导致错误，Mybatis给开发者提供了动态SQL，大大降低了拼接SQL导致的错误。 动态标签 if标签 if标签通常用那个胡where语句,update语句,insert语句中，通过判断参数值来决定是否使用某个查询条件，判断是否更新某一个字段或插入某个字段
MyBatis中foreach用法
jiaomubai的博客
08-14 8587
foreach用法 SQL语句中有时会使用in关键字，如id in {1，2，3}，我们可以使用${ids}方式直接获取值，但是这种方法不能防止SQL注入，想避免SQL注入的话就需要使用#{id}的方式，这时我们就可以配合使用foreach标签了。foreach可以对数组、Map或实现了Iterable接口（List、Set）的对象进行遍历。数组在处理时会转换为List对象，因此foreach遍历的对象可以分为两大类：Iterable类型和Map类型。 foreach实现in集合 foreach实现i
2020-03-21:问题记录：mybatis中foreach循环set ，array ，list...
qq_33199919的博客
04-01 2477
日常工作中，手写sql一般没什么问题，就是在mybatis中一些小细节要是印象不深刻，那会花费一些时间，影响我们书写的流畅性，就比如最近碰到的mybatis中写foreach 循环 set 的时候 1.最开始版本 Long countByIds(@Param("adTaskIds") Set<Long> adTaskIds, @Param("userId") Long use...
Mybatis之foreach
qq_42338744的博客
11-04 838
foreach属性 collection：指定数组或者集合 item：代表数组或集合中的元素 separator：循环之间的分隔符 open：foreach循环拼接的所有sql语句的最前面以什么开始 close：foreach循环拼接的所有sql语句的最前面以什么结束
MyBatis动态sql详解（foreach语句详解【IN】）
fei飞来了
09-26 9261
Mybatis 动态sql
Mybatis中foreach对List、实体类、List<Map> 的循环
何阳的博客
08-23 8027
1、List<Object>循环 <foreach collection="idList" index="index" item="item" open="(" separator="," close=")"> #{item} </foreach> collection --------接收的数组（入参） index --...
MyBatis动态SQL foreach标签实现批量插入的方法示例
08-19
主要介绍了MyBatis动态SQL foreach标签实现批量插入的方法示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Mybatis中动态SQL，if,where,foreach的使用教程详解
08-28
MyBatis的动态SQL是基于OGNL表达式的，它可以帮助我们方便的在SQL语句中实现某些逻辑。这篇文章主要介绍了Mybatis中动态SQL，if,where,foreach的使用教程,需要的朋友可以参考下
Mybatis中foreach标签带来的空格\换行\回车问题及解决方案
08-19
主要介绍了解决Mybatis中foreach标签带来的空格,换行,回车问题,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
mybatis动态SQL语句
04-28
if 、where、set、trim、choose 、foreach等在mybatis中的具体用法，有具体实例可供参考，玩转mybatis
MyBatis动态SQL之＜foreach＞用法
棒棒糖的糖不含糖的博客
08-22 3367
MyBatis动态SQL之用法
mybatis之动态SQLforeach的使用
m0_64365419的博客
01-17 1816
它的功能非常强大，允许指定一个集合声明可以在元素体内使用的集合项（item）和索引（index）变量，它也允许指定开头与结尾的字符串以及集合项迭代之间的分隔符，这个元素也不会错误地添加多余的分隔符，看它多智能！
Mybatis动态sql中的foreach标签的使用
北辰
08-09 417
foreach 标签一般用于遍历集合，构建in条件语句或者批量操作语句
mybatis注解动态sql中foreach工具方法
daodfs1的博客
06-10 4029
目录实现目标工具类测试集成进spring后的使用方法Mapper层Provider层 实现目标 由于在注解版mybatis中手动循环拼接动态sql容易出错 请看mybatis注解动态sql注入map和list（防sql注入攻击） ，所以封装了这个类似于foreach标签的工具方法。 只支持单层循环哦！ 工具类 package com.xxx.common.util; import java.util.Arrays; import java.util.HashMap; import java.util.Li
MyBatis Mapper常用动态SQL之foreach 、if、choose、where、when
SSY_1992的博客
04-20 3932
if>判断语句，用于单条件分支条件判断使用
Mybatis 动态SQL - 使用foreach标签查询数据、批量新增、批量修改、删除数据
最新发布
Mointor
09-07 3191
本篇主要介绍使用Mybatis提供的foreach标签查询数据、批量新增、批量修改、删除数据
spring mybatis 动态SQL的foreach标签
虾米大王的学习历程
08-02 136
推荐使用@Param来指定参数的名称，例如在参数前添加@Param("ids")，则填写collection=ids。在where条件中使用foreach标签可以在where条件中使用foreach标签，如按id集合查询、按id集合删除等。（3）参数是Map：指定为Map中对应的Key即可。（3）index：索引的属性名。（2）多参数：多参数请使用@Param来指定，否则SQL中会很不方便。（1）collection：必填，集合、数组或Map的名称。（2）item：变量名，即从迭代的对象中取出的每一个值。
MyBatis学习：动态SQL中＜foreach＞标签的使用
weixin_46281472的博客
10-06 1474
我本人正在学习MyBatis框架，在原先了解并且懵懵懂懂使用的基础上，开始系统正式的学习。阐述了MVC架构模式和三层架构，回顾了JDBC连接数据库，建立了使用MyBatis和MySQL的Maven项目，解释了STDOUT_LOGGING日志和手动提交事务，记录了MyBatis中#占位符的使用方法，回顾了MyBatis执行SQL语句的过程和使用到的一些重要类和接口，记录了将固定化的代码整合到一个工具类MyBatisUtil中，以减少代码量。记录了dao层接口的实现以及为什么要实现它。
MyBatis＜foreach＞标签的用法及多种循环方式
热门推荐
TM_enn的博客
01-29 2万+
foreach 的主要作用在构建 in 条件中，它可以在 sql 语句中进行迭代一个集合。foreach 元素的属性主要有 collection，item，separator，index，open，close
mybatis动态sql标签foreach
03-16
Mybatis中的foreach标签是用来循环构建动态SQL语句的。它可以遍历一个集合或数组，并且在循环体内可以使用特定的占位符引用当前遍历到的元素。例如： ``` <foreach collection="list" item="item" index="index" ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值