對於任何框架而言，在使用前都要進行一系列的初始化，MyBatis也不例外。本章將通過以下幾點詳細介紹MyBatis的初始化過程。

 

1.MyBatis的初始化做了什麼

 

2. MyBatis基於XML配置檔案建立Configuration物件的過程

 

3. 手動載入XML配置檔案建立Configuration物件完成初始化，建立並使用SqlSessionFactory物件

 

4. 涉及到的設計模式

 

一、 MyBatis的初始化做了什麼

 

    任何框架的初始化，無非是載入自己執行時所需要的配置資訊。MyBatis的配置資訊，大概包含以下資訊，其高層級結構如下：

 

    × configuration 配置

 

        × properties 屬性
        × settings 設定
        × typeAliases 型別命名
        × typeHandlers 型別處理器
        × objectFactory 物件工廠
        × plugins 外掛
        × environments 環境
        ×environment 環境變數
        × transactionManager 事務管理器
        ×dataSource 資料來源
    ×對映器

 

    MyBatis的上述配置資訊會配置在XML配置檔案中，那麼，這些資訊被載入進入MyBatis內部，MyBatis是怎樣維護的呢？

 

    MyBatis採用了一個非常直白和簡單的方式---使用 org.apache.ibatis.session.Configuration 物件作為一個所有配置資訊的容器，Configuration物件的組織結構和XML配置檔案的組織結構幾乎完全一樣（當然，Configuration物件的功能並不限於此，它還負責建立一些MyBatis內部使用的物件，如Executor等，這將在後續的文章中討論）。如下圖所示：

 

  

  MyBatis根據初始化好Configuration資訊，這時候使用者就可以使用MyBatis進行資料庫操作了。

 

    可以這麼說，MyBatis初始化的過程，就是建立 Configuration物件的過程。

 

    MyBatis的初始化可以有兩種方式：

 

• 基於XML配置檔案：基於XML配置檔案的方式是將MyBatis的所有配置資訊放在XML檔案中，MyBatis通過載入並XML配置檔案，將配置文資訊組裝成內部的Configuration物件

• 基於Java API：這種方式不使用XML配置檔案，需要MyBatis使用者在Java程式碼中，手動建立Configuration物件，然後將配置引數set 進入Configuration物件中

    

  （PS:  MyBatis具體配置資訊有哪些，又分別表示什麼意思，不在本文的敘述範圍，讀者可以參考我的《Java Persistence withMyBatis 3 (中文版)》 的第二章 引導MyBatis中有詳細的描述）

 

    接下來我們將通過 基於XML配置檔案方式的MyBatis初始化，深入探討MyBatis是如何通過配置檔案構建Configuration物件，並使用它的。

    

二、MyBatis基於XML配置檔案建立Configuration物件的過程

 

    現在就從使用MyBatis的簡單例子入手，深入分析一下MyBatis是怎樣完成初始化的，都初始化了什麼。看以下程式碼：   

 

 

    有過MyBatis使用經驗的讀者會知道，上述語句的作用是執行com.foo.bean.BlogMapper.queryAllBlogInfo 定義的SQL語句，返回一個List結果集。總的來說，上述程式碼經歷了mybatis初始化 -->建立SqlSession -->執行SQL語句 返回結果三個過程。

 

     上述程式碼的功能是根據配置檔案mybatis-config.xml  配置檔案，建立SqlSessionFactory物件，然後產生SqlSession，執行SQL語句。而mybatis的初始化就發生在第三句：SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);  現在就讓我們看看第三句到底發生了什麼。

 

MyBatis初始化基本過程：

 

    SqlSessionFactoryBuilder根據傳入的資料流生成Configuration物件，然後根據Configuration物件建立預設的SqlSessionFactory例項。

 

    初始化的基本過程如下序列圖所示：

 

 

由上圖所示，mybatis初始化要經過簡單的以下幾步：

 

1. 呼叫SqlSessionFactoryBuilder物件的build(inputStream)方法；

 

2. SqlSessionFactoryBuilder會根據輸入流inputStream等資訊建立XMLConfigBuilder物件;

 

3. SqlSessionFactoryBuilder呼叫XMLConfigBuilder物件的parse()方法；

 

