一、前言
對于任何框架而言,在使用前都要進行一系列的初始化,MyBatis也不例外。
二、MyBatis的初始化做了什么
2.1 Mybatis的初始化過程就是加載自己運行時所需要的配置信息的過程
任何框架的初始化,無非是加載自己運行時所需要的配置信息,Mybatis也是如此,Mybatis的初始化過程就是加載自己運行時所需要的配置信息的過程。
Spring的初始化過程就是加載自己運行時所需要的配置信息的過程,Mybatis的初始化過程就是加載自己運行時所需要的配置信息的過程。
2.2 Mybatis的配置信息有哪些
MyBatis的配置信息,大概包含以下信息,其層級結構如下:
× configuration 配置 × properties 屬性 × settings 設置 × typeAliases 類型命名 × typeHandlers 類型處理器 × objectFactory 對象工廠 × plugins 插件 × environments 環境 × environment 環境變量 × transactionManager 事務管理器 × dataSource 數據源 × 映射器
MyBatis的上述配置信息會配置在XML配置文件中,那么,這些信息被加載進入MyBatis內部,MyBatis是怎樣維護的呢?
2.3 mybatis-config.xml與Configuration類
MyBatis采用了一個非常直白和簡單的方式:使用 org.apache.ibatis.session.Configuration 對象作為一個所有配置信息的容器,Configuration對象的組織結構和XML配置文件的組織結構幾乎完全一樣(當然,Configuration對象的功能并不限于此,它還負責創建一些MyBatis內部使用的對象,如Executor等)。如下圖所示:
MyBatis根據初始化好Configuration信息,這時候用戶就可以使用MyBatis進行數據庫操作了??梢赃@么說,MyBatis初始化的過程,就是創建 Configuration對象的過程。
2.4 MyBatis初始化的兩種方式
MyBatis的初始化可以有兩種方式(對應Mybatis引導層:基于XML配置文件+基于Java API):
(1) 基于XML配置文件:基于XML配置文件的方式是將MyBatis的所有配置信息放在XML文件中,MyBatis通過加載并XML配置文件,將配置文信息組裝成內部的Configuration對象。
(2) 基于Java API:這種方式不使用XML配置文件,需要MyBatis使用者在Java代碼中,手動創建Configuration對象,然后手動將配置參數set 進入Configuration對象中。
接下來我們將通過 基于XML配置文件方式的MyBatis初始化,深入探討MyBatis是如何通過配置文件構建Configuration對象,并使用它。
三、MyBatis基于XML配置文件創建Configuration對象的過程
3.1 定位到Mybatis初始化的關鍵一句
現在就從使用MyBatis的簡單例子入手,深入分析一下MyBatis是怎樣完成初始化的,都初始化了什么??匆韵麓a:
String resource = "mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); // 1、Mybatis初始化(根據InputStream得到SqlSessionFactory) SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); // 2、創建SqlSession SqlSession sqlSession = sqlSessionFactory.openSession(); // 3、執行SQL語句并返回結果 List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");
有過MyBatis使用經驗的讀者會知道,上述語句的作用是執行com.foo.bean.BlogMapper.queryAllBlogInfo 定義的SQL語句,返回一個List結果集??偟膩碚f,上述代碼經歷了 “mybatis初始化 -->創建SqlSession -->執行SQL語句并返回結果” 三個過程。
上述代碼的功能是根據配置文件 mybatis-config.xml 配置文件,創建SqlSessionFactory對象,然后產生SqlSession,執行SQL語句。而mybatis的初始化就發生在第三句,就是這一句:
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
現在就讓我們看看第三句到底發生了什么。
3.2 MyBatis初始化基本過程
SqlSessionFactoryBuilder根據傳入的數據流(上面的inputStream)生成Configuration對象,然后根據Configuration對象創建默認的SqlSessionFactory實例。
3.2.1 Mybatis初始化時序圖
初始化的基本過程如下序列圖所示:
該時序圖中涉及的類與接口:SqlSessionFactoryBuilder、XMLConfigBuilder、Configuration、XPathParser、XMLMapperEntityResolver
(1)SqlSessionFactoryBuilder :是一個一個非抽象類, SqlSessionFactory的構造器,用于創建SqlSessionFactory,采用了Builder設計模式;
(2)XMLConfigBuilder:使用inputStream/reader得到XMLConfigBuilder類對象,引用名為parser,用來parse()得到Configuration對象。
上面時序圖對應的解釋是:
// mybatis初始化第一步,調用build(),上圖中的1 build(inputStream) 調用 build(inputStream,null,null)
// mybatis初始化第二步,手動創建XMLConfigBuilder,上圖中的2 XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, null,null);
// mybatis初始化第三步,parse()方法構建configuration對象的過程,上圖中的 3 和 4 Configuration configuration=parser.parse();
// mybatis初始化第四步,使用Configuration對象創建SqlSessionFactory 上圖中 5 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
3.2.2 Mybatis初始化四步驟
由上圖所示,mybatis初始化要經過簡單的以下幾步:
- 最外層調用SqlSessionFactoryBuilder對象的build(inputStream)方法,此方法內部明細就是下面的2、3、4;
- new XMLConfigBuilder()底層:SqlSessionFactoryBuilder會根據輸入流inputStream等信息創建XMLConfigBuilder對象;
- parse()底層parse()得到Configuration對象:SqlSessionFactoryBuilder調用XMLConfigBuilder對象的parse()方法,XMLConfigBuilder對象的parse()方法返回Configuration對象;
- bulid()底層Configuration對象得到DefaultSessionFactory對象:SqlSessionFactoryBuilder根據Configuration對象創建一個DefaultSessionFactory對象,它是SqlSessionFactory接口的實現類,所有build()返回的返回類型為SqlSessionFactory;SqlSessionFactoryBuilder返回 DefaultSessionFactory對象給Client,供Client使用。
3.2.3 Mybatis初始化四步驟代碼解析
SqlSessionFactoryBuilder相關的代碼如下所示:
SqlSessionFactoryBuilder.java public SqlSessionFactory build(InputStream inputStream) { //1. 調用SqlSessionFactoryBuilder對象的build(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); }
3.2.4 Mybatis初始化涉及的接口與類
上述的初始化過程中,涉及到了以下幾個對象:
(1)SqlSessionFactoryBuilder :是一個一個非抽象類, SqlSessionFactory的構造器,用于創建SqlSessionFactory,采用了Builder設計模式
(2)XMLConfigBuilder:負責將mybatis-config.xml配置文件解析成Configuration對象,供SqlSessonFactoryBuilder使用,創建SqlSessionFactory
(3)Configuration :是一個非抽象類,可以實例化對象,該對象是mybatis-config.xml文件中所有mybatis配置信息
(4)SqlSessionFactory:SqlSession工廠類,是一個接口,實現類是DefaultSqlSessionFactory,以工廠形式創建SqlSession對象,采用了Factory工廠設計模式
3.3 parse()內部創建Configuration對象的過程
問題:在MyBatis初始化基本過程中,當SqlSessionFactoryBuilder執行build()方法,調用了XMLConfigBuilder的parse()方法,然后返回了Configuration對象。那么parse()方法是如何處理XML文件,生成Configuration對象的呢?
回答:四個步驟,如下:
第一步,從XMLConfigBuilder到XPathParser
第二步,解析configuration節點
第三步,解析出來的值設置到Configuration對象中
第四步,返回Configuration對象
3.3.1 從XMLConfigBuilder到XPathParser
XMLConfigBuilder類會將XML配置文件的信息轉換為Document對象,而XML配置定義文件DTD轉換成XMLMapperEntityResolver對象,然后將二者(Document對象和XMLMapperEntityResolver對象)封裝到XpathParser對象中,XpathParser的作用是提供根據Xpath表達式獲取基本的DOM節點Node信息的操作。如下圖所示:
XML配置文件(mybatis-config.xml + XxxMapper.xml)的信息轉換為Document對象,而XML配置定義文件DTD(mybatis-3-config.dtd + mybatis-3-mapper.dtd 這里的3表示mybatis的版本)轉換成XMLMapperEntityResolver對象,然后將二者封裝到XpathParser對象中。
XpathParser的作用是提供根據Xpath表達式獲取基本的DOM節點Node信息的操作,如下所示:
3.3.2 解析configuration節點
XMLConfigBuilder調用parse()方法:會從XPathParser中取出 <configuration>
節點對應的Node對象,然后解析此Node節點的子Node:properties, settings, typeAliases,typeHandlers, objectFactory, objectWrapperFactory, plugins, environments,databaseIdProvider, mappers,一個10個,代碼如下:
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.3.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; }
3.3.4 返回Configuration對象
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對象,返回給程序員 }
3.4 MyBatis初始化基本過程的序列圖細化
3.4.1 MyBatis初始化基本過程的序列圖組件
我們將上述的MyBatis初始化基本過程的序列圖細化,這里包含了parse()方法將 mybatis-config.xml 解析成 Configuration對象的過程,如下圖:
該時序圖中涉及的類與接口:SqlSessionFactoryBuilder、XMLConfigBuilder、Configuration、XPathParser、XMLMapperEntityResolver
(1) SqlSessionFactoryBuilder :是一個一個非抽象類, SqlSessionFactory的構造器,用于創建SqlSessionFactory,采用了Builder設計模式
(2) XMLConfigBuilder:使用inputStream/reader得到XMLConfigBuilder的類對象,引用名為parser,用來parse()得到Configuration對象,負責將mybatis-config.xml配置文件解析成Configuration對象,供SqlSessonFactoryBuilder使用,創建SqlSessionFactory
(3) Configuration :是一個非抽象類,可以實例化對象,該對象是mybatis-config.xml文件中所有mybatis配置信息
(4) SqlSessionFactory:SqlSession工廠類,是一個接口,實現類是DefaultSqlSessionFactory,以工廠形式創建SqlSession對象,采用了Factory工廠設計模式
(5) Document:由XML配置文件的信息轉換而來,最后被封裝到XpathParser對象中。
(6) XMLMapperEntityResolver:由XML配置定義文件DTD轉換而來,最后被封裝到XpathParser對象中。
(7) XPathParser:XMLConfigBuilder會將XML配置文件的信息轉換為Document對象,而XML配置定義文件DTD轉換成XMLMapperEntityResolver對象,然后將二者封裝到XpathParser對象。
parse()方法第一步:XMLConfigBuilder會將XML配置文件的信息轉換為Document對象,而XML配置定義文件DTD轉換成XMLMapperEntityResolver對象,然后將二者封裝到XpathParser對象中,XpathParser的作用是提供根據Xpath表達式獲取基本的DOM節點Node信息的操作
3.4.2 MyBatis初始化基本過程的序列圖流程
MyBatis初始化基本過程的序列圖對應的解釋是:
mybatis初始化第一步,調用build(),就是第二步、第三步、第四步的總稱
mybatis初始化第二步,手動創建XMLConfigBuilder
上圖中的 1 XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, null,null);
2.1 2.2 只是新建一個XMLMapperEntityResolver對象;
3.1 3.2 新建一個XPathParser對象;
4.1 4.2 新建一個Configuration對象;
mybatis初始化第三步,parse()方法構建configuration對象的過程
mybatis初始化第三步就是上圖中 5 到 11 的解釋,
5 是調用parse()方法
6.1、7.1、7.2、6.2 就是解析mybatis-config.xml中的configuration節點
然后子configuration節點中的子節點的循環,8.1 8.2 是解析子節點,9 是獲取相應的值,10是設置值到configuration對象中
11 是返回configuration對象 Configuration configuration=parse();
parse()第一步:從XMLConfigBuilder到XPathParser
parse()第二步:解析configuration節點
parse()第三步:解析出來的值設置到Configuration對象中
parse()第四步:返回configuration對象
mybatis初始化第四步,得到了Configuration對象之后,使用Configuration對象創建SqlSessionFactory,即圖中的
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
注意:上圖中,4.1和4.2只是返回一個空的configuration對象,5―11才是返回一個構造好的configuration類對象,是不一樣的。
3.5 手動加載XML配置文件創建Configuration對象完成初始化
我們可以使用XMLConfigBuilder手動解析XML配置文件來創建Configuration對象,創建并使用SqlSessionFactory對象,代碼如下:
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");
四、Mybatis初始化中涉及到的設計模式
初始化的過程涉及到創建各種對象,所以會使用一些創建型的設計模式。在初始化的過程中,Builder模式運用的比較多,至少涉及到兩個Builder模式的使用:SqlSessionFactory的創建、數據庫連接環境Environment對象的創建。
4.1 SqlSessionFactory的創建
對于創建SqlSessionFactory時,會根據情況提供不同的參數,其參數組合可以有以下幾種:
由于構造時參數不定,可以為其創建一個構造器Builder,將SqlSessionFactory的構建過程和表示分開:
MyBatis將SqlSessionFactoryBuilder和SqlSessionFactory相互獨立,先通過 builder() 方法得到一個SqlSessionFactoryBuilder 對象,然后再通過 SqlSessionFactoryBuilder 對象構建一個 SqlSessionFactory 對象,體現了構造器模式的應用。
4.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初始化知識小結的文章就介紹到這了,更多相關Mybatis初始化內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家!
原文鏈接:https://blog.csdn.net/qq_36963950/article/details/120644706