MyBatis 是什么?
MyBatis是第一個支持自定義SQL、存儲過程和高級映射的類持久框架。MyBatis消除了大部分JDBC的樣板代碼、手動設置參數以及檢索結果。MyBatis能夠支持簡單的XML和注解配置規則。使Map接口和POJO類映射到數據庫字段和記錄。
下面我們通過一個簡單的項目搭建來帶你認識一下MyBatis的使用和一些核心組件的講解。
MyBatis 項目構建
為了快速構建一個MyBatis項目,我們采用SpringBoot快速搭建的方式。搭建好后在對應的pom.xml下添加如下的maven依賴,主要作用在於引入mybatis一些jar包和類庫
主要分為四個步驟:
- 快速構建項目,引入核心maven dependency依賴
- 構建POJO類和接口式編程的 Mapper類,編寫SQL語句
- 編寫
config.properties
數據庫驅動等配置 - 構建Mybatis核心配置文件即
mybatis-config.xml
,引入數據庫驅動,映射Mapper類 - 編寫Junit單元測試類
<!-- mybatis 核心依賴-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
<!-- 數據庫驅動包 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.25</version>
</dependency>
<!-- 單元測試包-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
為了便於更好的說明文章的主旨,這里就不貼出全部代碼了,會貼出核心代碼部分
編寫對應的POJO類和接口式編程Mapper類,這里我們以部門業務邏輯為例,構建一個部門類,有三個屬性即部門編號、部門名稱、位置,下面是部分代碼:
Dept.java
package com.mybatis.beans;
public class Dept {
private Integer deptNo;
private String dname;
private String loc;
public Dept() {}
public Dept(Integer deptNo, String dname, String loc) {
this.deptNo = deptNo;
this.dname = dname;
this.loc = loc;
}
get and set...
}
MyBatis最核心的功能之一就是接口式編程,它可以讓我們編寫Mapper接口和XML文件,從而把參數和返回結果映射到對應的字段中。
DeptDao.java
package com.mybatis.dao;
public interface DeptDao {
// 通過部門名稱查詢
public Dept findByDname(String Dname);
// 通過部門編號查詢
public Dept findByDeptNo(Integer deptno);
}
在/resources 下新建com.mybatis.dao 包,在其內編寫對應的XML配置文件,此XML配置文件和Mapper互為映射關系。
<mapper namespace="com.mybatis.dao.DeptDao" >
<sql id="DeptFindSql">
select * from dept
</sql>
<select id="findByDeptNo" resultType="com.mybatis.beans.Dept">
<include refid="DeptFindSql"></include>
where deptno = #{deptNo}
</select>
<select id="findByDname" resultType="com.mybatis.beans.Dept">
<include refid="DeptFindSql"></include>
where dname = #{dname}
</select>
</mapper>
上述的
就是映射到Mapper接口類的命名空間
<select>
標簽用於編寫查詢語句,查詢完成之后需要把結果映射到對象或者map集合等,需要用到resultType
屬性指定對應的結果集。上述采用了
和 的標簽寫法,為了方便的映射到實體類,需要修改的話統一修改即可,降低耦合性。
構建完成基礎的SQL語句和映射之后,下面來構建MySQL數據庫驅動,在/resources 下創建config.properties
類
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.username=root
jdbc.password=123456
在/resources 下編寫MyBatis核心配置文件myBatis-config.xml
,引入數據庫驅動,映射Mapper類
<configuration>
<!-- 設置導入外部properties文件位置 -->
<properties resource="config.properties"></properties>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<mappers>
<package name="com.mybatis.dao"/>
</mappers>
</configuration>
configuration 標簽很像是Spring 中的 beans 標簽或者是基於注解的配置@Configuration,也就是MyBatis的核心配置環境,使用 properties 標簽引入外部屬性環境,也就是數據庫驅動配置,使用 mappers 映射到Mapper所在的包,這里指的就是DeptDao.java所在的包。
在test包下面新建一個Junit單元測試類,主要流程如下:
MyBatisTest.java 代碼如下:
public class MyBatisTest {
private SqlSession sqlSession;
/**
* 讀取配置文件,創建SQL工廠,打開會話
* @throws Exception
*/
@Before
public void start() throws Exception{
InputStream is = Resources.getResourceAsStream("myBatis-config.xml");
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(is);
sqlSession = factory.openSession();
}
/**
* 銷毀會話
*/
@After
public void destroy() {
if(sqlSession != null){
sqlSession.close();
}
}
@Test
public void test(){
DeptDao deptDao = sqlSession.getMapper(DeptDao.class);
Dept dept = deptDao.findByDeptNo(1);
System.out.println(dept.getDname());
}
}
@Before 和 @After 是junit工具包中的類,@Before在執行@Test 測試其主要業務之前加載,@After 在執行@Test 測試完成之后加載。
整體結構如下:
MyBatis 整體架構
MyBatis的架構大概是這樣的,最上面是接口層,接口層就是開發人員在Mapper或者是Dao接口中的接口定義,是查詢、新增、更新還是刪除操作;中間層是數據處理層,主要是配置Mapper -> xml層級之間的參數映射,SQL解析,SQL執行,結果映射的過程。上述兩種流程都由基礎支持層來提供功能支撐,基礎支持層包括連接管理,事務管理,配置加載,緩存處理。
接口層
在不與Spring 集成的情況下,使用MyBatis執行數據庫的操作主要如下:
InputStream is = Resources.getResourceAsStream("myBatis-config.xml");
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(is);
sqlSession = factory.openSession();
其中的SqlSessionFactory
,SqlSession
是MyBatis接口的核心類,尤其是SqlSession,這個接口是MyBatis中最重要的接口,這個接口能夠讓你執行命令,獲取映射,管理事務。
數據處理層
- 配置解析
在Mybatis初始化過程中,會加載mybatis-config.xml配置文件、映射配置文件以及Mapper接口中的注解信息,解析后的配置信息會形成相應的對象並保存到Configration對象中。之后,根據該對象創建SqlSessionFactory對象。待Mybatis初始化完成后,可以通過SqlSessionFactory創建SqlSession對象並開始數據庫操作。
- SQL解析與scripting模塊
Mybatis實現的動態SQL語句,幾乎可以編寫出所有滿足需要的SQL。
Mybatis中scripting模塊會根據用戶傳入的參數,解析映射文件中定義的動態SQL節點,形成數據庫能執行的sql語句。
- SQL執行
SQL語句的執行涉及多個組件,包括MyBatis的四大神器,它們是: Executor
、StatementHandler
、ParameterHandler
、ResultSetHandler
。SQL的執行過程可以
用下面這幅圖來表示
MyBatis層級結構各個組件的介紹(這里只是簡單介紹,具體介紹在后面):
- SqlSession: MyBatis核心API,主要用來執行命令,獲取映射,管理事務。接收開發人員提供Statement Id 和參數.並返回操作結果
- Executor: 執行器,是MyBatis調度的核心,負責SQL語句的生成以及查詢緩存的維護
- StatementHandler: 封裝了JDBC Statement操作,負責對JDBC statement 的操作,如設置參數、將Statement結果集轉換成List集合。
- ParameterHandler: 負責對用戶傳遞的參數轉換成JDBC Statement 所需要的參數
- ResultSetHandler: 負責將JDBC返回的ResultSet結果集對象轉換成List類型的集合
- TypeHandler: 用於Java類型和jdbc類型之間的轉換
- MappedStatement: 動態SQL的封裝
- SqlSource: 表示從XML文件或注釋讀取的映射語句的內容,它創建將從用戶接收的輸入參數傳遞給數據庫的SQL。
- Configuration: MyBatis所有的配置信息都維持在Configuration對象之中
基礎支持層
該層保護mybatis的基礎模塊,它們為核心處理層提供了良好的支撐。
(1)反射模塊
Mybatis中的反射模塊,對Java原生的反射進行了很好的封裝,提供了簡易的API,方便上層調用,並且對反射操作進行了一系列的優化,比如,緩存了類的元數據(MetaClass)和對象的元數據(MetaObject),提高了反射操作的性能。
(2)類型轉換模塊
Mybatis的別名機制,是為了簡化配置文件的,該機制是類型轉換模塊的主要功能之一。類型轉換模塊的另一個功能是實現JDBC類型與Java類型間的轉換。該功能在SQL語句綁定實參和映射查詢結果集時都會涉及。在SQL語句綁定實參時,會將數據有Java類型轉換成JDBC類型;在映射結果集時,會將數據有JDBC類型轉換成Java類型。
(3)日志模塊
Java世界里,有很多優秀的日志框架,如Log4j、Log4j2、slf4j等。Mybatis除了提供了詳細的日志輸出信息,還能夠集成多種日志框架,其日志模塊的主要功能就是集成第三方日志框架。
(4)資源加載模塊
該模塊主要封裝了類加載器,確定了類加載器的使用順序,並提供了加載類文件和其它資源文件的功能。
(5) 解析器模塊
該模塊有兩個主要功能:一個是封裝了XPath,為Mybatis初始化時解析mybatis-config.xml配置文件以及映射配置文件提供支持;另一個為處理動態SQL語句中的占位符提供支持。
(6)數據源模塊
在數據源模塊中,Mybatis自身提供了相應的數據源實現,也提供了與第三方數據源集成的接口。數據源是開發中的常用組件之一,很多開源的數據源都提供了豐富的功能,如,連接池、檢測連接狀態等,選擇性能優秀的數據源組件,對於提供ORM框架以及整個應用的性能都是非常重要的。
(7)事務管理模塊
一般地,Mybatis與Spring框架集成,由Spring框架管理事務。但Mybatis自身對數據庫事務進行了抽象,提供了相應的事務接口和簡單實現。
(8)緩存模塊
Mybatis中有一級緩存和二級緩存,這兩級緩存都依賴於緩存模塊中的實現。但是,需要注意,這兩級緩存與Mybatis以及整個應用是運行在同一個JVM中的,共享同一塊內存,如果這兩級緩存中的數據量較大,則可能影響系統中其它功能,所以需要緩存大量數據時,優先考慮使用Redis、Memcache等緩存產品。
(9)Binding模塊
在調用SqlSession相應方法執行數據庫操作時,需要制定映射文件中定義的SQL節點,如果sql中出現了拼寫錯誤,那就只能在運行時才能發現。為了能盡早發現這種錯誤,Mybatis通過Binding模塊將用戶自定義的Mapper接口與映射文件關聯起來,系統可以通過調用自定義Mapper接口中的方法執行相應的SQL語句完成數據庫操作,從而避免上述問題。注意,在開發中,我們只是創建了Mapper接口,而並沒有編寫實現類,這是因為Mybatis自動為Mapper接口創建了動態代理對象。有時,自定義的Mapper接口可以完全代替映射配置文件,但比如動態SQL語句啊等,還是寫在映射配置文件中更好。
相關參考:
mybatis的整體架構 https://my.oschina.net/liuyuantao/blog/1860807
MyBatis框架的使用及源碼分析(十) CacheExecutor,SimpleExecutor,BatchExecutor ,ReuseExecutor
《深入理解mybatis原理》 MyBatis的架構設計以及實例分析 https://blog.csdn.net/luanlouis/article/details/40422941