當面試官問我Mybatis初始化原理時，我笑了

Java團長_發表於2018-12-26

面試MyBatis

640?wx_fmt=jpeg

來源：blog.csdn.net/luanlouis/article/details/37744073

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

MyBatis的初始化做了什麼
MyBatis基於XML配置檔案建立Configuration物件的過程
手動載入XML配置檔案建立Configuration物件完成初始化，建立並使用SqlSessionFactory物件
涉及到的設計模式

一、 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等，這將在後續的文章中討論）。如下圖所示：

640?wx_fmt=png

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是怎樣完成初始化的，都初始化了什麼。看以下程式碼：

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例項。

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

640?wx_fmt=png

由上圖所示，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物件的呢？

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

640?wx_fmt=png

2. 之後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的配置和設計上，我們將在後續的文章中討論它，敬請期待～

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

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

/*
   解析environments節點，並將結果設定到Configuration物件中
   注意：建立envronment時，如果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;
}

4. 返回Configuration物件

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

640?wx_fmt=png

三、手動載入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時，會根據情況提供不同的引數，其引數組合可以有以下幾種：

640?wx_fmt=png

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

640?wx_fmt=png

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;
  }

}

以上就是本文的全部內容，希望對大家有所幫助！上述內容如有不妥之處，還請讀者指出，共同探討，共同進步！

（完）

640?

Java團長

專注於Java乾貨分享

掃描上方二維碼獲取更多Java乾貨

當面試官問我JDK Semaphore的原理時，我笑了
2019-03-28
面試JDK
面試官問我：建立執行緒有幾種方式？我笑了
2020-10-24
面試執行緒
面試官問，你使用過命令模式嗎？我笑了！
2021-04-26
面試模式
面試官問我，使用Dubbo有沒有遇到一些坑？我笑了。
2019-03-14
面試
面試官問我：spring、springboot、springcloud的區別，我笑了
2019-05-10
面試Spring BootGCCloud
面試官問我MySQL索引，我
2021-09-01
面試MySql索引
笑了，面試官問我知不知道非同步程式設計的Future。
2020-08-09
面試非同步程式設計
面試官問我HTTP，我真的是
2021-11-30
面試HTTP
面試官問我Redis叢集，我真的是
2021-11-19
面試Redis
面試官問我MySQL調優，我真的是
2021-10-12
面試MySql
面試官問我JVM調優，我忍不住了！
2021-11-26
面試JVM
笑死，面試官又問我SpringBoot自動配置原理
2022-12-26
面試Spring Boot
面試官問我會不會Elasticsearch，我語塞了...
2020-06-03
面試Elasticsearch
面試官問我JVM記憶體結構，我真的是
2021-11-03
面試JVM記憶體
如果我是推薦演算法面試官，我會問哪些問題？
2020-11-26
演算法面試
面試官問我：什麼是JavaScript閉包，我該如何回答
2019-02-19
面試JavaScript
面試官問我redis資料型別，我回答了8種
2020-11-11
面試Redis資料型別
面試官: 我必問的容器知識點!
2020-04-04
面試
面試官，你再問我 Bit Operation 試試？
2019-02-21
面試
拜託，面試官別問我「布隆」了
2019-03-23
面試
阿里面試官用HashMap把我問倒了
2021-05-12
阿里面試HashMap
壞了！面試官問我垃圾回收機制
2021-11-04
面試
當我問表單校驗的面試題時，我期望得到什麼樣的答案
2018-03-04
面試題
面試官讓我5分鐘內寫一個搶紅包程式，我和他說了半小時原理！
2022-06-04
面試
我是設計師面試官，你有什麼想問我的？
2016-03-23
面試
面試被問MyBatis原理？
2022-04-07
面試MyBatis
面試官問我按鈕級別許可權怎麼控制，我說v-if，面試官說再見
2023-03-13
面試
『假如我是面試官』RabbitMQ我會這樣問
2021-06-22
面試MQ
Go 面試官問我如何實現物件導向？
2021-10-08
Go面試物件
面試官：你還有什麼想問我的？
2024-03-14
面試
面試官：你分析過mybatis工作原理嗎？
2019-07-27
面試MyBatis
分散式專題｜面試官問我瞭解Mysql主從複製原理麼，我能說不會麼？
2020-11-22
分散式面試MySql
作為技術面試官，我在面試時考慮什麼？
2019-10-21
面試
「每日一題」有人上次在dy面試，面試官問我：vue資料繫結的實現原理。你說我該如何回答？
2021-01-04
每日一題面試Vue
面試官問我JVM調優，我忍不住了，哈哈哈哈
2021-12-02
面試JVM
面經手冊 · 開篇《面試官都問我啥》
2020-07-29
面試
再也不怕面試官問我JDK8 HashMap了
2019-08-08
面試JDKHashMap
美團面試官問我： ZGC 的 Z 是什麼意思
2020-11-18
面試GC

當面試官問我Mybatis初始化原理時，我笑了

一、 MyBatis的初始化做了什麼

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

MyBatis初始化基本過程：

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

四、涉及到的設計模式

Builder模式應用1： SqlSessionFactory的建立

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

相關文章

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