Mybatis最入门---动态查询(foreach)

本文,我们来介绍使用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>  
  28.       
  29. </configuration>  
6.UserInfo.java文件内容如下:

[java] view plain copy
  1. @SuppressWarnings("serial")  
  2. public class UserInfo implements Serializable {  
  3.       
  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;  
  11.   
  12. //set,get,构造函数,toString,请自行补充  
  13. }  
7.user.java文件内容如下:

[java] view plain copy
  1. @SuppressWarnings("serial")  
  2. public class User implements Serializable{  
  3.       
  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;  
  2.   
  3. import java.io.InputStream;  
  4.   
  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;  
  9.   
  10. public class SqlSessionFactoryUtil {  
  11.   
  12.     private static SqlSessionFactory sqlSessionFactory;  
  13.       
  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.     }  
  26.       
  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 {  
  2.       
  3.     List<UserInfo> selectUserInfoByForEachArray(String[] sa);   
  4.       
  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>的用法需要具体应用场景和大量的练习,才能运用自如,请各位客官开心的敲代码吧!


参考资料

官方文档:http://www.mybatis.org/mybatis-3/dynamic-sql.html

其他博文:http://blog.csdn.net/isea533/article/details/21237175

原文地址:  https://blog.csdn.net/abcd898989/article/details/51227545

阅读更多
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

关闭
关闭
关闭