SpringBoot+MyBatis进行XML中循环处理List参数的终极指南

 更新时间:2025年07月06日 09:56:29   作者:一勺菠萝丶  
这篇文章主要为大家详细介绍了SpringBoot整合MyBatis进行XML中循环处理List参数的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下

重要提醒:使用@Param注解时,务必导入正确的包!

import org.apache.ibatis.annotations.Param;

很多开发者容易错误导入Spring的@Param,导致参数绑定失败!

一、为什么需要传递List参数?

最常见的场景是动态构建IN查询

SELECT * FROM users WHERE id IN (1, 2, 3, 4)

当我们需要根据前端传入的多个值查询时,就需要将List集合作为参数传递给Mapper。

二、基础版:MyBatis原生List传参

1. Mapper接口定义(注意@Param导入)

// !!!必须导入MyBatis的@Param包!!!
import org.apache.ibatis.annotations.Param;

public interface UserMapper {
    // 使用@Param注解指定参数名
    List<User> selectByIds(@Param("idList") List<Long> idList);
}

2. XML映射文件实现

<select id="selectByIds" resultType="User">
    SELECT * FROM users
    WHERE id IN
    <foreach collection="idList" item="id" 
             open="(" separator="," close=")">
        #{id}
    </foreach>
</select>

核心标签解析:

属性说明示例值
collection传入的集合参数名idList
item循环中当前元素的别名id
open循环开始前的字符串(
separator元素间的分隔符,
close循环结束后的字符串)

3. 实际生成的SQL

当传入List<Long> ids = Arrays.asList(1L, 2L, 3L)时:

SELECT * FROM users WHERE id IN (1, 2, 3)

三、避坑重点:@Param的正确使用

常见错误1:导入错误包

// ❌ 错误:导入了Spring的Param包
import org.springframework.data.repository.query.Param;

// ✅ 正确:必须使用MyBatis的Param包
import org.apache.ibatis.annotations.Param;

常见错误2:忘记添加@Param注解

// ❌ 错误:缺少@Param注解会导致XML中无法识别参数
List<User> selectByIds(List<Long> idList);

// ✅ 正确:必须添加@Param注解
List<User> selectByIds(@Param("idList") List<Long> idList);

四、MyBatis Plus的优雅实现

1. 使用QueryWrapper(无需XML)

public List<User> getUsersByIds(List<Long> ids) {
    return userMapper.selectList(
        new QueryWrapper<User>().in("id", ids)
    );
}

2. Lambda表达式写法(推荐)

public List<User> getUsersByIds(List<Long> ids) {
    return userMapper.selectList(
        Wrappers.<User>lambdaQuery()
            .in(User::getId, ids)
    );
}

注意:MyBatis Plus的Wrapper方式不需要@Param注解

五、扩展应用场景

场景1:List处理

// Mapper
List<User> selectByNames(@Param("nameList") List<String> nameList);

// XML
<foreach collection="nameList" item="name" open="(" separator="," close=")">
    #{name}
</foreach>

场景2:List<实体对象>

// Mapper
List<User> selectByConditions(@Param("userList") List<User> userList);

