前言
在前文《MyBatis 原理淺析——基本原理》一文中,簡要分析了 MyBatis 的技術(shù)原理,主要是 SqlSession 和 Mapper 的相關(guān)實現(xiàn)原理。本文重點分析 MyBatis 的配置解析過程,從 XML 文件提取配置到?Configuration 類。
XML解析涉及到的類
XML 解析主要涉及以下幾個類:XMLConfigBuilder、XMLMapperBuilder、BaseBuilder、XNode、Configuration、XPathParser 和Configuration 中的配置類。各個類型的關(guān)系可以簡單用下圖描述。在?SqlSessionFactoryBuilder 類中調(diào)用方法解析 XML 時使用的是XMLConfigBuilder 類,XMLConfigBuilder 類的 parse 方法是 XML 解析的入口,解析完成后返回配置類型Configuration。BaseBuilder 類是抽象類,提供了 typeAlias、typeHandler 配置的處理方法,也是XMLConfigBuilder 類和XMLMapperBuilder類的父類。XNode 類用于存儲解析過程中遇到的節(jié)點,XPathParser 類封裝了 XPath 相關(guān)的操作,如 XML文件的載入、節(jié)點的解析等。Configuration 類存儲了解析出來的所有屬性。
XML 解析準備階段
XML 文件的解析通過在SqlSessionFactoryBuilder 類中創(chuàng)建XMLConfigBuilder 類并調(diào)用其 parse 方法開始。

在XMLConfigBuilder 初始化時,會創(chuàng)建XPathParser 類的實例,然后創(chuàng)建Configuration 類的實例,保存各個參數(shù)以供后續(xù)使用。

在XPathParser 類的初始化過程中,會創(chuàng)建 XPath 實例,然后讀入 XML 文件創(chuàng)建 Document 對象,完成 XML 文件解析的準備工作。

XML 配置解析過程
XML 配置解析是從XMLConfigBuilder 的parse() 方法開始的。在 parse() 方法中,首先判斷是否已經(jīng)解析過,如果重復(fù)解析則拋出異常,然后解析出 XML 文件的根節(jié)點?configuration,再從根節(jié)點中依次解析出?properties、settings、typeAliases、plugins、objectFactory、objectWrapperFactory、reflectorFactory、environments、databaseIdProvider、typeHandlers、mappers節(jié)點的內(nèi)容,解析完成后返回configuration 對象。

解析過程可以分為以下幾步:
1、解析 properties :讀取 XML 中的名稱鍵值對并保存,如果引用了 properties 文件或傳入了 properties 配置,則會用新的 properties 值替換 XML 中的配置。
2、解析 settings:按照 Properties 類型存儲。
3、解析 typeAliases:typeAliases 定義了類的別名,解析后需要根據(jù) type 的值加載相應(yīng)的 class,并注冊到 typeAliasRegistry 中。
4、解析 plugins:加載 Interceptor 實現(xiàn)類,創(chuàng)建對象,并存入 configuration 中。
5、解析 objectFactory:加載 ObjectFactory 實現(xiàn)類,創(chuàng)建對象,并存入 configuration 中。
6、解析 objectWrapperFactory:加載 ObjectWrapperFactory 實現(xiàn)類,創(chuàng)建對象,并存入 configuration 中。
7、解析 reflectorFactory:加載 ReflectorFactory 實現(xiàn)類,創(chuàng)建對象,并存入 configuration 中。
8、解析 environments:根據(jù)配置的默認環(huán)境 ID,加載環(huán)境配置,創(chuàng)建 Environment 對象,并存入 configuration 中。Environment 對象包含了數(shù)據(jù)源和事務(wù)管理器對象。
9、解析 databaseIdProvider:加載 DatabaseIdProvider 實現(xiàn)類,讀取屬性配置,創(chuàng)建對象,獲取數(shù)據(jù)源的 databaseId 并存入 configuration。
10、解析 typeHandlers:解析屬性配置,加載實現(xiàn)類,創(chuàng)建對象,并注冊到 typeHandlerRegistry 中。
11、解析 mappers:解析 mapper 節(jié)點,如果引用了 XML 文件則載入文件并創(chuàng)建 XMLMapperBuilder 對象進行解析,如果引用了包或類則添加到 configuration 中。注冊 Mapper 到?MapperRegistry 時,會創(chuàng)建 Mapper 接口的代理實現(xiàn)工廠?MapperProxyFactory,掃描 Mapper 接口的注解并存入configuration 。
Mapper 文件的解析
mapper XML 文件的解析在XMLMapperBuilder 中實現(xiàn)。與XMLConfigBuilder 一樣,XMLMapperBuilder 初始化時也會創(chuàng)建XPathParser 類的實例,但會使用參數(shù)傳入的 configuration。
XML 文件的解析是在 parse 方法中完成的。首先判斷是否已經(jīng)加載過,如果沒有加載過則獲取 XML 的根節(jié)點 mapper 并開始解析,解析完成后根據(jù)命名空間的配置加載相應(yīng)的 Mapper 接口并添加到configuration 中,最后加載未完成加載的 ResultMap、CacheRef 和 Statement。

configurationElement 方法實現(xiàn)了對 mapper 子節(jié)點的解析,如下所示,讀取了?namespace、cache-ref、cache、parameterMap、resultMap、sql、select、insert、update、delete 等節(jié)點和屬性。如果引用的類型不在此 XML 中,并且配置中也獲取不到,則會加入未完成列表,在解析下個 XML 文件時再次嘗試加載。

mapper 文件的解析細節(jié)比較復(fù)雜,后文再深入分析。
每周 3 篇學(xué)習(xí)筆記或技術(shù)總結(jié),面向有一定基礎(chǔ)的 Java 程序員,內(nèi)容涉及 Java 進階、虛擬機、MySQL、NoSQL、分布式計算、開源框架等多個領(lǐng)域。關(guān)注作者或微信公眾號 backend-develop 第一時間獲取最新內(nèi)容。