4. XMLConfigBuilder物件返回Configuration物件；

 

5. SqlSessionFactoryBuilder根據Configuration物件建立一個DefaultSessionFactory物件；

 

6. SqlSessionFactoryBuilder返回 DefaultSessionFactory物件給Client，供Client使用。

 

SqlSessionFactoryBuilder相關的程式碼如下所示：

 

上述的初始化過程中，涉及到了以下幾個物件：

 

• SqlSessionFactoryBuilder ： SqlSessionFactory的構造器，用於建立SqlSessionFactory，採用了Builder設計模式

• Configuration ：該物件是mybatis-config.xml檔案中所有mybatis配置資訊

• SqlSessionFactory：SqlSession工廠類，以工廠形式建立SqlSession物件，採用了Factory工廠設計模式

• XmlConfigParser ：負責將mybatis-config.xml配置檔案解析成Configuration物件，共SqlSessonFactoryBuilder使用，建立SqlSessionFactory

 

 建立Configuration物件的過程

 

    接著上述的 MyBatis初始化基本過程討論，當SqlSessionFactoryBuilder執行build()方法，呼叫了XMLConfigBuilder的parse()方法，然後返回了Configuration物件。那麼parse()方法是如何處理XML檔案，生成Configuration物件的呢？

 

    1. XMLConfigBuilder會將XML配置檔案的資訊轉換為Document物件，而XML配置定義檔案DTD轉換成XMLMapperEntityResolver物件，然後將二者封裝到XpathParser物件中，XpathParser的作用是提供根據Xpath表示式獲取基本的DOM節點Node資訊的操作。如下圖所示：    

 

 

    2.  之後XMLConfigBuilder呼叫parse()方法：會從XPathParser中取出 <configuration>節點對應的Node物件，然後解析此Node節點的子Node：properties, settings, typeAliases,typeHandlers, objectFactory, objectWrapperFactory, plugins, environments,databaseIdProvider, mappers

 

 

    注意：在上述程式碼中，還有一個非常重要的地方，就是解析XML配置檔案子節點<mappers>的方法mapperElements(root.evalNode("mappers")), 它將解析我們配置的Mapper.xml配置檔案，Mapper配置檔案可以說是MyBatis的核心，MyBatis的特性和理念都體現在此Mapper的配置和設計上，我們將在後續的文章中討論它，敬請期待～ 

    3.  然後將這些值解析出來設定到Configuration物件中。

 

    解析子節點的過程這裡就不一一介紹了，使用者可以參照MyBatis原始碼仔細揣摩，我們就看上述的environmentsElement(root.evalNode("environments")); 方法是如何將environments的資訊解析出來，設定到Configuration物件中的：

 

 

  4.  返回Configuration物件 

 

    我們將上述的MyBatis初始化基本過程的序列圖細化，

 

 

 

三、手動載入XML配置檔案建立Configuration物件完成初始化，建立並使用SqlSessionFactory物件

 

            我們可以使用XMLConfigBuilder手動解析XML配置檔案來建立Configuration物件，程式碼如下：

 

 

四、涉及到的設計模式

 

    初始化的過程涉及到建立各種物件，所以會使用一些建立型的設計模式。在初始化的過程中，Builder模式運用的比較多。

 

    Builder模式應用1： SqlSessionFactory的建立

 

     對於建立SqlSessionFactory時，會根據情況提供不同的引數，其引數組合可以有以下幾種：

 

 

由於構造時引數不定，可以為其建立一個構造器Builder，將SqlSessionFactory的構建過程和表示分開：

 

 

    MyBatis將SqlSessionFactoryBuilder和SqlSessionFactory相互獨立。

 

    Builder模式應用2： 資料庫連線環境Environment物件的建立

 

    在構建Configuration物件的過程中，XMLConfigParser解析 mybatis XML配置檔案節點<environment>節點時，會有以下相應的程式碼：

 

 

     在Environment內部，定義了靜態內部Builder類：

 

 

 以上就是本文 《深入理解mybatis原理》 Mybatis初始化機制詳解 的全部內容，希望對大家有所幫助！上述內容如有不妥之處，還請讀者指出，共同探討，共同進步！

 

作者：jason_wu_2

https://my.oschina.net/u/2246951/blog/798219