首页 文章 精选 留言 我的

Mybatis最入门---动态查询（foreach）

2018-02-05 595

Mybatis最入门---动态查询（foreach）http://www.bieryun.com/983.html

[一步是咫尺，一步即天涯]

本文，我们来介绍使用Mybatis提供的<foreach>标签实现我们某些循环增改删差的需求。官方文档中的内容过于简陋，于是，博主筛选出比较全面讲述foreach用法的的内容，并且配有例子。希望各位看官能够手动敲一遍下面的例子，达到快速学习的目的。

准备工作：

a.操作系统 ：win7 x64

b.基本软件：MySQL，Mybatis，SQLyog

--------------------------------------------------------------------------------------------------------------------------------------------------------

我们先来叙述<foreach>中可以供我们使用的属性有哪些：

属性 描述
item 循环体中的具体对象。支持属性的点路径访问，如item.age,item.info.details。
具体说明：在list和数组中是其中的对象，在map中是value。
该参数为必选。
collection 要做foreach的对象，作为入参时，List<?>对象默认用list代替作为键，数组对象有array代替作为键，Map对象没有默认的键。
当然在作为入参时可以使用@Param("keyName")来设置键，设置keyName后，list,array将会失效。 除了入参这种情况外，还有一种作为参数对象的某个字段的时候。举个例子：
如果User有属性List ids。入参是User对象，那么这个collection = "ids"
如果User有属性Ids ids;其中Ids是个对象，Ids有个属性List id;入参是User对象，那么collection = "ids.id"
上面只是举例，具体collection等于什么，就看你想对那个元素做循环。
该参数为必选
separator 元素之间的分隔符，例如在in()的时候，separator=","会自动在元素中间用“,“隔开，避免手动输入逗号导致sql错误，如in(1,2,)这样。该参数可选。
open foreach代码的开始符号，一般设置为“(“和close=")"合用。常用在in(),values()时。该参数可选。
close foreach代码的关闭符号，一般设置为“)“和open="("合用。常用在in(),values()时。该参数可选。
index 在list和数组中,index是元素的序号，在map中，index是元素的key，该参数可选。【这个具体用法见下文】

--------------------------------------------------------------------------------------------------------------------------------------------------------

【本文我们将给出完整的工程代码，请读者一定在本地运行一遍，加深理解】

1.首先，创建我们的Spring09工程，工程结构图如下：

2.pom文件内容如下：

[html] view plain copy

  1. <dependencies>
  2.         <dependency>
  3.             <groupId>junit</groupId>
  4.             <artifactId>junit</artifactId>
  5.             <version>4.12</version>
  6.             <scope>test</scope>
  7.         </dependency>
  8.         <dependency>
  9.             <groupId>org.mybatis</groupId>
  10.             <artifactId>mybatis</artifactId>
  11.             <version>3.3.1</version>
  12.         </dependency>
  13.         <dependency>
  14.             <groupId>mysql</groupId>
  15.             <artifactId>mysql-connector-java</artifactId>
  16.             <version>5.1.26</version>
  17.         </dependency>
  18.         <dependency>
  19.             <groupId>log4j</groupId>
  20.             <artifactId>log4j</artifactId>
  21.             <version>1.2.17</version>
  22.         </dependency>
  23.     </dependencies>

3.数据库配置文件jdbc.properties内容如下：

[plain] view plain copy

  1. jdbc.driverClassName=com.mysql.jdbc.Driver
  2. jdbc.url=jdbc:mysql://localhost:3306/mybatis
  3. jdbc.username=root
  4. jdbc.password=1234

4.日志配置文件log4j.properties内容如下：

[plain] view plain copy

  1. log4j.rootLogger=debug,stdout
  2. log4j.appender.stdout=org.apache.log4j.ConsoleAppender
  3. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
  4. log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

5.mybatis-config.xml配置文件内容如下：

