1 MyBatis簡介
1.1 MyBatis
MyBatis 本是apache的一個開源項目iBatis, 2010年這個項目由apache software foundation 遷移到了google code,并且改名為MyBatis,實質上Mybatis對ibatis進行一些改進。
MyBatis是一個優秀的持久層框架,它對jdbc的操作數據庫的過程進行封裝,使開發者只需要關注 SQL 本身,而不需要花費精力去處理例如注冊驅動、創建connection、創建statement、手動設置參數、結果集檢索等jdbc繁雜的過程代碼。
對jdbc的封裝框架有哪些:Hibernate,dbutils,jdbcTemplate[spring],mybatis
原理:Mybatis通過xml或注解的方式將要執行的各種statement(statement、preparedStatemnt、CallableStatement)配置起來,并通過java對象和statement中的sql進行映射生成最終執行的sql語句,最后由mybatis框架執行sql并將結果映射成java對象并返回。
1.2 jdbc程序代碼
- 存在的問題
- 數據庫連接頻繁開啟和關閉,會嚴重影響數據庫的性能。
- 代碼中存在硬編碼,分別是數據庫部分的硬編碼和SQL執行部分的硬編碼。
1.3 MyBatis的框架核心
- mybatis配置文件,包括Mybatis全局配置文件和Mybatis映射文件,其中全局配置文件配置了數據源、事務等信息;映射文件配置了SQL執行相關的 信息。
- mybatis通過讀取配置文件信息(全局配置文件和映射文件),構造出SqlSessionFactory,即會話工廠。
- 通過SqlSessionFactory,可以創建SqlSession即會話。Mybatis是通過SqlSession來操作數據庫的。
- SqlSession本身不能直接操作數據庫,它是通過底層的Executor執行器接口來操作數據庫的。Executor接口有兩個實現類,一個是普通執行器,一個是緩存執行器(默認)。
- Executor執行器要處理的SQL信息是封裝到一個底層對象MappedStatement中。該對象包括:SQL語句、輸入參數映射信息、輸出結果集映射信息。其中輸入參數和輸出結果的映射類型包括HashMap集合對象、POJO對象類型。
2 MyBatis入門
2.1 環境準備
-
創建數據庫表
image.png 下載MyBatis
mybaits的代碼由github.com管理,下載地址:<u>https://github.com/mybatis/mybatis-3/releases</u>-
創建項目導包
-
導入下面的包
image.png
image.png
-
-
添加log4j.properties
- Mybatis使用的日志包是log4j的,所以需要添加log4j.properties。
在classpath下創建log4j.properties如下:【文件內容可以從mybatis-3.2.7.pdf中拷貝】 - 日志級別在開發階段設置成DEBUG,在生產階段設置成INFO或者ERROR
- Mybatis使用的日志包是log4j的,所以需要添加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
2.2 開發步驟
1、創建PO(model)類,根據需求創建;
2、創建全局配置文件SqlMapConfig.xml;
3、編寫映射文件;
4、加載映射文件,在SqlMapConfig.xml中進行加載;
5、編寫測試程序,即編寫Java代碼,連接并操作數據庫。
思路:
a)讀取配置文件;
b)通過SqlSessionFactoryBuilder創建SqlSessionFactory會話工廠。
c)通過SqlSessionFactory創建SqlSession。
d)調用SqlSession的操作數據庫方法。
e)關閉SqlSession。
-
創建PO類
image.png -
創建SqlMapConfig.xml
- 在classpath(src)下,創建SqlMapConfig.xml文件【SqlMapConfig.xml(文件頭可以從mybatis-3.2.7.pdf文檔的2.1.2小節中拷貝)】
<configuration>
<!-- 配置mybatis的環境信息 -->
<environments default="development">
<environment id="development">
<!-- 配置JDBC事務控制,由mybatis進行管理 -->
<transactionManager type="JDBC"></transactionManager>
<!-- 配置數據源,采用dbcp連接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatisday01?useUnicode=true&characterEncoding=utf8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
</configuration>
- 映射文件
- 在classpath下,創建sqlmap文件夾。在sqlmap目錄下,創建User.xml映射文件。
【Mybatis的映射文件頭(可以從mybatis-3.2.7.pdf文件中拷貝)】
- 在classpath下,創建sqlmap文件夾。在sqlmap目錄下,創建User.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">
<!--
namespace:命名空間,它的作用就是對SQL進行分類化管理,可以理解為SQL隔離
注意:使用mapper代理開發時,namespace有特殊且重要的作用
-->
<mapper namespace="test">
<!--
[id]:statement的id,要求在命名空間內唯一
[parameterType]:入參的java類型
[resultType]:查詢出的單條結果集對應的java類型
[#{}]: 表示一個占位符?
[#{id}]:表示該占位符待接收參數的名稱為id。注意:如果參數為簡單類型時,#{}里面的參數名稱可以是任意定義
-->
<select id="findUserById" parameterType="int" resultType="com.gyf.domain.User">
SELECT * FROM USER WHERE id = #{id}
</select>
</mapper>
- 配置文件加載映射文件
<!--告訴MyBatis加載映射文件-->
<mappers>
<mapper resource="com/kdj/sqlmap/User.xml"></mapper>
</mappers>
- 測試類
@Test
public void test1() throws IOException {
//a)讀取配置文件;
InputStream is = Resources.getResourceAsStream("SqlMapConfig.xml");
//b)通過SqlSessionFactoryBuilder創建SqlSessionFactory會話工廠。
SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(is);
//c)通過SqlSessionFactory創建SqlSession。
SqlSession session = sessionFactory.openSession();
//d)調用SqlSession的操作數據庫方法。
User user = session.selectOne("findUserById", 10);
System.out.println(user);
//e)關閉SqlSession。
session.close();
}
2.3 更多案例講解
- 模糊查詢用戶信息
<!--
[${}]:表示拼接SQL字符串
[${value}]:表示要拼接的是簡單類型參數。
注意:
1、如果參數為簡單類型時,${}里面的參數名稱必須為value
2、${}會引起SQL注入,一般情況下不推薦使用。但是有些場景必須使用${},比如order by ${colname}
-->
<select id="findUserByName" parameterType="String" resultType="com.kdj.model.User">
SELECT * FROM user WHERE username like '%${value}%'
</select>
List<User> users = session.selectList("findUserByName", "張");
System.out.println(users);
- 插入用戶信息
- 增刪改要commit事務
<!--插入數據
這里的占位是寫模型的屬性
-->
<insert id="insertUser" parameterType="com.kdj.model.User">
INSERT INTO user (username, sex, birthday, address)
VALUE (#{username},#{sex},#{birthday},#{address});
</insert>
@Test
public void test2() {
User user = new User("kdj04", "2", new Date(), "上海");
session.insert("insertUser", user);
//增刪改要提交事務
session.commit();
}
- 刪除用戶
<!--刪除-->
<delete id="deleteUser" parameterType="int">
DELETE FROM user where id = #{id};
</delete>
/**
* 刪除用戶
*/
@Test
public void test3() {
int affectRows = session.delete("deleteUser", 34);
session.commit();//事務
System.out.println("受影響的行數:" + affectRows);
}
- 更新用戶
<!--更新-->
<update id="updateUser" parameterType="com.kdj.model.User">
UPDATE user SET sex = #{sex},address = #{address}
WHERE id = #{id}
</update>
/**
* 更新用戶
*/
@Test
public void test4() {
User user = new User();
user.setId(32);
user.setSex("男");
user.setAddress("香港");
int affectRows = session.update("updateUser", user);
session.commit();//事務
System.out.println("受影響的行數:" + affectRows);
}
- 主鍵返回之MySQL自增主鍵
- 思路:
- MySQL自增主鍵,是指在insert之前MySQL會自動生成一個自增的主鍵。
- 我們可以通過MySQL的函數獲取到剛插入的自增主鍵:
LAST_INSERT_ID() - 這個函數是在insert語句之后去調用。
- 思路:
<!--插入時自動返回主鍵id-->
<insert id="insertUser2" parameterType="com.kdj.model.User">
<!--
[selectKey標簽]:通過select查詢來生成主鍵
[keyProperty]:指定存放生成主鍵的屬性
[resultType]:生成主鍵所對應的Java類型
[order]:指定該查詢主鍵SQL語句的執行順序,相對于insert語句
[last_insert_id]:MySQL的函數,要配合insert語句一起使用 -->
<selectKey keyProperty="id" resultType="int" order="AFTER">
SELECT LAST_INSERT_ID()
</selectKey>
<!-- 如果主鍵的值是通過MySQL自增機制生成的,那么我們此處不需要再顯示的給ID賦值 -->
INSERT INTO user (username, sex, birthday, address)
VALUE (#{username},#{sex},#{birthday},#{address});
</insert>
/**
* 插入后,往模型里設置id
*/
@Test
public void test5() {
User user = new User("kdj07", "2", new Date(), "上海");
session.insert("insertUser2", user);
//增刪改要提交事務
session.commit();
System.out.println("用戶的ID" + user.getId());
}
- 主鍵返回之MySQL自增UUID
<insert id="insertUser" parameterType="com.gyf.domain.User">
<selectKey keyProperty="id" resultType="String" order="BEFORE">
SELECT UUID()
</selectKey>
INSERT INTO USER (username,sex,birthday,address)
VALUES(#{username},#{sex},#{birthday},#{address})
-
ORCLE主鍵
- SELECT user_seq.nextval() FROM dual
小結
parameterType和resultType
parameterType指定輸入參數的java類型,可以填寫別名或Java類的全限定名。
resultType指定輸出結果的java類型,可以填寫別名或Java類的全限定名。
#{}和${}
#{}:相當于預處理中的占位符?。
#{}里面的參數表示接收java輸入參數的名稱。
#{}可以接受HashMap、POJO類型的參數。
當接受簡單類型的參數時,#{}里面可以是value,也可以是其他。
#{}可以防止SQL注入。
${}:相當于拼接SQL串,對傳入的值不做任何解釋的原樣輸出。
${}會引起SQL注入,所以要謹慎使用。
${}可以接受HashMap、POJO類型的參數。
當接受簡單類型的參數時,${}里面只能是value。
selectOne和selectList
selectOne:只能查詢0或1條記錄,大于1條記錄的話,會報錯:
selectList:可以查詢0或N條記錄
2.4 MyBatis的Dao編寫 【一般不用,有更多好方式】
- DAO
package com.kdj.dao;
import com.kdj.model.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
public class UserDaoImpl implements UserDao {
private SqlSessionFactory ssf;
public UserDaoImpl(SqlSessionFactory ssf) {
this.ssf = ssf;
}
public UserDaoImpl() {
}
@Override
public void save(User user) {
//獲取session
SqlSession session = ssf.openSession();
//插入數據
session.insert("insertUser", user);
session.commit();
session.close();
}
@Override
public User findUserById(int id) {
//獲取session
SqlSession session = ssf.openSession();
//插入數據
User user = session.selectOne("findUserById", id);
session.close();
return user;
}
}
- 測試
package com.kdj.test;
import com.kdj.dao.UserDao;
import com.kdj.dao.UserDaoImpl;
import com.kdj.model.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
import java.util.List;
public class Demo03 {
SqlSessionFactory sessionFactory;
@Before
public void before() throws IOException {
System.out.println("before........獲取session");
//a)讀取配置文件;
InputStream is = Resources.getResourceAsStream("SqlMapConfig.xml");
//b)通過SqlSessionFactoryBuilder創建SqlSessionFactory會話工廠。
sessionFactory = new SqlSessionFactoryBuilder().build(is);
}
@Test
public void test1() throws IOException {
//調用dao
//1.創建dao
UserDao userDao = new UserDaoImpl(sessionFactory);
User user1 = userDao.findUserById(1);
System.out.println(user1);
User user2 = new User("xxxx", "x", new Date(), "xx");
userDao.save(user2);
}
}
2.5 MyBatis的Dao編寫【mapper代理方式實現】
- Mapper代理的開發方式,程序員只需要編寫mapper接口(相當于dao接口)即可。Mybatis會自動的為mapper接口生成動態代理實現類。
不過要實現mapper代理的開發方式,需要遵循一些開發規范。 - 開發規范
1.mapper接口的全限定名要和mapper映射文件的namespace的值相同。
2.mapper接口的方法名稱要和mapper映射文件中的statement的id相同;
3.mapper接口的方法參數只能有一個,且類型要和mapper映射文件中statement的parameterType的值保持一致。
4.mapper接口的返回值類型要和mapper映射文件中statement的resultType值或resultMap中的type值保持一致;
通過規范式的開發mapper接口,可以解決原始dao開發當中存在的問題:
模板代碼已經去掉;
剩下去不掉的操作數據庫的代碼,其實就是一行代碼。這行代碼中硬編碼的部分,通過第一和第二個規范就可以解決。
編寫步驟
第一步
-
重新寫個UserMapper配置文件和定義mapper映射文件UserMapper.xml(內容同Users.xml,除了namespace的值),放到新創建的目錄mapper下。
image.png 第二步:【添加映射配置文件】
<!--告訴MyBatis加載映射文件-->
<mappers>
<!--<mapper resource="com/kdj/sqlmap/User.xml"></mapper>-->
<mapper resource="com/kdj/mapper/UserMapper.xml"></mapper>
</mappers>
- 第三步:測試
package com.kdj.test;
import com.kdj.dao.UserDao;
import com.kdj.dao.UserDaoImpl;
import com.kdj.mapper.UserMapper;
import com.kdj.model.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
public class Demo04 {
SqlSession session;
@Before
public void before() throws IOException {
System.out.println("before........獲取session");
//a)讀取配置文件;
InputStream is = Resources.getResourceAsStream("SqlMapConfig.xml");
//b)通過SqlSessionFactoryBuilder創建SqlSessionFactory會話工廠。
SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(is);
session = sessionFactory.openSession();
}
@After
public void after(){
session.close();
}
@Test
public void test1() throws IOException {
UserMapper userMapper = session.getMapper(UserMapper.class);
//獲取數據
System.out.println(userMapper.findUserById(1));
//保存
User user2 = new User("xxOOxx", "x", new Date(), "xx");
int affectRows = userMapper.save(user2);
session.commit();
System.out.println("affectRows:" + affectRows);
}
}
3 全局配置文件其它配置
3.1 properties數據庫文件配置
- 在src下配置個db.properties文件
driverClass=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatisday1?useUnicode=true&characterEncoding=utf8
username=root
password=root
-
修改全局的配置文件
image.png
3.2 setting【了解】
-
具體配置詳解
image.png
image.png
3.3 typeAliases
- 別名是使用是為了在映射文件中,更方便的去指定參數和結果集的類型,不再用寫很長的一段全限定名。
- mybatis支持的別名
別名 映射的類型
_byte byte
_long long
_short short
_int int
_integer int
_double double
_float float
_boolean boolean
string String
byte Byte
long Long
short Short
int Integer
integer Integer
double Double
float Float
boolean Boolean
date Date
decimal BigDecimal
bigdecimal BigDecimal
-
自定義別名
image.png
3.4 加載映射文件的幾種方式
<mapper resource=’’/>
使用相對于類路徑的資源
如:<mapper resource="sqlmap/User.xml" />
<mapper url=’’/> 【不用】
使用完全限定路徑
如:<mapper url="file:///D:\workspace_spingmvc\mybatis_01\config\sqlmap\User.xml" />
<mapper class=’’/>
使用mapper接口的全限定名
如:<mapper class="cn.gyf.mybatis.mapper.UserMapper"/>
-
也可使用注解開發,把xml文件刪除
image.png 注意:此種方法要求mapper接口和mapper映射文件要名稱相同,且放到同一個目錄下
<package name=’’/>(推薦)
注冊指定包下的所有映射文件
如:<package name="cn.gyf.mybatis.mapper"/>
4 Mybatis的映射文件
4.1 輸入映射ParameterType
指定輸入參數的java類型,可以使用別名或者類的全限定名。它可以接收簡單類型,POJO對象、HashMap。
傳遞簡單類型
-
根據用戶ID查詢用戶信息。
image.png -
傳遞POJO對象
image.png 傳遞POJO包裝對象
開發中通過pojo傳遞查詢條件 ,查詢條件是綜合的查詢條件,不僅包括用戶查詢條件還包括其它的查詢條件(比如將用戶購買商品信息也作為查詢條件),這時可以使用包裝對象傳遞輸入參數。
需求
綜合查詢用戶信息,需要傳入查詢條件復雜,比如(用戶信息、訂單信息、商品信息)。
vo:鍵值對對象,相對于kv
po:persist object 持久化對象
pojo:簡單的java對象
entity:實體-
定義POJO包裝類
image.png -
修改UserMapper.java
image.png -
修改UsrMappler.xml
image.png -
測試
image.png 傳遞Map對象
-
修改UserMapper.java
image.png -
修改UserMapper.xml
image.png 測試
@Test
public void test2() throws IOException {
UserMapper userMapper = session.getMapper(UserMapper.class);
// 通過Map查詢
Map<String, Object> map = new HashMap<String, Object>();
map.put("name", "張");
map.put("sex", "1");
List<User> list = userMapper.findUserByMap(map);
System.out.println(list);
}
- 注意點:
${}
不要使用username,會與db.properties中的root沖突
4.2 輸出映射 resultType/resultMap
resultType
使用resultType進行結果映射時,查詢的列名和映射的pojo屬性名完全一致,該列才能映射成功。
如果查詢的列名和映射的pojo屬性名全部不一致,則不會創建pojo對象;
如果查詢的列名和映射的pojo屬性名有一個一致,就會創建pojo對象。
- 輸出簡單類型
當輸出結果只有一列時,可以使用ResultType指定簡單類型作為輸出結果類型。 案例:輸出一個count(*)
- UserMapper.java
/**
* 返回用戶的個數
* @param vo
* @return
*/
public int findUserCount(UserQueryVO vo);
- UserMapper.xml
<!--第二天內容-->
<!--1 設置返回數據為基本類型,int ,double-->
<!--查詢用戶的個數-->
<select id="findUserCount" parameterType="userQueryVO" resultType="int">
SELECT COUNT(*) FROM user WHERE sex = #{user.sex}
</select>
- 測試
@Test
public void test1() {
UserMapper userMapper = session.getMapper(UserMapper.class);
// 通過模型的包裝類來查詢用戶
UserQueryVO query = new UserQueryVO();
User user = new User();
user.setSex("2"); //男性
query.setUser(user);
int count = userMapper.findUserCount(query);
System.out.println("男性用戶的人數:" + count);
}
-
輸出POJO單個對象
image.png
-
輸出POJO列表
image.png
image.png 總結:
輸出單個pojo對象和pojo列表時,mapper映射文件中的resultType的類型是一樣的,mapper接口的方法返回值不同。
同樣的mapper映射文件,返回單個對象和對象列表時,mapper接口在生成動態代理的時候,會根據返回值的類型,決定調用selectOne方法還是selectList方法。