一、輸入映射和輸出映射
1.1 parameterType(輸入類型)
【傳遞簡單類型】
詳情參考Mybatis學習筆記之一(環境搭建和入門案例介紹)
使用#{}占位符,或者${}進行sql拼接。
【傳遞pojo對象】
詳情參考Mybatis學習筆記之一(環境搭建和入門案例介紹)
Mybatis使用ognl表達式解析對象字段的值,#{}或者${}括號中的值為pojo屬性名稱。
1.2 傳遞pojo包裝對象
開發中通過可以使用pojo傳遞查詢條件。查詢條件可能是綜合的查詢條件,不僅包括用戶查詢條件還包括其它的查詢條件(比如查詢用戶信息的時候,將用戶購買商品信息也作為查詢條件),這時可以使用包裝對象傳遞輸入參數。
包裝對象:Pojo類中的一個屬性是另外一個pojo。
需求:根據用戶名模糊查詢用戶信息,查詢條件放到QueryVo的user屬性中。
【編寫QueryVo類】
package com.kevin.entity; import java.io.Serializable; import java.util.List; import com.kevin.entity.User; public class QueryVo implements Serializable { /** * */ private static final long serialVersionUID = 1L; private User user; public void setUser(User user) { this.user = user; } }
【Mapper.xml文件】
在UserMapper.xml中配置sql,如下:
<!-- 根據QueryVo查詢 -->
<select id="findUserByQueryVo" parameterType="QueryVo" resultType="User">
select * from User where username like "%"#{user.username}"%"
</select>
【Mapper接口】
在UserMapper接口中添加方法,如下:
/* * 使用QueryVo根據用戶名稱模糊查詢 */ public List<User> findUserByQueryVo(QueryVo vo);
【測試方法】
在UserMapeprTest增加測試方法,如下:
/* * 使用QueryVo根據用戶名稱模糊查詢 */ @Test public void findUserByQueryVo() throws Exception{ String resource = "SqlMapConfig.xml"; InputStream in = Resources.getResourceAsStream(resource); SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in); SqlSession sqlSession = factory.openSession(); UserMapper userMapper = sqlSession.getMapper(UserMapper.class); QueryVo vo = new QueryVo(); User user = new User(); user.setUsername("王"); vo.setUser(user); List<User> list = userMapper.findUserByQueryVo(vo); for (User user2 : list) { System.out.println(user2); } }
1.3 resultType(輸出類型)
1.3.1 輸出簡單類型
需求:查詢用戶表數據條數
【Mapper.xml文件】
在UserMapper.xml中配置sql,如下:
<!-- 查詢數據條數 --> <select id="countUser" resultType="Integer"> select count(*) from User </select>
【Mapper接口】
在UserMapper添加方法,如下:
/* * 查詢數據條數 */ public Integer countUser();
【 測試方法】
/* * 查詢數據條數 */ @Test public void countUser() throws Exception{ String resource = "SqlMapConfig.xml"; InputStream in = Resources.getResourceAsStream(resource); SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in); SqlSession sqlSession = factory.openSession(); UserMapper userMapper = sqlSession.getMapper(UserMapper.class); Integer count = userMapper.countUser(); System.out.println(count); }
Tips:輸出簡單類型必須查詢出來的結果集有一條記錄,最終將第一個字段的值轉換為輸出類型。
1.3.2 輸出pojo對象
詳情參考Mybatis學習筆記之一(環境搭建和入門案例介紹)
1.3.3 輸出pojo列表
詳情參考Mybatis學習筆記之一(環境搭建和入門案例介紹)
1.4 resultMap
resultType可以指定將查詢結果映射為pojo,但需要pojo的屬性名和sql查詢的列名一致方可映射成功。如果sql查詢字段名和pojo的屬性名不一致,可以通過resultMap將字段名和屬性名作一個對應關系 ,resultMap實質上還需要將查詢結果映射到pojo對象中。resultMap可以實現將查詢結果映射為復雜類型的pojo,比如在查詢結果映射對象中包括pojo和list實現一對一查詢和一對多查詢。
需求:查詢訂單表order的所有數據
【聲明pojo對象】
package com.kevin.entity; import java.io.Serializable; import java.util.Date; public class Orders implements Serializable{ /** * */ private static final long serialVersionUID = 1L; private Integer id; private Integer userId; private String number; private Date createtime; private String note; public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public Integer getUserId() { return userId; } public void setUserId(Integer userId) { this.userId = userId; } public String getNumber() { return number; } public void setNumber(String number) { this.number = number == null ? null : number.trim(); } public Date getCreatetime() { return createtime; } public void setCreatetime(Date createtime) { this.createtime = createtime; } public String getNote() { return note; } public void setNote(String note) { this.note = note == null ? null : note.trim(); } @Override public String toString() { return "Orders [id=" + id + ", userId=" + userId + ", number=" + number + ", createtime=" + createtime + ", note=" + note + "]"; } }
【Mapper.xml文件】
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.kevin.mapper.OrdersMapper"> <!-- 查詢所有數據 --> <select id="findAll" resultType="Orders"> select * from Orders </select> </mapper>
【Mapper接口】
package com.kevin.mapper; import java.util.List; import com.kevin.entity.Orders; public interface OrdersMapper { /* * 查詢所有數據(類屬性與數據庫字段不一致) */ public List<Orders> findAll(); }
【測試方法】
/* *查詢所有數據(屬性名稱與數據庫字段名稱不一致) */ @Test public void findAll() throws Exception{ String resource = "SqlMapConfig.xml"; InputStream in = Resources.getResourceAsStream(resource); SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in); SqlSession sqlSession = factory.openSession(); OrdersMapper mapper = sqlSession.getMapper(OrdersMapper.class); List<Orders> list = mapper.findAll(); for (Orders order : list) { System.out.println(order); } }
1.4.1 使用resultMap
由於上邊的mapper.xml中sql查詢列(user_id)和Order類屬性(userId)不一致,所以查詢結果不能映射到pojo中。需要定義resultMap,把orderResultMap將sql查詢列(user_id)和Order類屬性(userId)對應起來
改造OrderMapper.xml,如下:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.kevin.mapper.OrdersMapper"> <resultMap type="Orders" id="orders"> <result column="user_id" property="userId"/> </resultMap> <!-- 查詢所有數據 --> <!-- <select id="findAll" resultType="Orders"> --> <select id="findAll" resultMap="orders"> select * from Orders </select> </mapper>
二、動態sql拼接
通過mybatis提供的各種標簽方法實現動態拼接sql。
需求:根據性別和名字查詢用戶
2.1 使用If標簽和WHERE標簽
【Mapper.xml文件】
<!-- 多條件查詢 where標簽可以去掉前面第一個and --> <select id="findUserBySexAndUsername" parameterType="User" resultType="User"> select * from User <where> <if test="sex != null and sex != ''"> sex = #{sex} </if> <if test="username != null"> and username = #{username} </if> </where> </select>
【Mapper接口】
編寫Mapper接口,如下:
/* * 多條件查詢 */ public List<User> findUserBySexAndUsername(User user);
【測試方法】
在UserMapperTest添加測試方法,如下:
/* * 多條件查詢 */ @Test public void findUserBySexAndUsername() throws Exception{ String resource = "SqlMapConfig.xml"; InputStream in = Resources.getResourceAsStream(resource); SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in); SqlSession sqlSession = factory.openSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); User user = new User(); user.setUsername("Kevin"); user.setSex("Male"); List<User> list = mapper.findUserBySexAndUsername(user); for (User u: list) { System.out.println(u); } }
2.2 Sql片段
Sql中可將重復的sql提取出來,使用時用include引用即可,最終達到sql重用的目的。
把上面例子中的select * from User 提取出來,作為sql片段,如下:
<!-- 提取SQL語句中重復片段 --> <sql id="selector"> select * from User </sql> <!-- 多條件查詢 where標簽可以去掉前面第一個and --> <select id="findUserBySexAndUsername" parameterType="User" resultType="User"> <include refid="selector"></include> <where> <if test="sex != null and sex != ''"> sex = #{sex} </if> <if test="username != null"> and username = #{username} </if> </where> </select>
2.3 foreach標簽
需求:根據多個id查詢用戶信息
【改造QueryVo】
如下面在pojo中定義list屬性ids存儲多個用戶id,並添加setter方法
package com.kevin.entity; import java.io.Serializable; import java.util.List; import com.kevin.entity.User; public class QueryVo implements Serializable { /** * */ private static final long serialVersionUID = 1L; private User user; private List<Integer> list; public void setList(List<Integer> list) { this.list = list; } public void setUser(User user) { this.user = user; } }
【Mapper.xml文件】
UserMapper.xml添加sql,如下:
<!-- 根據多個id查詢 --> <select id="findUserByIds" parameterType="QueryVo" resultType="User"> <include refid="selector"></include> where id in <foreach collection="list" item="id" separator="," open="(" close=")"> #{id} </foreach> </select>
【測試方法】
/* *根據多個id查詢 */ @Test public void findUserByIds() throws Exception{ String resource = "SqlMapConfig.xml"; InputStream in = Resources.getResourceAsStream(resource); SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in); SqlSession sqlSession = factory.openSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); /* * 使用QueryVo中的List列表 */ List<Integer> lists = new ArrayList<Integer>(); lists.add(28); lists.add(29); lists.add(25); lists.add(30); QueryVo vo = new QueryVo(); vo.setList(lists); List<User> list = mapper.findUserByIds(lists); for (User u: list) { System.out.println(u); } }
三、關聯查詢
3.1 一對一查詢
需求:查詢所有訂單信息,關聯查詢下單用戶信息。
注意:因為一個訂單信息只會是一個人下的訂單,所以從查詢訂單信息出發關聯查詢用戶信息為一對一查詢。如果從用戶信息出發查詢用戶下的訂單信息則為一對多查詢,因為一個用戶可以下多個訂單。
方法一:使用resultType
使用resultType,改造訂單pojo類,此pojo類中包括了訂單信息和用戶信息,這樣返回對象的時候,mybatis自動把用戶信息也注入進來了。
【改造pojo類】
OrderUser類繼承Order類后OrderUser類包括了Order類的所有字段,只需要定義用戶的信息字段即可,如下圖:
【Mapper.xml】
在UserMapper.xml添加sql,如下
<!-- 查詢訂單,同時包含用戶數據 --> <select id="queryOrderUser" resultType="orderUser"> SELECT o.id, o.user_id userId, o.number, o.createtime, o.note, u.username, u.address FROM `order` o LEFT JOIN `user` u ON o.user_id = u.id </select>
【Mapper接口】
在UserMapper接口添加方法,如下圖:
【測試方法】
在UserMapperTest添加測試方法,如下:
@Test public void testQueryOrderUser() { // mybatis和spring整合,整合之后,交給spring管理 SqlSession sqlSession = this.sqlSessionFactory.openSession(); // 創建Mapper接口的動態代理對象,整合之后,交給spring管理 UserMapper userMapper = sqlSession.getMapper(UserMapper.class); // 使用userMapper執行根據條件查詢用戶 List<OrderUser> list = userMapper.queryOrderUser(); for (OrderUser ou : list) { System.out.println(ou); } // mybatis和spring整合,整合之后,交給spring管理 sqlSession.close(); }
【小結】
定義專門的pojo類作為輸出類型,其中定義了sql查詢結果集所有的字段。此方法較為簡單,企業中使用普遍。
方法二:使用resultMap
使用resultMap,定義專門的resultMap用於映射一對一查詢結果。
【改造pojo類】
在Order類中加入User屬性,user屬性中用於存儲關聯查詢的用戶信息,因為訂單關聯查詢用戶是一對一關系,所以這里使用單個User對象存儲關聯查詢的用戶信息。
改造Order如下:
package com.kevin.entity; import java.io.Serializable; import java.util.Date; public class Orders implements Serializable{ /** * */ private static final long serialVersionUID = 1L; private Integer id; private Integer userId; private String number; private Date createtime; private String note; private User user; public void setUser(User user) { this.user = user; } public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public Integer getUserId() { return userId; } public void setUserId(Integer userId) { this.userId = userId; } public String getNumber() { return number; } public void setNumber(String number) { this.number = number == null ? null : number.trim(); } public Date getCreatetime() { return createtime; } public void setCreatetime(Date createtime) { this.createtime = createtime; } public String getNote() { return note; } public void setNote(String note) { this.note = note == null ? null : note.trim(); } @Override public String toString() { return "Orders [id=" + id + ", userId=" + userId + ", number=" + number + ", createtime=" + createtime + ", note=" + note + "]"; } }
【Mapper.xml】
<!-- 一對一關聯查詢 --> <resultMap type="Orders" id="order"> <result column="id" property="id"/> <result column="user_id" property="userId"/> <result column="number" property="number"/> <result column="createtime" property="createtime"/> <!-- 一對一 --> <association property="user" javaType="User"> <id column="user_id" property="id"/> <result column="username" property="username"/> </association> </resultMap> <select id="selectOrders" resultMap="order"> select o.id, o.user_id, o.number, o.createtime, u.username from orders o left join user u on o.user_id = u.id </select>
【Mapper接口】
/* * 一對一關聯查詢,以訂單為中心關聯用戶 */ public List<Orders> selectOrders();
【測試方法】
在UserMapperTest增加測試方法,如下:
/* * 一對一查詢 */ @Test public void selectOrders() throws Exception{ String resource = "SqlMapConfig.xml"; InputStream in = Resources.getResourceAsStream(resource); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in); SqlSession sqlSession = sqlSessionFactory.openSession(); OrdersMapper mapper = sqlSession.getMapper(OrdersMapper.class); List<Orders> selectOrders = mapper.selectOrders(); for (Orders orders : selectOrders) { System.out.println(orders); } }
3.2 一對多查詢
案例:查詢所有用戶信息及用戶關聯的訂單信息。用戶信息和訂單信息為一對多關系。
【修改pojo類】
在User類中加入List<Orders> ordersList屬性,如下:
package com.kevin.entity; import java.util.Date; import java.util.List; public class User { /** * 創建一個簡單的bean */ private static final long serialVersionUID = 1L; private Integer id; private String username;// 用戶姓名 private String sex;// 性別 private Date birthday;// 生日 private String address;// 地址 private List<Orders> ordersList; public List<Orders> getOrdersList() { return ordersList; } public void setOrdersList(List<Orders> ordersList) { this.ordersList = ordersList; } public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getSex() { return sex; } public void setSex(String sex) { this.sex = sex; } public Date getBirthday() { return birthday; } public void setBirthday(Date birthday) { this.birthday = birthday; } public String getAddress() { return address; } public void setAddress(String address) { this.address = address; } @Override public String toString() { return "User [id=" + id + ", username=" + username + ", sex=" + sex + ", birthday=" + birthday + ", address=" + address + "]"; } }
【Mapper.xml】
<!-- /* * 一對多關聯 */ public List<User> selectUsersList(); --> <resultMap type="User" id="user"> <id column="user_id" property="id"/> <result column="username" property="username"/> <!-- 一對多 --> <collection property="ordersList" ofType="Orders"> <id column="id" property="id"/> <result column="number" property="number"/> </collection> </resultMap> <select id="selectUserList" resultMap="user"> select o.id, o.user_id, o.number, o.createtime, u.username from user u left join orders o on o.user_id = u.id </select>
【Mapper接口】
編寫UserMapper接口,如下:
/* * 一對多關聯 */
public List<User> selectUserList();
【測試方法】
/* * 一對多關聯 */ @Test public void selectUsersList() throws Exception{ String resource = "SqlMapConfig.xml"; InputStream in = Resources.getResourceAsStream(resource); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in); SqlSession sqlSession = sqlSessionFactory.openSession(); OrdersMapper mapper = sqlSession.getMapper(OrdersMapper.class); List<User> selectUsersList = mapper.selectUserList(); for (User user : selectUsersList) { System.out.println(user); } }
四、Mybatis整合spring
4.1 整合思路
● SqlSessionFactory對象應該放到spring容器中作為單例存在。
● 傳統dao的開發方式中,應該從spring容器中獲得sqlsession對象。
● Mapper代理形式中,應該從spring容器中直接獲得mapper的代理對象。
● 數據庫的連接以及數據庫連接池事務管理都交給spring容器來完成。
4.2 整合需要的jar包
● spring的jar包
● Mybatis的jar包
● Spring+mybatis的整合包。
● Mysql的數據庫驅動jar包。
● 數據庫連接池的jar包。
4.3 整合的步驟
【創建工程】
創建一個java工程
【導入jar包】
前面提到的jar包需要導入,如下圖:
【加入配置文件】
● SqlMapConfig.xml.xml配置文件
● applicationContext.xml配置文件:
a) 數據庫連接及連接池
b) 事務管理(暫時可以不配置)
c) sqlsessionFactory對象,配置到spring容器中
d) mapeer代理對象或者是dao實現類配置到spring容器中。
【SqlMapConfig.xml】
配置文件是SqlMapConfig.xml,如下:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <!-- 設置別名 --> <typeAliases> <!-- 2. 指定掃描包,會把包內所有的類都設置別名,別名的名稱就是類名,大小寫不敏感 --> <package name="com.kevin.entity" /> </typeAliases> <mappers> <package name="com.kevin.mapper"/> </mappers> </configuration>
【applicationContext.xml】
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.0.xsd"> <!-- 加載配置文件 --> <context:property-placeholder location="classpath:db.properties"/> <!-- 數據庫連接池 --> <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="${jdbc.driver}" /> <property name="url" value="${jdbc.url}" /> <property name="username" value="${jdbc.username}" /> <property name="password" value="${jdbc.password}" /> <property name="maxActive" value="10" /> <property name="maxIdle" value="5" /> </bean> <!-- mybatis工廠 --> <bean id="sqlSessionFactoryBean" class="org.mybatis.spring.SqlSessionFactoryBean"> <!-- 配置數據源 --> <property name="dataSource" ref="dataSource"></property> <!-- 配置mybatis核心配置文件 --> <property name="configLocation" value="classpath:SqlMapConfig.xml"></property> </bean> </beans>
【db.properties】
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=admin
【log4j.properties】
# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
4.4 Dao的開發
兩種dao的實現方式:
● 原始dao的開發方式
● 使用Mapper代理形式開發方式
a) 直接配置Mapper代理
b) 使用掃描包配置Mapper代理
需求:
-
實現根據用戶id查詢
-
實現根據用戶名模糊查詢
-
添加用戶
傳統方式Dao開發可參考Mybatis學習筆記之一(環境搭建和入門案例介紹),下面主要介紹Mapper動態代理形式開發。
4.5 Mapper代理形式開發
【實現Mapper.xml】
編寫UserMapper.xml配置文件,如下:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.kevin.mapper.UserMapper"> <select id="findUserById" parameterType="Integer" resultType="User"> select * from User where id = #{id} </select> </mapper>
【實現UserMapper接口】
package com.kevin.mapper; import java.util.List; import com.kevin.entity.User; public interface UserMapper { public User findUserById(Integer id); }
方式一:配置mapper代理
在applicationContext.xml添加配置
<!-- mapper動態代理開發 --> <bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean"> <property name="sqlSessionFactory" ref="sqlSessionFactoryBean"></property> <property name="mapperInterface" value="com.kevin.mapper.UserMapper"></property> </bean>
【測試方法】
/* * mapper動態代理開發 */ @Test public void findUserById(){ ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); // context.getBean(UserMapper.class); UserMapper userMapper = (UserMapper) context.getBean("userMapper"); User user = userMapper.findUserById(1); System.out.println(user); }
方式二:掃描包形式配置mapper
在applicationContext.xml添加配置
<!-- mapper動態代理開發,掃描 --> <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <!-- 基本包 --> <property name="basePackage" value="com.kevin.mapper"></property> </bean>
【測試方法】
/* * 增強mapper動態代理開發 */ @Test public void findUserById2(){ ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); UserMapper mapper = context.getBean(UserMapper.class); User user = mapper.findUserById(30); System.out.println(user); }