[html] view plain copy

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE configuration
  3. PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4. "http://mybatis.org/dtd/mybatis-3-config.dtd">
  5. <configuration>
  6.     <properties resource="jdbc.properties"/>
  7.     <settings>
  8.         <setting name="logImpl" value="LOG4J"/>
  9.     </settings>
  10.     <typeAliases>
  11.         <package name="com.csdn.ingo.entity"/>
  12.     </typeAliases>
  13.     <environments default="development">
  14.         <environment id="development">
  15.             <transactionManager type="JDBC" />
  16.             <dataSource type="POOLED">
  17.                 <property name="driver" value="${jdbc.driverClassName}" />
  18.                 <property name="url" value="${jdbc.url}" />
  19.                 <property name="username" value="${jdbc.username}" />
  20.                 <property name="password" value="${jdbc.password}" />
  21.             </dataSource>
  22.         </environment>
  23.     </environments>
  24.     <mappers>
  25.           <mapper resource="mappers/UserInfoMapper.xml"/>
  26.            <mapper resource="mappers/UserMapper.xml"/>
  27.     </mappers>
  29. </configuration>

6.UserInfo.java文件内容如下：

[java] view plain copy

  1. @SuppressWarnings("serial")
  2. public class UserInfo implements Serializable {
  4.     private String userid;
  5.     private String department;
  6.     private String position;
  7.     private String mobile;
  8.     private String gender;
  9.     private String email;
  10.     private Departments depart;
  12. //set,get，构造函数，toString，请自行补充
  13. }

7.user.java文件内容如下：

[java] view plain copy

  1. @SuppressWarnings("serial")
  2. public class User implements Serializable{
  4.     private String id;
  5.     private String password;
  6. //set,get，构造函数，toString，请自行补充

}

 

8.SqlSessionFactoryUtil.java内容如下：

[java] view plain copy

  1. package com.csdn.ingo.util;
  3. import java.io.InputStream;
  5. import org.apache.ibatis.io.Resources;
  6. import org.apache.ibatis.session.SqlSession;
  7. import org.apache.ibatis.session.SqlSessionFactory;
  8. import org.apache.ibatis.session.SqlSessionFactoryBuilder;
  10. public class SqlSessionFactoryUtil {
  12.     private static SqlSessionFactory sqlSessionFactory;
  14.     public static SqlSessionFactory getSqlSessionFactory(){
  15.         if(sqlSessionFactory==null){
  16.             InputStream inputStream=null;
  17.             try{
  18.                 inputStream=Resources.getResourceAsStream("mybatis-config.xml");
  19.                 sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
  20.             }catch(Exception e){
  21.                 e.printStackTrace();
  22.             }
  23.         }
  24.         return sqlSessionFactory;
  25.     }
  27.     public static SqlSession openSession(){
  28.         return getSqlSessionFactory().openSession();
  29.     }
  30. }

--------------------------------------------------------------------------------------------------------------------------------

准备工作结束，马上开始我们的<foreach>讲解，请睁大眼见哦！

--------------------------------------------------------------------------------------------------------------------------------

一.参数为数组Array。

1.UserTest的单元测试方法为：

[java] view plain copy

  1. @Test
  2.     public void testForEachArray() {
  3.         try {
  4.             String[] sa = new String[]{"admin","customer","customer2"};
  5.             UserInfoDao userInfo = sqlSession.getMapper(UserInfoDao.class);
  6.             List<UserInfo> UIList = userInfo.selectUserInfoByForEachArray(sa);
  7.             for (UserInfo ui : UIList) {
  8.                 System.out.println(ui.toString());
  9.             }
  10.         } catch (Exception e) {
  11.             e.printStackTrace();
  12.         }
  13.     }

【注意】

2.UserInfoDao.java的内容如下：【注意这里接口的形参为数组类型】

[java] view plain copy

  1. public interface UserInfoDao {
  3.     List<UserInfo> selectUserInfoByForEachArray(String[] sa);
  5. }

3.UserInfoMapper.xml的内容如下：

