對于任何框架而言略贮,在使用前都要進行一系列的初始化蕴忆,MyBatis也不例外。本章將通過以下幾點詳細介紹MyBatis的初始化過程慰丛。
1卓囚、MyBatis的初始化做了什么
2、MyBatis基于XML配置文件創(chuàng)建Configuration對象的過程
3诅病、手動加載XML配置文件創(chuàng)建Configuration對象完成初始化哪亿,創(chuàng)建并使用SqlSessionFactory對象
4、涉及到的設計模式
一贤笆、 MyBatis的初始化做了什么
任何框架的初始化蝇棉,無非是加載自己運行時所需要的配置信息。MyBatis的配置信息芥永,大概包含以下信息篡殷,其高層級結(jié)構(gòu)如下:
× configuration 配置
× properties 屬性
× settings 設置
× typeAliases 類型命名
× typeHandlers 類型處理器
× objectFactory 對象工廠
× plugins 插件
× environments 環(huán)境
× environment 環(huán)境變量
× transactionManager 事務管理器
× dataSource 數(shù)據(jù)源
×映射器
MyBatis的上述配置信息會配置在XML配置文件中,那么埋涧,這些信息被加載進入MyBatis內(nèi)部板辽,MyBatis是怎樣維護的呢奇瘦?
MyBatis采用了一個非常直白和簡單的方式---使用 org.apache.ibatis.session.Configuration 對象作為一個所有配置信息的容器,Configuration對象的組織結(jié)構(gòu)和XML配置文件的組織結(jié)構(gòu)幾乎完全一樣(當然劲弦,Configuration對象的功能并不限于此耳标,它還負責創(chuàng)建一些MyBatis內(nèi)部使用的對象,如Executor等邑跪,這將在后續(xù)的文章中討論)次坡。如下圖所示:
MyBatis根據(jù)初始化好Configuration信息,這時候用戶就可以使用MyBatis進行數(shù)據(jù)庫操作了呀袱。
可以這么說贸毕,MyBatis初始化的過程,就是創(chuàng)建 Configuration對象的過程夜赵。
MyBatis的初始化可以有兩種方式:
- 基于XML配置文件:基于XML配置文件的方式是將MyBatis的所有配置信息放在XML文件中明棍,MyBatis通過加載并XML配置文件,將配置文信息組裝成內(nèi)部的Configuration對象
- 基于Java API:這種方式不使用XML配置文件寇僧,需要MyBatis使用者在Java代碼中摊腋,手動創(chuàng)建Configuration對象,然后將配置參數(shù)set 進入Configuration對象中
(PS: MyBatis具體配置信息有哪些嘁傀,又分別表示什么意思兴蒸,不在本文的敘述范圍,讀者可以參考我的《Java Persistence withMyBatis 3 (中文版)》 的第二章 引導MyBatis中有詳細的描述)
接下來我們將通過 基于XML配置文件方式的MyBatis初始化细办,深入探討MyBatis是如何通過配置文件構(gòu)建Configuration對象橙凳,并使用它的。
二笑撞、MyBatis基于XML配置文件創(chuàng)建Configuration對象的過程
現(xiàn)在就從使用MyBatis的簡單例子入手岛啸,深入分析一下MyBatis是怎樣完成初始化的,都初始化了什么茴肥〖岵龋看以下代碼:
有過MyBatis使用經(jīng)驗的讀者會知道,上述語句的作用是執(zhí)行com.foo.bean.BlogMapper.queryAllBlogInfo 定義的SQL語句瓤狐,返回一個List結(jié)果集瞬铸。總的來說础锐,上述代碼經(jīng)歷了mybatis初始化 -->創(chuàng)建SqlSession -->執(zhí)行SQL語句 返回結(jié)果三個過程嗓节。
上述代碼的功能是根據(jù)配置文件mybatis-config.xml 配置文件,創(chuàng)建SqlSessionFactory對象郁稍,然后產(chǎn)生SqlSession赦政,執(zhí)行SQL語句。而mybatis的初始化就發(fā)生在第三句:SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); 現(xiàn)在就讓我們看看第三句到底發(fā)生了什么。
MyBatis初始化基本過程:
SqlSessionFactoryBuilder根據(jù)傳入的數(shù)據(jù)流生成Configuration對象恢着,然后根據(jù)Configuration對象創(chuàng)建默認的SqlSessionFactory實例桐愉。
初始化的基本過程如下序列圖所示:
由上圖所示,mybatis初始化要經(jīng)過簡單的以下幾步:
調(diào)用SqlSessionFactoryBuilder對象的build(inputStream)方法掰派;
SqlSessionFactoryBuilder會根據(jù)輸入流inputStream等信息創(chuàng)建XMLConfigBuilder對象;
SqlSessionFactoryBuilder調(diào)用XMLConfigBuilder對象的parse()方法从诲;
XMLConfigBuilder對象返回Configuration對象;
SqlSessionFactoryBuilder根據(jù)Configuration對象創(chuàng)建一個DefaultSessionFactory對象靡羡;
SqlSessionFactoryBuilder返回 DefaultSessionFactory對象給Client系洛,供Client使用。
SqlSessionFactoryBuilder相關(guān)的代碼如下所示:
上述的初始化過程中略步,涉及到了以下幾個對象:
- SqlSessionFactoryBuilder : SqlSessionFactory的構(gòu)造器描扯,用于創(chuàng)建SqlSessionFactory,采用了Builder設計模式
- Configuration :該對象是mybatis-config.xml文件中所有mybatis配置信息
- SqlSessionFactory:SqlSession工廠類趟薄,以工廠形式創(chuàng)建SqlSession對象绽诚,采用了Factory工廠設計模式
- XmlConfigParser :負責將mybatis-config.xml配置文件解析成Configuration對象,共SqlSessonFactoryBuilder使用杭煎,創(chuàng)建SqlSessionFactory
創(chuàng)建Configuration對象的過程
接著上述的 MyBatis初始化基本過程討論恩够,當SqlSessionFactoryBuilder執(zhí)行build()方法,調(diào)用了XMLConfigBuilder的parse()方法羡铲,然后返回了Configuration對象蜂桶。那么parse()方法是如何處理XML文件,生成Configuration對象的呢也切?
1. XMLConfigBuilder會將XML配置文件的信息轉(zhuǎn)換為Document對象扑媚,而XML配置定義文件DTD轉(zhuǎn)換成XMLMapperEntityResolver對象,然后將二者封裝到XpathParser對象中雷恃,XpathParser的作用是提供根據(jù)Xpath表達式獲取基本的DOM節(jié)點Node信息的操作钦购。如下圖所示:
- 之后XMLConfigBuilder調(diào)用parse()方法:會從XPathParser中取出 <configuration>節(jié)點對應的Node對象,然后解析此Node節(jié)點的子Node:properties, settings, typeAliases,typeHandlers, objectFactory, objectWrapperFactory, plugins, environments,databaseIdProvider, mappers
注意:在上述代碼中褂萧,還有一個非常重要的地方,就是解析XML配置文件子節(jié)點<mappers>的方法mapperElements(root.evalNode("mappers")), 它將解析我們配置的Mapper.xml配置文件葵萎,Mapper配置文件可以說是MyBatis的核心导犹,MyBatis的特性和理念都體現(xiàn)在此Mapper的配置和設計上,我們將在后續(xù)的文章中討論它羡忘,敬請期待~
- 然后將這些值解析出來設置到Configuration對象中谎痢。
解析子節(jié)點的過程這里就不一一介紹了,用戶可以參照MyBatis源碼仔細揣摩卷雕,我們就看上述的environmentsElement(root.evalNode("environments")); 方法是如何將environments的信息解析出來节猿,設置到Configuration對象中的:
- 返回Configuration對象
我們將上述的MyBatis初始化基本過程的序列圖細化。
三、手動加載XML配置文件創(chuàng)建Configuration對象完成初始化滨嘱,創(chuàng)建并使用SqlSessionFactory對象
我們可以使用XMLConfigBuilder手動解析XML配置文件來創(chuàng)建Configuration對象峰鄙,代碼如下:
四、涉及到的設計模式
初始化的過程涉及到創(chuàng)建各種對象太雨,所以會使用一些創(chuàng)建型的設計模式吟榴。在初始化的過程中,Builder模式運用的比較多囊扳。
Builder模式應用1: SqlSessionFactory的創(chuàng)建
對于創(chuàng)建SqlSessionFactory時吩翻,會根據(jù)情況提供不同的參數(shù),其參數(shù)組合可以有以下幾種:
由于構(gòu)造時參數(shù)不定锥咸,可以為其創(chuàng)建一個構(gòu)造器Builder狭瞎,將SqlSessionFactory的構(gòu)建過程和表示分開:
MyBatis將SqlSessionFactoryBuilder和SqlSessionFactory相互獨立。
Builder模式應用2: 數(shù)據(jù)庫連接環(huán)境Environment對象的創(chuàng)建
在構(gòu)建Configuration對象的過程中搏予,XMLConfigParser解析 mybatis XML配置文件節(jié)點<environment>節(jié)點時熊锭,會有以下相應的代碼:
在Environment內(nèi)部,定義了靜態(tài)內(nèi)部Builder類:
轉(zhuǎn)自https://maimai.cn/article/detail?fid=1085165689&efid=lxWzzER_ZWKRoo4kNCTTAg