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

時間  2019-11-08
標籤 深刻理解mybatis原理 mybatis 初始化 機制 詳解 欄目 MyBatis 简体版
原文   原文鏈接

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

    1.MyBatis的初始化作了什麼mysql

    2. MyBatis基於XML配置文件建立Configuration對象的過程sql

    3. 手動加載XML配置文件建立Configuration對象完成初始化，建立並使用SqlSessionFactory對象數據庫

    4. 涉及到的設計模式apache

1、 MyBatis的初始化作了什麼

    任何框架的初始化，無非是加載本身運行時所須要的配置信息。MyBatis的配置信息，大概包含如下信息，其高層級結構以下：設計模式

    × configuration 配置數組

        × properties 屬性
        × settings 設置
        × typeAliases 類型命名
        × typeHandlers 類型處理器
        × objectFactory 對象工廠
        × plugins 插件
        × environments 環境
        ×environment 環境變量
        × transactionManager 事務管理器
        ×dataSource 數據源
    ×映射器session

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

    MyBatis採用了一個很是直白和簡單的方式---使用 org.apache.ibatis.session.Configuration 對象做爲一個全部配置信息的容器，Configuration對象的組織結構和XML配置文件的組織結構幾乎徹底同樣（固然，Configuration對象的功能並不限於此，它還負責建立一些MyBatis內部使用的對象，如Executor等，這將在後續的文章中討論）。以下圖所示：app

    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對象，並使用它的。

    

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

    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

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初始化基本過程的序列圖細化，

 

3、手動加載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);  

 

4、涉及到的設計模式

    初始化的過程涉及到建立各類對象，因此會使用一些建立型的設計模式。在初始化的過程當中，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原理》 Mybatis初始化機制詳解 的所有內容，但願對你們有所幫助！上述內容若有不妥之處，還請讀者指出，共同探討，共同進步！

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程