[html] view plain copy

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper
  3. PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  4. "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  5. <mapper namespace="com.csdn.ingo.dao.UserInfoDao">
  6.     <resultMap type="userInfo" id="UserInfoResult">
  7.         <id property="userid" column="userid" />
  8.         <result property="department" column="department" />
  9.         <result property="position" column="position" />
  10.         <result property="mobile" column="mobile" />
  11.         <result property="gender" column="gender" />
  12.         <result property="email" column="email" />
  13.     </resultMap>
  14. <select id="selectUserInfoByForEachArray" resultMap="UserInfoResult">
  15.         select * from userinfo
  16.         <if test="array!=null">
  17.             where userid in
  18.             <foreach item="item" collection="array" index="index" open="("
  19.                 separator="," close=")">
  20.                 #{item}
  21.             </foreach>
  22.         </if>
  23.     </select>
  24. </mapper>

【解释】

a。这里的if标签能够判断出数组是否为空。但是没有判断出数组中的内容是否为空。即，当数组中有内容时或者数组为null时，该SQL语句能够正常执行，但是如果数组为空的话，if判断的结果为真，但foreach执行0次。这种情况下，Mybatis会组装出1条错误的sql语句。换句话说这里if是多余的。

b。这里collection属性配置为”array“

c。index在这条语句中未使用，所以是可以缺省的。移除也不会引起错误

d。open，close只会在开始与结尾出现一次。

e。separator会使用配置的”，“来每次间隔<foreach>标签内的内容。

f。#{item}中的item必须与<foreach>中的item属性的值”item“保持一致。

------------------------------

4.运行单元测试方法，应该能够看到如下输出：【各位看官可以自行变化数组内容，观察控制台输出】


-------------------------------------------------------------------------------------------------------------------------------------

二。参数为List

1.在UserTest中新增单元测试方法：

[java] view plain copy

  1. @Test
  2.     public void testForEachList() {
  3.         try {
  4.             List<String> userlist = new ArrayList<String>();
  5.             userlist.add("admin");
  6.             userlist.add("customer");
  7.             userlist.add("customer2");
  8.             UserInfoDao userInfo = sqlSession.getMapper(UserInfoDao.class);
  9.             List<UserInfo> UIList = userInfo.selectUserInfoByForEachList(userlist);
  10.             for (UserInfo ui : UIList) {
  11.                 System.out.println(ui.toString());
  12.             }
  13.         } catch (Exception e) {
  14.             e.printStackTrace();
  15.         }
  16.     }

2.在UserInfoDao.java增加接口内容如下：

[java] view plain copy

  1. List<UserInfo> selectUserInfoByForEachList(List<String> sl);

3.在UserInfoDaoMapper.xml中，增加如下内容：

[html] view plain copy

  1. <select id="selectUserInfoByForEachList" resultMap="UserInfoResult">
  2.         select * from userinfo
  3.         <if test="list!=null">
  4.             where userid in
  5.             <foreach item="item" collection="list" index="index" open="("
  6.                 separator="," close=")">
  7.                 #{item}
  8.             </foreach>
  9.         </if>
  10.     </select>

【解释】

a.与上面类似：这里的if标签能够判断出List是否为空。但是没有判断出List中的内容是否为空。即，当List中有内容时或者List为null时，该SQL语句能够正常执行，但是如果List为空的话，if判断的结果为真，但foreach执行0次。这种情况下，Mybatis会组装出1条错误的sql语句。换句话说这里if是多余的。

b。这里collection属性配置为”list“

c。index在这条语句中未使用，所以是可以缺省的。移除也不会引起错误

d。其他内容请参考上面array中的解释

-------------------------------

4.运行单元测试方法，应该能够看到如下输出：【各位看官可以自行变化数组内容，观察控制台输出】

-------------------------------------------------------------------------------------------------------------------------------------

三。参数为Map

1.在UserTest中新增单元测试方法：

[java] view plain copy

  1. @Test
  2.     public void testForEachMap() {
  3.         try {
  4.             Map<String, Object> map = new HashMap<String, Object>();
  5.             List<String> userlist = new ArrayList<String>();
  6.             userlist.add("admin");
  7.             map.put("userids", userlist);
  8.             UserInfoDao userInfo = sqlSession.getMapper(UserInfoDao.class);
  9.             List<UserInfo> UIList = userInfo.selectUserInfoByForEach(map);
  10.             for (UserInfo ui : UIList) {
  11.                 System.out.println(ui.toString());
  12.             }
  13.         } catch (Exception e) {
  14.             e.printStackTrace();
  15.         }
  16.     }

