一文搞懂Mybatis架構與作業原理-有解無憂

前言

本文將從宏觀角度分析 Mybatis 的架構與作業原理，

架構

Mybatis的功能架構分為三層：

API介面層：提供給外部使用的介面API，開發人員通過這些 API 操縱資料庫，介面層一接收到呼叫請求就會呼叫資料處理層來完成具體的資料處理
資料處理層：負責具體的SQL查找，SQL決議，SQL執行和執行結果映射處理等，主要目的是根據呼叫的請求完成一次資料庫操作
基礎支撐層：負責最基礎的功能支撐，包括連接管理，事務管理，配置加載和快取處理，這些都是共用的，將它們抽取出來作為最基礎的組件，為上層的資料處理層提供最基礎的支撐

作業原理

(1) 讀取組態檔 mybatis-config.xml

大部分情況下，我們都是在 Spring 中集成 Mybatis，如果不使用 Spring 容器的時候，引入 Mybatis 需要引入 mybatis.jar，還需要一個全域組態檔，mybatis-config.xml ，其中控制著 Mybatis 的核心行為，

我們在 mybatis.jar 的 /org/apache/ibatis/builder/xml 包中存在 mybatis-3-config.dtd 檔案和 mybatis-config.xsd 檔案，此 dtd 檔案就是用來規范 mybatis-config.xml 檔案結構的，每一個 xml 檔案都可攜帶一個有關其自身格式的描述的 dtd 檔案，通過 dtd 檔案，可驗證接收到的資料，而 xsd 也可以作為 xml 檔案的約束檔案，

在 xml 對 dtd 的參考：

<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">

在 xml 中對 xsd 的應用：

<configuration
xsi:schemaLocation="http://mybatis.org mybatis-config.xsd">

dtd 與 xsd 的區別？

dtd (document type definition) 檔案型別定義
xsd (xml schema definition) 檔案結構定義

兩個都可以定義 xml 檔案結構，但 dtd 功能較少，不可擴展，不是使用 xml 語法撰寫的，不支持命名空間，只提供非常有限的資料型別，目前，xsd 正在變為主流，

我們可以看到 mybatis-config.xsd 檔案中定義了 xml 檔案的一些約束：

<xs:element name="configuration">
  <xs:complexType>
    <xs:sequence>
      <xs:element minOccurs="0" ref="properties"/>
      <xs:element minOccurs="0" ref="settings"/>
      <xs:element minOccurs="0" ref="typeAliases"/>
      <xs:element minOccurs="0" ref="typeHandlers"/>
      <xs:element minOccurs="0" ref="objectFactory"/>
      <xs:element minOccurs="0" ref="objectWrapperFactory"/>
      <xs:element minOccurs="0" ref="reflectorFactory"/>
      <xs:element minOccurs="0" ref="plugins"/>
      <xs:element minOccurs="0" ref="environments"/>
      <xs:element minOccurs="0" ref="databaseIdProvider"/>
      <xs:element minOccurs="0" ref="mappers"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

<xs:element name="properties">
  <xs:complexType>
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" ref="property"/>
    </xs:sequence>
    <xs:attribute name="resource"/>
    <xs:attribute name="url"/>
  </xs:complexType>
</xs:element>
<xs:element name="property">
  <xs:complexType>
    <xs:attribute name="name" use="required"/>
    <xs:attribute name="value" use="required"/>
  </xs:complexType>
</xs:element>

<xs:element name="environments">
  <xs:complexType>
    <xs:sequence>
      <xs:element maxOccurs="unbounded" ref="environment"/>
    </xs:sequence>
    <xs:attribute name="default" use="required"/>
  </xs:complexType>
</xs:element>

上述只是列舉 mybatis-config.xsd 中的一部分約束，可以看到其中定義的 configuration標簽是xml檔案中的頂級元素，其中此元素下的子元素又有：properties，settings ......

其中的properties標簽中又可以定義屬性 resource 和 url，而且約束 properties元素個數最小是0，最大沒有上限，參考了 property 標簽

其中的environments標簽中可以定義 environment 子標簽，而environment 子標簽中可以定義屬性 id，還可以定義子標簽 transactionManager 和 dataSource

官網給出了 mybatis-config.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>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>

(2) 加載映射檔案

我們可以看到在 mybatis-config.xml 中定義了映射檔案，這些映射的xml檔案中包含了 SQL 和映射定義資訊，mybatis-config.xml 檔案可以加載多個映射檔案，每個檔案對應資料庫中的一個表，

(3) 構造會話工廠 SqlSessionFactory

每個基于 MyBatis 的應用都是以一個 SqlSessionFactory 的實體為核心的，SqlSessionFactory 的實體可以通過 SqlSessionFactoryBuilder 獲得，而 SqlSessionFactoryBuilder 則可以從 XML 組態檔或一個預先配置的 Configuration 實體來構建出 SqlSessionFactory 實體，

