MyBatis實現(xiàn)配置加載的步驟

第MyBatis實現(xiàn)配置加載的步驟目錄前言正文總結(jié)

前言

在原始MyBatis的使用中，使用MyBatis時會先讀取配置文件mybatis-config.xml為字符流或者字節(jié)流，然后通過SqlSessionFactoryBuilder基于配置文件的字符流或字節(jié)流來構(gòu)建SqlSessionFactory。

本篇文章將結(jié)合MyBatis源碼，對讀取配置文件mybatis-config.xml和構(gòu)建SqlSessionFactory的原理進行學(xué)習(xí)。

正文

原始MyBatis讀取配置文件mybatis-config.xml和構(gòu)建SqlSessionFactory的一個示例如下。

InputStreaminputStream=Resources.getResourceAsStream("mybatis-config.xml");

SqlSessionFactorysqlSessionFactory=newSqlSessionFactoryBuilder().build(inputStream);

上述示例中的Resources工具類提供了方法可以讀取classpath下指定名字的文件為字符流或者字節(jié)流，這里是使用了其提供的getResourceAsStream()方法將mybatis-config.xml文件讀取為字節(jié)流。SqlSessionFactoryBuilder是一個建造者，其提供了共計9個重載的build()方法用于構(gòu)建SqlSessionFactory，這9個build()方法可以分為三類，概括如下。

基于配置文件字符流構(gòu)建SqlSessionFactory；基于配置文件字節(jié)流構(gòu)建SqlSessionFactory；基于Configuration類構(gòu)建SqlSessionFactory。

實際上，基于配置文件字符流和基于配置文件字節(jié)流構(gòu)建的方式，最終都是將字符流或字節(jié)流解析并生成Configuration類，然后基于Configuration類構(gòu)建SqlSessionFactory。

下面以基于配置文件字節(jié)流構(gòu)建SqlSessionFactory的過程為例，對整個讀配置文件的流程進行說明。上面的示例中調(diào)用的build()方法如下所示。

publicSqlSessionFactorybuild(InputStreaminputStream){

returnbuild(inputStream,null,null);

}

上面被調(diào)用的重載的build()方法如下所示。

publicSqlSessionFactorybuild(InputStreaminputStream,Stringenvironment,Propertiesproperties){

try{

//XMLConfigBuilder會解析配置文件并生成Configuration類

XMLConfigBuilderparser=newXMLConfigBuilder(inputStream,environment,properties);

//調(diào)用入?yún)镃onfiguration的build()方法構(gòu)建SqlSessionFactory并返回

returnbuild(parser.parse());

}catch(Exceptione){

throwExceptionFactory.wrapException("ErrorbuildingSqlSession.",e);

}finally{

ErrorContext.instance().reset();

try{

inputStream.close();

}catch(IOExceptione){

}

可以發(fā)現(xiàn)，配置文件的解析是發(fā)生在XMLConfigBuilder的parse()方法中，在查看parse()方法前，先看一下XMLConfigBuilder的類圖，如下所示。

通過XMLConfigBuilder的類圖可以知道，XMLConfigBuilder解析配置文件是依靠XPathParser，而XPathParser是MyBatis提供的基于JAVAXPath的解析器。同時，XMLConfigBuilder內(nèi)部維護了一個Configuration，通過XPathParser解析配置文件得到的配置屬性均會豐富到Configuration中。

現(xiàn)在開始分析XMLConfigBuilder的parse()方法，其實現(xiàn)如下所示。

publicConfigurationparse(){

if(parsed){

thrownewBuilderException("EachXMLConfigBuildercanonlybeusedonce.");

parsed=true;

parseConfiguration(parser.evalNode("/configuration"));

returnconfiguration;

}

要理解parse()方法，最好是和一個實際的配置文件進行對照，如下給出一個實際的配置文件。

xmlversion="1.0"encoding="UTF-8"

!DOCTYPEconfigurationPUBLIC"-////DTDConfig3.0//EN"

"/dtd/mybatis-3-config.dtd"

configuration

settings

settingname="useGeneratedKeys"value="true"/

/settings

environmentsdefault="development"

environmentid="development"

transactionManagertype="JDBC"/

dataSourcetype="POOLED"

propertyname="driver"value="com.mysql.cj.jdbc.Driver"/

propertyname="url"value="jdbc:mysql://localhost:3306/testcharacterEncoding=utf-8amp;serverTimezone=UTCamp;useSSL=false"/

propertyname="username"value="root"/

propertyname="password"value="root"/

/dataSource

/environment

/environments

mappers

packagename="com.mybatis.learn.dao"/

/mappers

/configuration

所以在parse()方法中，首先是獲取配置文件的configuration節(jié)點（根節(jié)點），然后將configuration節(jié)點傳入parseConfiguration()方法，接著在parseConfiguration()方法中會根據(jù)傳入的configuration節(jié)點依次獲取子節(jié)點并讀取子節(jié)點屬性，最后將獲取到的屬性豐富進Configuration。parseConfiguration()方法實現(xiàn)如下所示。

privatevoidparseConfiguration(XNoderoot){

try{

propertiesElement(root.evalNode("properties"));

Propertiessettings=settingsAsProperties(root.evalNode("settings"));

loadCustomVfs(settings);

loadCustomLogImpl(settings);

typeAliasesElement(root.evalNode("typeAliases"));

pluginElement(root.evalNode("plugins"));

objectFactoryElement(root.evalNode("objectFactory"));

objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));

reflectorFactoryElement(root.evalNode("reflectorFactory"));

settingsElement(settings);

//豐富environments標(biāo)簽及其子標(biāo)簽的屬性到Configuration中

environmentsElement(root.evalNode("environments"));

databaseIdProviderElement(root.evalNode("databaseIdProvider"));

typeHandlerElement(root.evalNode("typeHandlers"));

//豐富mappers標(biāo)簽的屬性到Configuration中

mapperElement(root.evalNode("mappers"));

}catch(Exceptione){

thrownewBuilderException("ErrorparsingSQLMapperConfiguration.Cause:"+e,e);

}

最后parse()方法會返回Configuration，SqlSessionFactoryBuilder會基于Configuration創(chuàng)建DefaultSqlSessionFactory并返回，如下所示。

publicSqlSessionFactorybuild(Configurationconfig){

returnnewDefaultSqlSessionFactory(config);

}

DefaultSqlSessionFactory類圖如下所示。

至此，讀取配置文件mybatis-config.xml和構(gòu)建SqlSessionFactory的基本原理已經(jīng)介紹完畢。

總結(jié)

本篇文章對MyBatis讀取配置文件并構(gòu)建SqlSessionFactory的一個整體流程進行了介紹，可