2.在UserInfoDao.java增加接口内容如下：

[java] view plain copy

  1. List<UserInfo> selectUserInfoByForEach(Map<String,Object> map);

3.在UserInfoDaoMapper.xml中，增加如下内容：

[html] view plain copy

  1. <select id="selectUserInfoByForEach" parameterType="Map"
  2.         resultMap="UserInfoResult">
  3.         select * from userinfo
  4.         <if test="userids!=null">
  5.             where userid in
  6.             <foreach item="ParamsId" collection="userids" index="index"
  7.                 open="(" separator="," close=")">
  8.                 #{ParamsId}
  9.             </foreach>
  10.         </if>
  11.     </select>

【解释】

a.与上面类似：这里的if标签能够判断出map中否包含userids这个key，其对应的value可以任意。但是没有判断出value中的内容是否为空。即，当value中有内容时或者key不存在时，该SQL语句能够正常执行，但是如果value为空的话，if判断的结果为真，但foreach执行0次。这种情况下，Mybatis会组装出1条错误的sql语句。换句话说这里if是多余的。

b.这里collection属性配置为map中list对应的key的值，而不是value或者”list“

c.各位看官请注意这里的#{ParamsId}是与属性item中的ParamsId对应的

----------------------------------

4.运行单元测试方法，应该能够看到如下输出：【各位看官可以自行变化数组内容，观察控制台输出】


-------------------------------------------------------------------------------------------------------------------------------------

四。特别的index
1.在UserTest中新增单元测试方法：

[java] view plain copy

  1. @Test
  2.     public void testForeachIndex() {
  3.         try {
  4.             Map<String, Object> map = new HashMap<String, Object>();
  5.             Map<String,Object> user=new HashMap<String, Object>();
  6.             user.put("1", "aaa");
  7.             user.put("2", "bbb");
  8.             user.put("3", "ccc");
  9.             user.put("4", "ddd");
  10.             user.put("5", "eee");
  11.             map.put("map", user);
  12.             UserDao userDao = sqlSession.getMapper(UserDao.class);
  13.                         int re = userDao.insertUserByForEachIndex(map);
  14.             if(re==1){
  15.                 System.out.println("success");
  16.             }
  17.             sqlSession.commit();
  18.         } catch (Exception e) {
  19.             e.printStackTrace();
  20.         }
  21.     }

2.在UserDao.java增加接口内容如下：

[java] view plain copy

  1. public interface UserDao {
  2.     int insertUserByForEachIndex(Map<String,Object> map);
  3. }

3.在UserDaoMapper.xml中，增加如下内容：

