脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Mybatis foreach使用

Mybatis中foreach的使用详解

 更新时间：2024年11月20日 09:32:24   作者：星空寻流年  
Mybatis中foreach标签的使用详解,包括属性说明、代码示例和总结,感兴趣的朋友跟随小编一起看看吧

一、foreach 属性使用

<foreach collection="list" index="index" item="mchntCd" open="(" close=")" separator=",">
   #{mchntCd}
</foreach>
  • item：  集合中元素迭代时的别名，该参数为必选，通过别名进行取值
  • index：在list和数组中,index是元素的序号，在map中，index是元素的key，非必填
  • open： foreach代码的开始符号，一般是(和close=")"合用。常用在in(),values()时。非必填
  • separator：元素之间的分隔符，例如在in()的时候，separator=","会自动在元素中间用“,“隔开，避免手动输入逗号导致sql错误，如in(1,2,)这样。非必填
  • close: foreach代码的关闭符号，一般是)和open="("合用。常用在in(),values()时。非必填
  • collection: 要做foreach的对象，作为入参
    • 传入是集合，也就是接口里面用的  List<String> nameList    那么 使用 collection = “list”
    • 传入的是数组，接口里面 String[] namestrs ,那么 使用 collection = “array”
    • 如果传入的是一个实体bean，实体bean里面有一个属性为 list<String> ids 那么collection = “ids ”，如果实体bean中对应ids是一个对象，ids 里面有一个属性为 List<Stirng> usernames,那么collection = “ids.usernames”

二、代码使用         

1、实体类 list<String>  mchntCds

 mapper接口  ---》 list方式

int queryDiscDerateCount(List<String> mchntCds);

mapper映射xml：

<select id="queryDiscDerateCount"  resultType="Integer">
   select count(*) from t_mchnt_disc_config  where mchnt_cd in
   <foreach collection="list" index="index" item="mchntCd" open="(" close=")"  separator=",">
      #{mchntCd}
   </foreach>
</select>

2、实体类 list<User>  userlist,实体类中有 list 属性

实体类：

@Data
public class MchntDiscDerateDto {
   private String mchntCd = "";
}

mapper接口

List<TMchntDerateInfoDto> getDiscDerateList(List<MchntDiscDerateDto> discDto);

mapper映射xml：

<select id="getDiscDerateList" parameterType="MchntDiscDerateDto" resultType="TMchntDerateInfoDto">
   select
    t_mchnt_disc_derate_config
      where
         mchnt_cd in
         <foreach collection="list" index="index" item="user" open="(" close=")" separator=",">
            #{user.mchntCd}
         </foreach>
</select>

3、数组  String[] params     

用 array 

mapper 接口

int queryDiscDerateCount(String[] mchntCds);

mapper映射xml：

<select id="queryDiscDerateCount"  resultType="Integer">
   select count(*) from t_mchnt_disc_derate_config where mchnt_cd in
   <foreach collection="array" index="index" item="mchntCd" open="(" close=")" separator=",">
      #{mchntCd}
   </foreach>
</select>

4、传入的参数是实体类，并且实体中包含数组和集合

实体类：

@Data
public class UserVo {
    private Long id;
    private Long supplierId;
    private Long[] ids;
    private List<Long> clientIdList;
}

mapper接口

List<UserVo> queryList(UserVo select);

mapper映射文件xml

    <select id="queryList" resultType="UserVo" parameterType="UserVo">
        select *
        from bms_bills_memo
        <where>
        and id in
        <foreach collection="ids" open="(" close=")" item="id" separator=",">
            #{id}
        </foreach>
        and
        client_id in
        <foreach collection="clientIdList" separator="," item="detail" open="(" close=")" >
            #{detail}
        </foreach>
        </where>
    </select>

5、传入多个list或者array，不使用实体进行封装。用注解@Params, collection使用到Param中定义的别名

mapper接口

List<UserVo> queryList(@Param("idArray") Long[] array, @Param("clientIdList") List<Long> list);

mapper映射文件xml

    <select id="queryList" resultType="UserVo">
        select *
        from t_user_inf
        <where>
            and id in
            <foreach collection="idArray" open="(" close=")" item="id" separator=",">
                #{id}
            </foreach>
            and
            client_id in
            <foreach collection="clientIdList" separator="," item="detail" open="(" close=")" >
                #{detail}
            </foreach>
        </where>
    </select>

6、map参数

当我们传入的参数为 Map<String,Objject>的时候，那么能不能正常使用 foreach呢，答案是肯定的，因为对象也是类似于map结构啊

    /**
     *  map 获取数据
     * @param map
     * @return
     */
    List<SysUser> getUserByIds(Map<String,Object> map);
 
 
    // xml
    <select id="getUserByIds" resultMap="BaseResultMap">
    select
        <include refid="Base_Column_List" />
    from t_sys_user
    where status = #{status}
    and id in
    <foreach collection="ids" item="id" open="(" close=")" separator=",">
        #{id}
    </foreach>
  </select>