從 mybatis-config.xml 檔案構建 SqlSessionFactory示例

String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

配置類構建 SqlSessionFactory示例

DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();
TransactionFactory transactionFactory = new JdbcTransactionFactory();
Environment environment = new Environment("development", transactionFactory, dataSource);
Configuration configuration = new Configuration(environment);
configuration.addMapper(BlogMapper.class);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

(4) 創建會話物件 SqlSession

創建了 SqlSessionFactory示例，就可以獲得 SqlSession示例，SqlSession提供了在資料庫執行 SQL 所需的所有方法，還可以通過 SqlSession實體直接執行已映射的SQL陳述句，

try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  Blog blog = mapper.selectBlog(101);
}

我們看看這段代碼做了什么？

來看一個官網給出的 xml 映射陳述句的實體，它可以滿足上述中 SqlSession 的呼叫，

<?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="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

在命名空間 “org.mybatis.example.BlogMapper” 中定義了一個名為 “selectBlog” 的映射陳述句，這樣你就可以用全限定名 “org.mybatis.example.BlogMapper.selectBlog” 來呼叫映射陳述句了，

其中，命名空間必須指定，作用有兩個：

利用全限定類名將不同的陳述句隔離開
實作了介面系結

(5) Executor 執行器

創建了 SqlSession 物件，就可以執行已映射的 SQL 陳述句了，而真正執行SQL的其實是 Executor 執行器，Mybatis 是一個持久層框架，用來操作資料庫的，那么使用框架前我們用的是 jdbc 操作資料庫，jdbc 執行 SQL 陳述句的是 Statement 類，mybatis 要想執行 SQL 也要依賴這個類，所以它對 JDBC 進行了封裝，而封裝起來的類就是 Executor，它將根據 SqlSession 傳遞的引數動態的生成需要執行的 SQL 陳述句，同時負責查詢快取的維護，

(6) MappedStatement 物件

在 Executor 介面的執行方法中有一個 MappedStatement 型別的引數，該引數是對映射資訊的封裝，用于存盤要映射的SQL陳述句的 id,引數等資訊，

MappedStatement 類位于 mybatis包的org.apache.ibatis.mapping目錄下，是一個 final類，每一個 MappedStatement實體對應 mapper.xml 中配置的一個 SQL 陳述句，

(7) 輸入引數映射

輸入引數型別可以是 Map，List 等集合型別，也可以是基本資料型別和 POJO 型別，輸入引數映射程序類似于 JDBC 對 perparedStatement 物件設定引數的程序，

(8) 輸出結果映射

輸出結果型別可以是 Map，List 等集合型別，也可以是基本資料型別和 POJO 型別，輸出結果映射程序類似于 JDBC 對結果集的決議程序，

作用域和生命周期

SqlSessionFactoryBuilder

這個類可以被實體化、使用和丟棄，一旦創建了 SqlSessionFactory，就不再需要它了，因此 SqlSessionFactoryBuilder 實體的最佳作用域是方法作用域（也就是區域方法變數），你可以重用 SqlSessionFactoryBuilder 來創建多個 SqlSessionFactory 實體，但最好還是不要一直保留著它，以保證所有的 XML 決議資源可以被釋放給更重要的事情，

SqlSessionFactory

SqlSessionFactory 一旦被創建就應該在應用的運行期間一直存在，沒有任何理由丟棄它或重新創建另一個實體，使用 SqlSessionFactory 的最佳實踐是在應用運行期間不要重復創建多次，多次重建 SqlSessionFactory 被視為一種代碼“壞習慣”，因此 SqlSessionFactory 的最佳作用域是應用作用域，有很多方法可以做到，最簡單的就是使用單例模式或者靜態單例模式，

SqlSession

每個執行緒都應該有它自己的 SqlSession 實體，SqlSession 的實體不是執行緒安全的，因此是不能被共享的，所以它的最佳的作用域是請求或方法作用域，絕對不能將 SqlSession 實體的參考放在一個類的靜態域，甚至一個類的實體變數也不行，也絕不能將 SqlSession 實體的參考放在任何型別的托管作用域中，比如 Servlet 框架中的 HttpSession，如果你現在正在使用一種 Web 框架，考慮將 SqlSession 放在一個和 HTTP 請求相似的作用域中，換句話說，每次收到 HTTP 請求，就可以打開一個 SqlSession，回傳一個回應后，就關閉它，這個關閉操作很重要，為了確保每次都能執行關閉操作，你應該把這個關閉操作放到 finally 塊中，

小結

本文主要從宏觀角度講解 Mybatis 的架構模式與作業原理，關于更細節的實作原理會在后續文章中繼續更新，如果感興趣可收藏此專欄，

轉載請註明出處，本文鏈接：https://www.uj5u.com/shujuku/292419.html

標籤：其他

上一篇：關于MySQL8的WITH查詢學習

下一篇：17-Redis常用資料型別