[java] view plain copy

  1. <insert id="insertUserByForEachIndex">
  2.         insert into sysuser (id,password) values
  3.         <foreach collection="map" index="id" item="item" separator=","
  4.             open="" close="">
  5.             (#{id},#{item})
  6.         </foreach>
  7.     </insert>

【注释】

博主这里找了官方文档，其给出的解释是：当使用可迭代对象或者数组时，index是当前迭代的次数，item的值是本次迭代获取的元素。当使用字典（或者Map.Entry对象的集合）时，index是键，item是值。

这里我们又参考其他博文中给出的解释，设计上面的示例，供各位看官学习。

作为示例，请读者特别留心SQL语句中所诠释的官方文档的意思。即，index对应key，item对应value。

鉴于篇幅的关系，更多用法就请各位举一反三吧！

----------------------------------

4.运行单元测试方法，应该能够看到如下输出：

-------------------------------------------------------------------------------------------------------------------------------------

至此，Mybatis最入门---动态查询（foreach）结束

特别备注：

关于<foreach>的用法需要具体应用场景和大量的练习，才能运用自如，请各位客官开心的敲代码吧！

上一篇 下一篇
优秀的个人博客,低调大师

微信关注我们

原文链接：https://yq.aliyun.com/articles/437149

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

BigDecimal的用法详解(保留两位小数,四舍五入,数字格式化，科学计数法转数字，数字里的逗号处理）

BigDecimal的用法详解(保留两位小数,四舍五入,数字格式化，科学计数法转数字，数字里的逗号处理）http://www.bieryun.com/972.html 一、简介 Java在java.math包中提供的API类BigDecimal，用来对超过16位有效位的数进行精确的运算。双精度浮点型变量double可以处理16位有效数。在实际应用中，需要对更大或者更小的数进行运算和处理。float和double只能用来做科学计算或者是工程计算，在商业计算中要用java.math.BigDecimal。BigDecimal所创建的是对象，我们不能使用传统的+、-、*、/等算术运算符直接对其对象进行数学运算，而必须调用其相对应的方法。方法中的参数也必须是BigDecimal的对象。构造器是类的特殊方法，专门用来创建对象，特别是带有参数的对象。 二、构造器描述 BigDecimal(int) 创建一个具有参数所指定整数值的对象。 BigDecimal(double) 创建一个具有参数所指定双精度值的对象。 BigDecimal(long) 创建一个具有参数所指定长整数值的对象。 BigDec...
2018-02-06
683
上一篇

将excel文件内容存储到数据库，并可以实时在前端查看（不必生成文件）

版权声明：本文为博主原创文章，未经博主允许不得转载 本文主要讲前端内容，后端涉及较少，可以认为是使用Java。 首先是excel文件上传，这个较为简单，可以html5的数据接口FormData()进行操作。具体代码如下： <!DOCTYPE html> <html> <head> </head> <body> <input type="file" id="_file" value=""/><p for="file">或点此选择文件</p> <button id = "file_button" >按钮</button> </body> </html> 然后是对应的javascript $("#button").click(function(){ var files = $('#_file').prop('files'); var data = new FormData(); data.append("upload",files[0]); //因为...
2018-02-06
614
下一篇

相关文章

发表评论

资源下载

更多资源
Mario

Mario

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长，特征是大鼻子、头戴帽子、身穿背带裤，还留着胡子。与他的双胞胎兄弟路易基一起，长年担任任天堂的招牌角色。

时间: 2025-12-12 大小: 211.28KB 下载: 54次
腾讯云软件源

腾讯云软件源

为解决软件依赖安装时官方源访问速度慢的问题，腾讯云为一些软件搭建了缓存服务。您可以通过使用腾讯云软件源站来提升依赖包的安装速度。为了方便用户自由搭建服务架构，目前腾讯云软件源站支持公网访问和内网访问。

时间: 2025-12-28 大小: 1MB 下载: 4次
Nacos

Nacos

Nacos /nɑ:kəʊs/ 是 Dynamic Naming and Configuration Service 的首字母简称，一个易于构建 AI Agent 应用的动态服务发现、配置管理和AI智能体管理平台。Nacos 致力于帮助您发现、配置和管理微服务及AI智能体应用。Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据、流量管理。Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。

时间: 2025-12-21 大小: 189MB 下载: 2次
Spring

Spring

Spring框架（Spring Framework）是由Rod Johnson于2002年提出的开源Java企业级应用框架，旨在通过使用JavaBean替代传统EJB实现方式降低企业级编程开发的复杂性。该框架基于简单性、可测试性和松耦合性设计理念，提供核心容器、应用上下文、数据访问集成等模块，支持整合Hibernate、Struts等第三方框架，其适用范围不仅限于服务器端开发，绝大多数Java应用均可从中受益。

时间: 2025-12-17 大小: 5MB 下载: 1次
手机查看

扫码在手机上查看文章

扫描二维码，手机阅读更方便

热门标签
Redis Gemini3 OpenAi SpringBoot4 Jdk25 Service Mesh DeepSeek Rocky Docker Nacos3 HarmonyOS6 Kubernetes SpringCloud

欢迎您来访！

登录后，您将获得更多功能！
热门文章
联系我们

有任何问题或合作意向欢迎联系我们

Email: 99873273@qq.com

QQ: 99873273

用户登录
用户注册