实际调用：

     @Test
    public void testMapUsers() {
        Map<String,Object> params = new HashMap<>();
        params.put("status", "1");
        params.put("ids", Arrays.asList(1,2,3,4,5,6,7,8));
        List<SysUser> all = sysUserDao.getUserByIds(params);
        try {
            System.out.println(new JsonMapper().writeValueAsString(all));
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
    }

调用结果：

三、总结

    1、mapper 接口中添加 @Param注解的场合，list,array将会失效；

    2、使用了 @Param注解 collection的内容需要使用Param中的别名来指定你需要用到的list或者array

扩展：Mybatis中foreach的使用

首先我们要明白的是foreach的本质就是把数据库能执行的sql在xml中按照一定语法来进行拼接，所以拼接之前，我们了解一下foreach标签中几个常见元素的作用
1.collection
‌List或Array‌：如果传入的参数类型是List或Array，collection属性的默认值分别是list和array。如果需要自定义集合名称。
‌Map‌：如果传入的参数是Map，collection属性可以指定遍历Map的keys、values或entrySet
2.item
集合遍历中每一个元素的别名
3.open
拼接sql时最前面拼接的字符串
4.separator
拼接sql时候两个元素之间的分隔字符串
5.close
拼接sql时最后面拼接的字符串
6.index
index‌：在List或Array中，index为元素的序号索引；在Map中，index为遍历元素的key值。
举一个简单的例子
一个简单的sql

select * from blog where title is not null and (id=1 or id=2 or id=3)

1.我们使用map集合作为参数实现拼接

<select id="queryBlogForeach" parameterType="map" resultType="blog"> select * from blog <where> title is not null <foreach collection="ids" item="id" open="and (" separator="or" close=")"> id=#{id} </foreach> </where> </select>

2.我们使用list集合作为参数实现拼接

<select id="queryBlogForeach2" parameterType="list" resultType="blog"> select * from blog <where> title is not null <foreach collection="list" item="id" open="and (" separator="or" close=")"> id=#{id} </foreach> </where> </select>

到此这篇关于Mybatis中foreach的使用的文章就介绍到这了,更多相关Mybatis foreach使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • 关于Java虚拟机HotSpot

    关于Java虚拟机HotSpot

    这篇文章主要介绍了关于Java虚拟机HotSpot，在Java类中的一些方法会被由C/C++编写的HotSpot虚拟机的C/C++函数调用，不过由于Java方法与C/C++函数的调用约定不同，所以并不能直接调用，需要JavaCalls::call()这个函数辅助调用，下面我们来看看文章对内容的具体介绍
    2021-11-11
  • 基于SpringMVC实现网页登录拦截

    基于SpringMVC实现网页登录拦截

    SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。因此，本文将为大家介绍如何通过SpringMVC实现网页登录拦截功能，需要的小伙伴可以了解一下
    2021-12-12
  • SpringMVC的工程搭建步骤实现

    SpringMVC的工程搭建步骤实现

    这篇文章主要介绍了SpringMVC的工程搭建步骤实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • Java Web实现登录页面验证码验证功能

    Java Web实现登录页面验证码验证功能

    这篇文章主要介绍了Java Web登录页面验证码验证功能,本文通过实例代码给大家介绍的非常详细，具有一定的参考借鉴价值，需要的朋友可以参考下
    2019-12-12
  • Java反射概念与使用实例代码

    Java反射概念与使用实例代码

    JAVA反射机制是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法,下面这篇文章主要给大家介绍了关于Java反射概念与使用的相关资料,需要的朋友可以参考下
    2021-11-11
  • Java中解压缩文件的方法详解(通用)

    Java中解压缩文件的方法详解(通用)

    在软件开发和数据处理领域,文件的解压缩和压缩是常见的任务,下面这篇文章主要给大家介绍了关于Java中解压缩文件的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-06-06
  • java仿QQ连连看游戏

    java仿QQ连连看游戏

    这篇文章主要为大家详细介绍了java仿QQ连连看游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2019-01-01
  • spring-boot-maven-plugin 配置有啥用

    spring-boot-maven-plugin 配置有啥用

    这篇文章主要介绍了spring-boot-maven-plugin 配置是干啥的，这个是SpringBoot的Maven插件，主要用来打包的，通常打包成jar或者war文件，本文通过示例代码给大家介绍的非常详细，需要的朋友可以参考下
    2022-08-08
  • Java面试题之MD5加密的安全性详解

    Java面试题之MD5加密的安全性详解

    MD5 是 Message Digest Algorithm 的缩写，译为信息摘要算法，它是 Java 语言中使用很广泛的一种加密算法。本文将通过示例讨论下MD5的安全性，感兴趣的可以了解一下
    2022-10-10
  • java 中file.encoding的设置详解

    java 中file.encoding的设置详解

    这篇文章主要介绍了java 中file.encoding的设置详解的相关资料,需要的朋友可以参考下
    2017-04-04

最新评论