// XML
<foreach collection="userList" item="user" separator=" OR ">
    (name = #{user.name} AND age > #{user.age})
</foreach>

场景3:多List参数

// Mapper
List<User> searchUsers(@Param("ids") List<Long> ids, 
                      @Param("names") List<String> names);

// XML
<where>
    <if test="ids != null and !ids.isEmpty()">
        id IN
        <foreach collection="ids" item="id" open="(" separator="," close=")">
            #{id}
        </foreach>
    </if>
    <if test="names != null and !names.isEmpty()">
        AND name IN
        <foreach collection="names" item="name" open="(" separator="," close=")">
            #{name}
        </foreach>
    </if>
</where>

六、特殊类型处理技巧

1. 枚举类型处理

// Mapper
List<User> selectByStatus(@Param("statusList") List<UserStatus> statusList);

// XML
<foreach collection="statusList" item="status" open="(" separator="," close=")">
    #{status, typeHandler=org.apache.ibatis.type.EnumTypeHandler}
</foreach>

2. 日期范围查询

// Mapper
List<User> selectByDates(@Param("dateList") List<Date> dates);

// XML
<foreach collection="dateList" item="date" separator=" OR ">
    create_time BETWEEN #{date} AND DATE_ADD(#{date}, INTERVAL 1 DAY)
</foreach>

七、性能优化与避坑指南

1. 空集合安全处理

<select id="safeSelect">
    SELECT * FROM users
    <where>
        <if test="idList != null and !idList.isEmpty()">
            id IN
            <foreach collection="idList" ... />
        </if>
    </where>
</select>

2. 大数据量分批查询

// 每500条执行一次查询
public List<User> batchSelect(List<Long> allIds) {
    List<User> result = new ArrayList<>();
    int batchSize = 500;
    
    for (int i = 0; i < allIds.size(); i += batchSize) {
        List<Long> batchIds = allIds.subList(i, Math.min(i + batchSize, allIds.size()));
        result.addAll(userMapper.selectByIds(batchIds));
    }
    return result;
}

3. SQL注入防护

<!-- 安全写法:使用#{}预编译 -->
<foreach collection="names" item="name">
    #{name}  <!-- 安全 -->
</foreach>

<!-- 危险写法:${}直接拼接 -->
<foreach collection="names" item="name">
    '${name}' <!-- 存在SQL注入风险! -->
</foreach>

八、完整可运行示例

Controller

@RestController
@RequestMapping("/users")
public class UserController {
    
    @PostMapping("/by-ids")
    public List<User> getUsersByIds(@RequestBody List<Long> ids) {
        return userService.getUsersByIds(ids);
    }
}

Service

@Service
@RequiredArgsConstructor
public class UserService {
    private final UserMapper userMapper;

    public List<User> getUsersByIds(List<Long> ids) {
        if (ids == null || ids.isEmpty()) {
            return Collections.emptyList();
        }
        // 超过1000条自动分批
        return ids.size() > 1000 ? batchSelect(ids) : userMapper.selectByIds(ids);
    }
}

Mapper XML

<mapper namespace="com.example.mapper.UserMapper">
    
    <select id="selectByIds" resultType="User">
        SELECT id, name, email 
        FROM users
        <where>
            <if test="idList != null and !idList.isEmpty()">
                id IN
                <foreach collection="idList" item="id" 
                         open="(" separator="," close=")">
                    #{id}
                </foreach>
            </if>
        </where>
    </select>
</mapper>

总结:核心要点回顾

1.必须使用正确的@Param包 import org.apache.ibatis.annotations.Param;

2.XML循环核心语法

<foreach collection="参数名" item="元素名" 
         open="开始符" separator="分隔符" close="结束符">
     #{元素名}
</foreach>

3.最佳实践选择

  • 简单查询:MyBatis Plus Wrapper
  • 复杂SQL:MyBatis XML + foreach
  • 超大数据:分批查询

4.安全防护

  • 始终使用#{}防止SQL注入
  • 空集合检查避免全表扫描

5.特殊类型处理

  • 枚举:添加typeHandler
  • 日期:指定jdbcType=TIMESTAMP

最后提醒: 当遇到参数绑定问题时,首先检查@Param导入的包是否正确,这是最常见的错误根源!

到此这篇关于SpringBoot+MyBatis进行XML中循环处理List参数的终极指南的文章就介绍到这了,更多相关SpringBoot处理List参数内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java基础详解之集合框架工具Collections

    Java基础详解之集合框架工具Collections

    这篇文章主要介绍了Java基础详解之集合框架工具Collections,文中有非常详细的代码示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-04-04
  • SpringBoot项目 文件上传临时目标被删除异常的处理方案

    SpringBoot项目 文件上传临时目标被删除异常的处理方案

    这篇文章主要介绍了SpringBoot项目 文件上传临时目标被删除异常的处理方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • Java实现入参数据批量数据校验详解

    Java实现入参数据批量数据校验详解

    在业务处理中一般入参是单条数据,这样数据校验比较容易,但是这种方法对于集合数据的校验不适用,下面我们就来看看如何对入参数据进行批量数据校验吧
    2024-02-02
  • Mybatis使用Collection属性的示例代码

    Mybatis使用Collection属性的示例代码

    本文主要介绍了Mybatis使用Collection属性的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-07-07
  • Spring StateMachine 使用小结

    Spring StateMachine 使用小结

    Spring StateMachine是一个用于管理复杂状态流转的框架,本文就来介绍一下Spring StateMachine 使用,具有一定的参考价值,感兴趣的可以了解一下
    2025-11-11
  • 深入浅析hbase的优点

    深入浅析hbase的优点

    本文讲述了HBase的特征和它的优点,并简要回顾了行键设计的重点之处,它还向你展示了如何在本地配置HBase环境,使用命令创建表、插入数据、检索指定行以及最后如何进行scan操作,感兴趣的朋友一起看看吧
    2017-09-09
  • spring Security配置拦截规则小结

    spring Security配置拦截规则小结

    本文介绍了使用Spring Security解决后台管理系统在访问静态资源如图片时需要登录验证的问题,通过配置拦截规则,将静态资源路径添加到白名单,感兴趣的可以了解一下
    2025-09-09
  • JavaFX实现UI美观效果代码实例

    JavaFX实现UI美观效果代码实例

    这篇文章主要介绍了JavaFX实现UI美观效果代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • MyBatis动态SQL与缓存原理深入分析

    MyBatis动态SQL与缓存原理深入分析

    这篇文章主要介绍了MyBatis动态SQL与缓存原理,Mybatis框架的动态SQL技术是一种根据特定条件动态拼装SQL语句的功能,它存在的意义是为了解决拼接SQL语句字符串时的痛点问题
    2023-02-02
  • Java注解与反射原理说明

    Java注解与反射原理说明

    今天小编就为大家分享一篇关于Java注解与反射原理说明,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-03-03

最新评论