MyBatis是如何初始化的？-有解無憂

摘要：我們知道MyBatis和資料庫的互動有兩種方式有Java API和Mapper介面兩種，所以MyBatis的初始化必然也有兩種；那么MyBatis是如何初始化的呢？

本文分享自華為云社區《MyBatis詳解 - 初始化基本程序》，作者：龍哥手記，

MyBatis初始化的方式及引入

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

基于XML組態檔：基于XML組態檔的方式是將MyBatis的所有配置資訊放在XML檔案中，MyBatis通過加載并XML組態檔，將配置文資訊組裝成內部的Configuration物件，
基于Java API：這種方式不使用XML組態檔，需要MyBatis使用者在Java代碼中，手動創建Configuration物件，然后將配置引數set 進入Configuration物件中，

初始化方式 - XML配置

接下來我們將通過基于XML組態檔方式的MyBatis初始化，深入探討MyBatis是如何通過組態檔構建Configuration物件，并使用它，

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

// mybatis初始化
String resource = "mybatis-config.xml"; 
InputStream inputStream = Resources.getResourceAsStream(resource); 
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 創建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession(); 
// 執行SQL陳述句
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初始化要經過簡單的以下幾步：

呼叫SqlSessionFactoryBuilder物件的build(inputStream)方法；
SqlSessionFactoryBuilder會根據輸入流inputStream等資訊創建XMLConfigBuilder物件;
SqlSessionFactoryBuilder呼叫XMLConfigBuilder物件的parse()方法；
XMLConfigBuilder物件回傳Configuration物件；
SqlSessionFactoryBuilder根據Configuration物件創建一個DefaultSessionFactory物件；
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物件中 
 * 注意：創建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; 
}

回傳Configuration物件

將上述的MyBatis初始化基本程序的序列圖細化：

初始化方式 - 基于Java API

當然我們可以使用XMLConfigBuilder手動決議XML組態檔來創建Configuration物件，代碼如下：

String resource = "mybatis-config.xml"; 
InputStream inputStream = Resources.getResourceAsStream(resource); 
// 手動創建XMLConfigBuilder，并決議創建Configuration物件 
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, null,null); // 看這里 
Configuration configuration = parser.parse(); 
// 使用Configuration物件創建SqlSessionFactory 
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration); 
// 使用MyBatis 
SqlSession sqlSession = sqlSessionFactory.openSession(); 
List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");

點擊關注，第一時間了解華為云新鮮技術~

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

標籤：MySQL

上一篇：華為云解鎖云原生資料庫發展新動能

下一篇：MySQL-帶你上官網看索引