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