MyBatis是如何初始化的？_ZenDei技術網路在線

摘要：我們知道MyBatis和資料庫的交互有兩種方式有Java API和Mapper介面兩種，所以MyBatis的初始化必然也有兩種；那麼MyBatis是如何初始化的呢？本文分享自華為雲社區《MyBatis詳解 - 初始化基本過程》，作者：龍哥手記。 MyBatis初始化的方式及引入 MyBat ...

摘要：我們知道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");

點擊關註，第一時間瞭解華為雲新鮮技術~