《深入理解mybatis原理2》 Mybatis初始化機制詳解

阿新 • • 發佈：2019-02-09

and 文件創建 builder模式處理器 XML iou info pro 兩種

《深入理解mybatis原理》 Mybatis初始化機制詳解

對於任何框架而言，在使用前都要進行一系列的初始化，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 數據源
    ×mapper映射器

MyBatis的上述配置信息會配置在XML配置文件中，那麽，這些信息被加載進入MyBatis內部，MyBatis是怎樣維護的呢？

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

技術分享圖片

MyBatis根據初始化好Configuration信息，這時候用戶就可以使用MyBatis進行數據庫操作了。

可以這麽說，MyBatis初始化的過程，就是創建 Configuration對象的過程。

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

(1 基於XML配置文件：基於XML配置文件的方式是將MyBatis的所有配置信息放在XML文件中，MyBatis通過加載XML配置文件，將配置文信息組裝成內部的Configuration對象
?
(2基於Java API：這種方式不使用XML配置文件，需要MyBatis使用者在Java代碼中，手動創建Configuration對象，然後將配置參數set 進入Configuration對象中
?

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

二、MyBatis基於XML配置文件創建Configuration對象的過程

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

String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession sqlSession = sqlSessionFactory.openSession();
List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");
?

有過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相關的代碼如下所示：

public SqlSessionFactory build(InputStream inputStream)
{
    return build(inputStream, null, null);
}
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties)
{
    try
    {
        //2. 創建XMLConfigBuilder對象用來解析XML配置文件，生成Configuration對象
        XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
        //3. 將XML配置文件內的信息解析成Java對象Configuration對象
        Configuration config = parser.parse();
        //4. 根據Configuration對象創建出SqlSessionFactory對象
        return build(config);
    }
    catch (Exception e)
    {
        throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    }
    finally
    {
        ErrorContext.instance().reset();
        try
        {
            inputStream.close();
        }
        catch (IOException e)
        {
            // Intentionally ignore. Prefer previous error.
        }
    }
}
//從此處可以看出，MyBatis內部通過Configuration對象來創建SqlSessionFactory,用戶也可以自己通過API構造好Configuration對象，調用此方法創建SqlSessionFactory
public SqlSessionFactory build(Configuration config)
{
    return new DefaultSqlSessionFactory(config);
}
?

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

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對象的呢？

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

技術分享圖片

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

    public Configuration parse()
    {
        if (parsed)
        {
            throw new BuilderException("Each XMLConfigBuilder can only be used once.");
        }
        parsed = true;
        //源碼中沒有這一句，只有 parseConfiguration(parser.evalNode("/configuration"));
        //為了讓讀者看得更明晰，源碼拆分為以下兩句
        XNode configurationNode = parser.evalNode("/configuration");
        parseConfiguration(configurationNode);
        return configuration;
    }
    /*
    解析 "/configuration"節點下的子節點信息，然後將解析的結果設置到Configuration對象中
    */
  private void parseConfiguration(XNode root) {
    try {
      //1.首先處理properties 節點	
      propertiesElement(root.evalNode("properties")); //issue #117 read properties first
      //2.處理typeAliases
      typeAliasesElement(root.evalNode("typeAliases"));
      //3.處理插件
      pluginElement(root.evalNode("plugins"));
      //4.處理objectFactory
      objectFactoryElement(root.evalNode("objectFactory"));
      //5.objectWrapperFactory
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      //6.settings
      settingsElement(root.evalNode("settings"));
      //7.處理environments
      environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #631
      //8.database
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      //9. typeHandlers
      typeHandlerElement(root.evalNode("typeHandlers"));
      //10 mappers
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

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

然後將這些值解析出來設置到Configuration對象中。

解析子節點的過程這裏就不一一介紹了，用戶可以參照MyBatis源碼仔細揣摩，我們就看上述的environmentsElement(root.evalNode("environments")); 方法是如何將environments的信息解析出來，設置到Configuration對象中的：

/*
   解析environments節點，並將結果設置到Configuration對象中
   註意：創建environment時，如果SqlSessionFactoryBuilder指定了特定的環境（即數據源）；
         則返回指定環境（數據源）的Environment對象，否則返回默認的Environment對象；
         這種方式實現了MyBatis可以連接多數據源
*/
private void environmentsElement(XNode context) throws Exception
{
    if (context != null)
    {
        if (environment == null)
        {
            environment = context.getStringAttribute("default");
        }
        for (XNode child : context.getChildren())
        {
            String id = child.getStringAttribute("id");
            if (isSpecifiedEnvironment(id))
            {
                //1.創建事務工廠 TransactionFactory
                TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
                DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
                //2.創建數據源DataSource
                DataSource dataSource = dsFactory.getDataSource();
                //3. 構造Environment對象
                Environment.Builder environmentBuilder = new Environment.Builder(id)
                .transactionFactory(txFactory)
                .dataSource(dataSource);
                //4. 將創建的Envronment對象設置到configuration 對象中
                configuration.setEnvironment(environmentBuilder.build());
            }
        }
    }
}
private boolean isSpecifiedEnvironment(String id)
{
    if (environment == null)
    {
        throw new BuilderException("No environment specified.");
    }
    else if (id == null)
    {
        throw new BuilderException("Environment requires an id attribute.");
    }
    else if (environment.equals(id))
    {
        return true;
    }
    return false;
}

返回Configuration對象我們將上述的MyBatis初始化基本過程的序列圖細化，

技術分享圖片

三、手動加載XML配置文件創建Configuration對象完成初始化，創建並使用SqlSessionFactory對象

        我們可以使用XMLConfigBuilder手動解析XML配置文件來創建Configuration對象，代碼如下：

String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
//手動創建XMLConfigBuilder，並解析創建Configuration對象
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, null,null);
Configuration configuration=parse();
//使用Configuration對象創建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
//使用MyBatis
SqlSession sqlSession = sqlSessionFactory.openSession();
List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");

四、涉及到的設計模式

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

Builder模式應用1： SqlSessionFactory的創建 對於創建SqlSessionFactory時，會根據情況提供不同的參數，其參數組合可以有以下幾種：

技術分享圖片

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

技術分享圖片

MyBatis將SqlSessionFactoryBuilder和SqlSessionFactory相互獨立。

Builder模式應用2：數據庫連接環境Environment對象的創建 在構建Configuration對象的過程中，XMLConfigParser解析 mybatis XML配置文件節點<environment>節點時，會有以下相應的代碼：

  private void environmentsElement(XNode context) throws Exception {
    if (context != null) {
      if (environment == null) {
        environment = context.getStringAttribute("default");
      }
      for (XNode child : context.getChildren()) {
        String id = child.getStringAttribute("id");
        //和默認的環境相同時，解析它
        if (isSpecifiedEnvironment(id)) {
          TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
          DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
          DataSource dataSource = dsFactory.getDataSource();
 
          //使用了Environment內置的構造器Builder，傳遞id 事務工廠和數據源
          Environment.Builder environmentBuilder = new Environment.Builder(id)
              .transactionFactory(txFactory)
              .dataSource(dataSource);
          configuration.setEnvironment(environmentBuilder.build());
        }
      }
    }
  }

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

public final class Environment {
  private final String id;
  private final TransactionFactory transactionFactory;
  private final DataSource dataSource;
 
  public Environment(String id, TransactionFactory transactionFactory, DataSource dataSource) {
    if (id == null) {
      throw new IllegalArgumentException("Parameter ‘id‘ must not be null");
    }
    if (transactionFactory == null) {
        throw new IllegalArgumentException("Parameter ‘transactionFactory‘ must not be null");
    }
    this.id = id;
    if (dataSource == null) {
      throw new IllegalArgumentException("Parameter ‘dataSource‘ must not be null");
    }
    this.transactionFactory = transactionFactory;
    this.dataSource = dataSource;
  }
 
  public static class Builder {
      private String id;
      private TransactionFactory transactionFactory;
      private DataSource dataSource;
 
    public Builder(String id) {
      this.id = id;
    }
 
    public Builder transactionFactory(TransactionFactory transactionFactory) {
      this.transactionFactory = transactionFactory;
      return this;
    }
 
    public Builder dataSource(DataSource dataSource) {
      this.dataSource = dataSource;
      return this;
    }
 
    public String id() {
      return this.id;
    }
 
    public Environment build() {
      return new Environment(this.id, this.transactionFactory, this.dataSource);
    }
 
  }
 
  public String getId() {
    return this.id;
  }
 
  public TransactionFactory getTransactionFactory() {
    return this.transactionFactory;
  }
 
  public DataSource getDataSource() {
    return this.dataSource;
  }
 
}

《深入理解mybatis原理2》 Mybatis初始化機制詳解

and 文件創建 builder模式處理器 XML iou info pro 兩種《深入理解mybatis原理》 Mybatis初始化機制詳解對於任何框架而言，在使用前都要進行一系列的初始化，MyBatis也不例外。本章將通過以下幾點詳細介紹MyBatis的初始化過

《深入理解mybatis原理2》 Mybatis初始化機制詳解

《深入理解mybatis原理》 Mybatis初始化機制詳解

一、 MyBatis的初始化做了什麽

二、MyBatis基於XML配置文件創建Configuration對象的過程

三、手動加載XML配置文件創建Configuration對象完成初始化，創建並使用SqlSessionFactory對象

四、涉及到的設計模式

《深入理解mybatis原理2》 Mybatis初始化機制詳解

《深入理解mybatis原理》 Mybatis初始化機制詳解侵立刪

Java中物件的初始化過程詳解

順序表的建立和初始化過程詳解（C語言實現）

C++11中類資料成員初始化方法詳解

SpringIOC初始化過程--詳解

PyTorch常用引數初始化方法詳解

0.2.Java垃圾回收機制詳解

Java 物件序列化機制詳解

《深入理解mybatis原理》 MyBatis快取機制的設計與實現

《深入理解mybatis原理》 MyBatis的二級快取的設計原理

《深入理解mybatis原理》 Mybatis資料來源與連線池

《深入理解mybatis原理》 MyBatis的架構設計以及例項分析

《深入理解mybatis原理》 MyBatis的架構設計以及例項分析

深入理解L1、L2正則化原理與作用

ASP.NET Core 運行原理剖析1:初始化WebApp模版並運行

深入理解Plasma（2）：Plasma 細節剖析

深入理解計算機系統 2.4.2 IEEE浮點表示詳細講解

深入理解mysqldump原理 --single-transaction --lock-all-tables --master-data

security cookie 機制（2）--- 初始化___security_cookie

《深入理解mybatis原理2》 Mybatis初始化機制詳解

《深入理解mybatis原理》 Mybatis初始化機制詳解

一、 MyBatis的初始化做了什麽

二、MyBatis基於XML配置文件創建Configuration對象的過程

三、手動加載XML配置文件創建Configuration對象完成初始化，創建並使用SqlSessionFactory對象

四、涉及到的設計模式

相關推薦