Mybatis初始化原理

對于任何框架而言略贮,在使用前都要進行一系列的初始化蕴忆,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ù)的文章中討論)次坡。如下圖所示:

image

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是怎樣完成初始化的,都初始化了什么茴肥〖岵龋看以下代碼:

image

有過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實例桐愉。

初始化的基本過程如下序列圖所示:

image

由上圖所示,mybatis初始化要經(jīng)過簡單的以下幾步:

  1. 調(diào)用SqlSessionFactoryBuilder對象的build(inputStream)方法掰派;

  2. SqlSessionFactoryBuilder會根據(jù)輸入流inputStream等信息創(chuàng)建XMLConfigBuilder對象;

  3. SqlSessionFactoryBuilder調(diào)用XMLConfigBuilder對象的parse()方法从诲;

  4. XMLConfigBuilder對象返回Configuration對象;

  5. SqlSessionFactoryBuilder根據(jù)Configuration對象創(chuàng)建一個DefaultSessionFactory對象靡羡;

  6. SqlSessionFactoryBuilder返回 DefaultSessionFactory對象給Client系洛,供Client使用。

SqlSessionFactoryBuilder相關(guān)的代碼如下所示:

image
image

上述的初始化過程中略步,涉及到了以下幾個對象:

  • 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信息的操作钦购。如下圖所示:

image
image
  1. 之后XMLConfigBuilder調(diào)用parse()方法:會從XPathParser中取出 <configuration>節(jié)點對應的Node對象,然后解析此Node節(jié)點的子Node:properties, settings, typeAliases,typeHandlers, objectFactory, objectWrapperFactory, plugins, environments,databaseIdProvider, mappers
image
image

注意:在上述代碼中褂萧,還有一個非常重要的地方,就是解析XML配置文件子節(jié)點<mappers>的方法mapperElements(root.evalNode("mappers")), 它將解析我們配置的Mapper.xml配置文件葵萎,Mapper配置文件可以說是MyBatis的核心导犹,MyBatis的特性和理念都體現(xiàn)在此Mapper的配置和設計上,我們將在后續(xù)的文章中討論它羡忘,敬請期待~

  1. 然后將這些值解析出來設置到Configuration對象中谎痢。

解析子節(jié)點的過程這里就不一一介紹了,用戶可以參照MyBatis源碼仔細揣摩卷雕,我們就看上述的environmentsElement(root.evalNode("environments")); 方法是如何將environments的信息解析出來节猿,設置到Configuration對象中的:

image
image
  1. 返回Configuration對象

我們將上述的MyBatis初始化基本過程的序列圖細化。

image

三、手動加載XML配置文件創(chuàng)建Configuration對象完成初始化滨嘱,創(chuàng)建并使用SqlSessionFactory對象

我們可以使用XMLConfigBuilder手動解析XML配置文件來創(chuàng)建Configuration對象峰鄙,代碼如下:

image

四、涉及到的設計模式

初始化的過程涉及到創(chuàng)建各種對象太雨,所以會使用一些創(chuàng)建型的設計模式吟榴。在初始化的過程中,Builder模式運用的比較多囊扳。

Builder模式應用1: SqlSessionFactory的創(chuàng)建

對于創(chuàng)建SqlSessionFactory時吩翻,會根據(jù)情況提供不同的參數(shù),其參數(shù)組合可以有以下幾種:

image

由于構(gòu)造時參數(shù)不定锥咸,可以為其創(chuàng)建一個構(gòu)造器Builder狭瞎,將SqlSessionFactory的構(gòu)建過程和表示分開:

image

MyBatis將SqlSessionFactoryBuilder和SqlSessionFactory相互獨立。

Builder模式應用2: 數(shù)據(jù)庫連接環(huán)境Environment對象的創(chuàng)建

在構(gòu)建Configuration對象的過程中搏予,XMLConfigParser解析 mybatis XML配置文件節(jié)點<environment>節(jié)點時熊锭,會有以下相應的代碼:

image

在Environment內(nèi)部,定義了靜態(tài)內(nèi)部Builder類:

image
image
image

轉(zhuǎn)自https://maimai.cn/article/detail?fid=1085165689&efid=lxWzzER_ZWKRoo4kNCTTAg

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末缔刹,一起剝皮案震驚了整個濱河市球涛,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌校镐,老刑警劉巖亿扁,帶你破解...
    沈念sama閱讀 222,000評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異鸟廓,居然都是意外死亡从祝,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,745評論 3 399
  • 文/潘曉璐 我一進店門引谜,熙熙樓的掌柜王于貴愁眉苦臉地迎上來牍陌,“玉大人,你說我怎么就攤上這事员咽《窘В” “怎么了?”我有些...
    開封第一講書人閱讀 168,561評論 0 360
  • 文/不壞的土叔 我叫張陵贝室,是天一觀的道長契讲。 經(jīng)常有香客問我,道長滑频,這世上最難降的妖魔是什么捡偏? 我笑而不...
    開封第一講書人閱讀 59,782評論 1 298
  • 正文 為了忘掉前任,我火速辦了婚禮峡迷,結(jié)果婚禮上银伟,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好彤避,可當我...
    茶點故事閱讀 68,798評論 6 397
  • 文/花漫 我一把揭開白布傅物。 她就那樣靜靜地躺著,像睡著了一般忠藤。 火紅的嫁衣襯著肌膚如雪挟伙。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,394評論 1 310
  • 那天模孩,我揣著相機與錄音尖阔,去河邊找鬼。 笑死榨咐,一個胖子當著我的面吹牛介却,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播块茁,決...
    沈念sama閱讀 40,952評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼齿坷,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了数焊?” 一聲冷哼從身側(cè)響起永淌,我...
    開封第一講書人閱讀 39,852評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎佩耳,沒想到半個月后遂蛀,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,409評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡干厚,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,483評論 3 341
  • 正文 我和宋清朗相戀三年李滴,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片蛮瞄。...
    茶點故事閱讀 40,615評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡所坯,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出挂捅,到底是詐尸還是另有隱情芹助,我是刑警寧澤,帶...
    沈念sama閱讀 36,303評論 5 350
  • 正文 年R本政府宣布闲先,位于F島的核電站周瞎,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏饵蒂。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,979評論 3 334
  • 文/蒙蒙 一酱讶、第九天 我趴在偏房一處隱蔽的房頂上張望退盯。 院中可真熱鬧,春花似錦、人聲如沸渊迁。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,470評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽琉朽。三九已至毒租,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間箱叁,已是汗流浹背墅垮。 一陣腳步聲響...
    開封第一講書人閱讀 33,571評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留耕漱,地道東北人算色。 一個月前我還...
    沈念sama閱讀 49,041評論 3 377
  • 正文 我出身青樓,卻偏偏與公主長得像螟够,于是被迫代替她去往敵國和親灾梦。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 45,630評論 2 359

推薦閱讀更多精彩內(nèi)容

  • 對于任何框架而言,在使用前都要進行一系列的初始化寞宫,MyBatis也不例外萧福。本章將通過以下幾點詳細介紹MyBatis...
    java菜閱讀 1,258評論 0 8
  • 一、 MyBatis的初始化做了什么 任何框架的初始化淆九,無非是加載自己運行時所需要的配置信息统锤。 MyBatis的配...
    消失er閱讀 1,355評論 0 3
  • 1. 簡介 1.1 什么是 MyBatis ? MyBatis 是支持定制化 SQL炭庙、存儲過程以及高級映射的優(yōu)秀的...
    笨鳥慢飛閱讀 5,527評論 0 4
  • MyBatis 理論篇 [TOC] 什么是MyBatis ?MyBatis是支持普通SQL查詢,存儲過程和高級映射...
    有_味閱讀 2,908評論 0 26
  • 我是南秋饲窿。 祖籍湖南, 卻在西北的一個小城鎮(zhèn)長大焕蹄, 于是逾雄, 我有北方人的豪爽不計較, 也有南方人的細膩腻脏。 從事過很...
    南秋涼涼閱讀 333評論 0 0