快速進(jìn)入Debug跟蹤
我們可以在此處打上斷點(diǎn),Debug模式啟動(dòng)進(jìn)入斷點(diǎn),再按F7跟蹤入其方法
源碼分析準(zhǔn)備
在進(jìn)行Mybatis的初始化過(guò)程之前,我們需要把整個(gè)大綱拎出來(lái)放在前面,讓大家能夠有所了解,然后在進(jìn)行每個(gè)步驟的時(shí)候心里有個(gè)大概;
什么是Mybatis的初始化過(guò)程?
從代碼上來(lái)看 "SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);" 這行代碼就是執(zhí)行的是Mybatis的初始化操作,這個(gè)操作通常在應(yīng)用中只會(huì)操作一次,構(gòu)建完成SqlSessionFactory就不再使用,而SqlSessionFactory會(huì)跟隨整個(gè)應(yīng)用生命周期;
從應(yīng)用階段上來(lái)說(shuō) : Mybatis根據(jù)全局XML配置文件生成SqlSessionFactory的過(guò)程就是Mybatis的初始化過(guò)程.
淺析一詞含義
既然標(biāo)題為淺析某某....相比大家也能看出說(shuō)明本章不會(huì)深度挖掘底層代碼,我個(gè)人認(rèn)為淺析一次的主要意義是 ""能夠快速地在我們心中建立底層源碼的架構(gòu)圖,快速瀏覽代碼,與概念進(jìn)行核對(duì) "",當(dāng)然也不包含某些大牛謙虛的說(shuō)法哈~~? 在這里提的主要目的是,本次淺析Mybatis是快速瀏覽代碼; 稍后會(huì)出新的篇章對(duì)核心方法進(jìn)行剖析
Mybatis初始化過(guò)程中的主要步驟
將全局配置文件XML解析到Configuration對(duì)象
將映射配置文件XML解析到Configuration的mapperRegistry對(duì)象
將映射配置文件XML中的聲明(Statement)解析成MappedStatement對(duì)象存入Configuration對(duì)象的mappedStatements集合中
最后將Configuration最為參數(shù)構(gòu)建DefaultSqlSessionFactory對(duì)象
源碼分析
第一步: 將全局配置文件XML加載到Configuration對(duì)象
XMLConfigBuilder parser =newXMLConfigBuilder(inputStream, environment, properties);parser.parse();復(fù)制代碼
主要功能 : 將全局配置文件中的配置加載到一個(gè)Configuration對(duì)象的屬性中
這是第一步,我們從Main方法的new SqlSessionFactoryBuilder().build(inputStream)進(jìn)入斷點(diǎn),可以看到在構(gòu)建完畢SqlSessionFactoryBuilder對(duì)象后由調(diào)用了重載的build方法
//SqlSessionFactoryBuilder的構(gòu)造方法publicSqlSessionFactoryBuilder(){}//build方法publicSqlSessionFactorybuild(InputStream inputStream){returnthis.build((InputStream)inputStream, (String)null, (Properties)null); }//build方法(重載)publicSqlSessionFactorybuild(InputStream inputStream, String environment, Properties properties){? ? ? ? SqlSessionFactory var5;try{//第一步: 創(chuàng)建XML配置構(gòu)建器,用來(lái)解析全局XML文件內(nèi)容XMLConfigBuilder parser =newXMLConfigBuilder(inputStream, environment, properties);? ? ? ? ? ? var5 =this.build(parser.parse());? ? ? ? }catch(Exception var14) {throwExceptionFactory.wrapException("Error building SqlSession.", var14);? ? ? ? }finally{? ? ? ? ? ? ErrorContext.instance().reset();try{? ? ? ? ? ? ? ? inputStream.close();? ? ? ? ? ? }catch(IOException var13) {? ? ? ? ? ? }? ? ? ? }returnvar5;? ? }
在繼續(xù)深入之前我們需要了解一下XMLConfigBuilder這個(gè)對(duì)象,從名字上來(lái)看就可以知道是解析XML配置文件的;XMLConfigBuilder又繼承了BaseBuilder類(lèi),而在BaseBuilder類(lèi)中有一個(gè)屬性Configuration,這個(gè)Configuration對(duì)象就是用來(lái)存儲(chǔ)全局配置文件和其他Mapper的配置信息, 同時(shí)我們從下圖也可以看到XMLMapperBuilder,XMLStatementBuilder,MapperBuilderAssistant也繼承了BaseBuilder類(lèi)
XMLxxxBuilder是用來(lái)解析XML配置文件的蝇裤，不同類(lèi)型XMLxxxBuilder用來(lái)解析MyBatis配置文件的不同部位氧骤。
XMLConfigBuilder用來(lái)解析MyBatis的全局配置文件
XMLMapperBuilder用來(lái)解析MyBatis中的映射文件
XMLStatementBuilder用來(lái)解析映射文件中的statement語(yǔ)句。
MapperBuilderAssistant用來(lái)輔助解析映射文件并生成MappedStatement對(duì)象
這些XMLxxxBuilder都有一個(gè)共同的父類(lèi)——BaseBuilder挽懦。這個(gè)父類(lèi)維護(hù)了一個(gè)全局的Configuration對(duì)象，MyBatis的配置文件解析后就以Configuration對(duì)象的形式存儲(chǔ)
看源碼果然能發(fā)現(xiàn)貓膩,不錯(cuò)不錯(cuò),可以看到在new這個(gè)XMLConfigBuilder對(duì)象的時(shí)候,下圖的斷點(diǎn)位置super(new Configuration());
可以看到Configuration的構(gòu)造方法如下所示,這也正解釋了我們我們可以在全局配置文件中寫(xiě)個(gè)JDBC就行,因?yàn)樵贑onfiguration對(duì)象在構(gòu)建的時(shí)候就加載了一些默認(rèn)的別名. 別告訴我你不知道別名是啥哈~~
publicConfiguration(){this.safeResultHandlerEnabled =true;this.multipleResultSetsEnabled =true;this.useColumnLabel =true;this.cacheEnabled =true;this.useActualParamName =true;this.localCacheScope = LocalCacheScope.SESSION;this.jdbcTypeForNull = JdbcType.OTHER;this.lazyLoadTriggerMethods =newHashSet(Arrays.asList("equals","clone","hashCode","toString"));this.defaultExecutorType = ExecutorType.SIMPLE;this.autoMappingBehavior = AutoMappingBehavior.PARTIAL;this.autoMappingUnknownColumnBehavior = AutoMappingUnknownColumnBehavior.NONE;this.variables =newProperties();this.reflectorFactory =newDefaultReflectorFactory();this.objectFactory =newDefaultObjectFactory();this.objectWrapperFactory =newDefaultObjectWrapperFactory();this.lazyLoadingEnabled =false;this.proxyFactory =newJavassistProxyFactory();this.mapperRegistry =newMapperRegistry(this);this.interceptorChain =newInterceptorChain();this.typeHandlerRegistry =newTypeHandlerRegistry();this.typeAliasRegistry =newTypeAliasRegistry();this.languageRegistry =newLanguageDriverRegistry();this.mappedStatements =newConfiguration.StrictMap("Mapped Statements collection");this.caches =newConfiguration.StrictMap("Caches collection");this.resultMaps =newConfiguration.StrictMap("Result Maps collection");this.parameterMaps =newConfiguration.StrictMap("Parameter Maps collection");this.keyGenerators =newConfiguration.StrictMap("Key Generators collection");this.loadedResources =newHashSet();this.sqlFragments =newConfiguration.StrictMap("XML fragments parsed from previous mappers");this.incompleteStatements =newLinkedList();this.incompleteCacheRefs =newLinkedList();this.incompleteResultMaps =newLinkedList();this.incompleteMethods =newLinkedList();this.cacheRefMap =newHashMap();this.typeAliasRegistry.registerAlias("JDBC", JdbcTransactionFactory.class);this.typeAliasRegistry.registerAlias("MANAGED", ManagedTransactionFactory.class);this.typeAliasRegistry.registerAlias("JNDI", JndiDataSourceFactory.class);this.typeAliasRegistry.registerAlias("POOLED", PooledDataSourceFactory.class);this.typeAliasRegistry.registerAlias("UNPOOLED", UnpooledDataSourceFactory.class);this.typeAliasRegistry.registerAlias("PERPETUAL", PerpetualCache.class);this.typeAliasRegistry.registerAlias("FIFO", FifoCache.class);this.typeAliasRegistry.registerAlias("LRU", LruCache.class);this.typeAliasRegistry.registerAlias("SOFT", SoftCache.class);this.typeAliasRegistry.registerAlias("WEAK", WeakCache.class);this.typeAliasRegistry.registerAlias("DB_VENDOR", VendorDatabaseIdProvider.class);this.typeAliasRegistry.registerAlias("XML", XMLLanguageDriver.class);this.typeAliasRegistry.registerAlias("RAW", RawLanguageDriver.class);this.typeAliasRegistry.registerAlias("SLF4J", Slf4jImpl.class);this.typeAliasRegistry.registerAlias("COMMONS_LOGGING", JakartaCommonsLoggingImpl.class);this.typeAliasRegistry.registerAlias("LOG4J", Log4jImpl.class);this.typeAliasRegistry.registerAlias("LOG4J2", Log4j2Impl.class);this.typeAliasRegistry.registerAlias("JDK_LOGGING", Jdk14LoggingImpl.class);this.typeAliasRegistry.registerAlias("STDOUT_LOGGING", StdOutImpl.class);this.typeAliasRegistry.registerAlias("NO_LOGGING", NoLoggingImpl.class);this.typeAliasRegistry.registerAlias("CGLIB", CglibProxyFactory.class);this.typeAliasRegistry.registerAlias("JAVASSIST", JavassistProxyFactory.class);this.languageRegistry.setDefaultDriverClass(XMLLanguageDriver.class);this.languageRegistry.register(RawLanguageDriver.class);? ? }
第一步還沒(méi)有執(zhí)行完? 是的上述中我們?cè)诳礃?gòu)建XMLConfigBuilder對(duì)象過(guò)程,現(xiàn)在構(gòu)建完成了我們就需要看這一行代碼了parser.parse();; 當(dāng)有了XMLConfigBuilder對(duì)象之后茧球，接下來(lái)就可以用它來(lái)解析配置文件了
publicConfigurationparse(){//判斷是否已經(jīng)解析,只能解析一次全局配置文件if(this.parsed) {thrownewBuilderException("Each XMLConfigBuilder can only be used once.");? ? ? ? }else{//將parsed標(biāo)記為已經(jīng)解析this.parsed =true;//解析全局配置文件的XML中的configuration節(jié)點(diǎn)this.parseConfiguration(this.parser.evalNode("/configuration"));returnthis.configuration;? ? ? ? }? ? }
//主要看一下解析全局配置文件的configuration節(jié)點(diǎn)的方法privatevoidparseConfiguration(XNode root){try{//解析全局配置文件中的properties節(jié)點(diǎn)的配置信息存儲(chǔ)到Configuration對(duì)象的variables屬性中this.propertiesElement(root.evalNode("properties"));//解析全局配置文件中的settings節(jié)點(diǎn)的配置信息設(shè)置到Configuration對(duì)象的各個(gè)屬性中Properties settings =this.settingsAsProperties(root.evalNode("settings"));this.loadCustomVfs(settings);this.settingsElement(settings);//解析全局配置文件中的typeAliases節(jié)點(diǎn)的配置信息設(shè)置到BaseBuilder對(duì)象的TypeAliasRegistry屬性中this.typeAliasesElement(root.evalNode("typeAliases"));//解析全局配置文件的pluginsthis.pluginElement(root.evalNode("plugins"));//解析全局配置文件中的objectFactory設(shè)置到Configuration對(duì)象的objectFactory屬性中this.objectFactoryElement(root.evalNode("objectFactory"));this.objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));this.reflectorFactoryElement(root.evalNode("reflectorFactory"));//解析全局配置文件中的Environment節(jié)點(diǎn)存儲(chǔ)到Configuration對(duì)象中的Environment屬性中this.environmentsElement(root.evalNode("environments"));this.databaseIdProviderElement(root.evalNode("databaseIdProvider"));this.typeHandlerElement(root.evalNode("typeHandlers"));//第二步 : 解析全局配置文件中的mappers節(jié)點(diǎn)? 注意這是一個(gè)核心的方法 我們點(diǎn)進(jìn)去看一下this.mapperElement(root.evalNode("mappers"));? ? ? ? }catch(Exception var3) {thrownewBuilderException("Error parsing SQL Mapper Configuration. Cause: "+ var3, var3);? ? ? ? }? ? }
從上述代碼中可以看到恃逻，XMLConfigBuilder會(huì)依次解析配置文件中的、晤锹、、彤委、鞭铆、等屬性。
第二步 : 解析映射配置文件XML到Configuration的mapperRegistry容器
this.mapperElement(root.evalNode("mappers"));
主要功能 : MyBatis會(huì)遍歷下所有的子節(jié)點(diǎn)焦影，如果當(dāng)前遍歷到的節(jié)點(diǎn)是车遂，則MyBatis會(huì)將該包下的所有Mapper Class注冊(cè)到configuration的mapperRegistry容器中。如果當(dāng)前節(jié)點(diǎn)為偷办，則會(huì)依次獲取resource艰额、url澄港、class屬性椒涯，解析映射文件，并將映射文件對(duì)應(yīng)的Mapper Class注冊(cè)到configuration的mapperRegistry容器中回梧。
XMLConfigBuilder解析全局配置文件中有一個(gè)比較重要的一步;就是解析映射文件this.mapperElement(root.evalNode("mappers"))這句代碼開(kāi)始解析映射文件,我們開(kāi)看一下下圖中構(gòu)建了一個(gè)XMLMapperBuilder對(duì)象,這個(gè)對(duì)象是負(fù)責(zé)解析映射文件的;而第一步的XMLConfigBuilder對(duì)象是解析全局配置文件的
上圖中紅色圈中的是Mybatis解析映射文件的方法,我們進(jìn)去看一下mapperParser = new XMLMapperBuilder(inputStream, this.configuration, resource, this.configuration.getSqlFragments());
privateXMLMapperBuilder(XPathParser parser, Configuration configuration, String resource, Map<String, XNode> sqlFragments){//首先會(huì)初始化父類(lèi)BaseBuilder废岂，并將configuration賦給BaseBuilder祖搓；super(configuration);//然后創(chuàng)建MapperBuilderAssistant對(duì)象，該對(duì)象為XMLMapperBuilder的協(xié)助者湖苞，用來(lái)協(xié)助XMLMapperBuilder完成一些解析映射文件的動(dòng)作this.builderAssistant =newMapperBuilderAssistant(configuration, resource);this.parser = parser;this.sqlFragments = sqlFragments;this.resource = resource;? ? }publicvoidparse(){if(!this.configuration.isResourceLoaded(this.resource)) {this.configurationElement(this.parser.evalNode("/mapper"));this.configuration.addLoadedResource(this.resource);this.bindMapperForNamespace();? ? ? ? }this.parsePendingResultMaps();this.parsePendingCacheRefs();this.parsePendingStatements();? ? }
再看一下mapperParser.parse();
publicvoidparse(){//如果映射文件沒(méi)有被加載過(guò)if(!this.configuration.isResourceLoaded(this.resource)) {//執(zhí)行加載映射文件XML方法configurationElementthis.configurationElement(this.parser.evalNode("/mapper"));//將此映射文件添加已經(jīng)解析了的集合中this.configuration.addLoadedResource(this.resource);//綁定Namespacethis.bindMapperForNamespace();? ? ? ? }this.parsePendingResultMaps();this.parsePendingCacheRefs();this.parsePendingStatements();? ? }
下面是具體Mybatis解析映射文件中的Statement的過(guò)程
privatevoidconfigurationElement(XNode context){try{//獲取namespaceString namespace = context.getStringAttribute("namespace");//判斷namespace,如果為空直接拋出異常if(namespace !=null&& !namespace.equals("")) {//設(shè)置namespacethis.builderAssistant.setCurrentNamespace(namespace);//下面就是解析各個(gè)Statement中的各個(gè)XML節(jié)點(diǎn)this.cacheRefElement(context.evalNode("cache-ref"));this.cacheElement(context.evalNode("cache"));this.parameterMapElement(context.evalNodes("/mapper/parameterMap"));this.resultMapElements(context.evalNodes("/mapper/resultMap"));this.sqlElement(context.evalNodes("/mapper/sql"));//第三步 : 解析Statement聲明? 核心方法this.buildStatementFromContext(context.evalNodes("select|insert|update|delete"));? ? ? ? ? ? }else{thrownewBuilderException("Mapper's namespace cannot be empty");? ? ? ? ? ? }? ? ? ? }catch(Exception var3) {thrownewBuilderException("Error parsing Mapper XML. Cause: "+ var3, var3);? ? ? ? }? ? }
從上述代碼中可以看到拯欧，XMLMapperBuilder借助MapperBuilderAssistant會(huì)對(duì)Mapper映射文件進(jìn)行解析,在解析到最后,會(huì)將每一個(gè)中的節(jié)點(diǎn)解析為MappedStatement對(duì)象
第三步 : 解析映射文件的Statement為MappedStatement對(duì)象
this.buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
主要功能 : 將映射文件的子節(jié)點(diǎn)解析為MappedStatement對(duì)象
我們進(jìn)入this.buildStatementFromContext(context.evalNodes("select|insert|update|delete"));這個(gè)方法看一下
privatevoidbuildStatementFromContext(List<XNode> list){if(this.configuration.getDatabaseId() !=null) {this.buildStatementFromContext(list,this.configuration.getDatabaseId());? ? ? ? }this.buildStatementFromContext(list, (String)null);? ? }privatevoidbuildStatementFromContext(List<XNode> list, String requiredDatabaseId){? ? ? ? Iterator var3 = list.iterator();while(var3.hasNext()) {? ? ? ? ? ? XNode context = (XNode)var3.next();? ? ? ? ? ? XMLStatementBuilder statementParser =newXMLStatementBuilder(this.configuration,this.builderAssistant, context, requiredDatabaseId);try{? ? ? ? ? ? ? ? statementParser.parseStatementNode();? ? ? ? ? ? }catch(IncompleteElementException var7) {this.configuration.addIncompleteStatement(statementParser);? ? ? ? ? ? }? ? ? ? }? ? }
其中主要的邏輯都在下示圖中的兩行代碼中
接下來(lái)我們進(jìn)入XMLStatementBuilder類(lèi)的parseStatementNode去看看
最終由MapperBuilderAssistant完成MappedStatement對(duì)象的封裝，并且將MappedStatement對(duì)象放入Configuration對(duì)象的**mappedStatements**容器中
初始化完成
主要功能 : 將已經(jīng)裝載了各種XML信息的Configuration對(duì)象作為參數(shù)構(gòu)建DefaultSqlSessionFactory返回,Mybatis初始化完成!!!
publicSqlSessionFactorybuild(Configuration config){returnnewDefaultSqlSessionFactory(config);? ? }
搭建源碼Debug環(huán)境
POM依賴(lài)
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->org.mybatismybatis3.4.5
測(cè)試SQL
CREATETABLE`user`(`id`int(10)NOTNULLAUTO_INCREMENT,`username`varchar(10)NOTNULL,`password`varchar(52)NOTNULL,? PRIMARYKEY(`id`))ENGINE=InnoDBAUTO_INCREMENT=6DEFAULTCHARSET=latin1
Mybatis全局配置文件
<?xml version="1.0"encoding="UTF-8"?><!DOCTYPE configuration
? ? ? ? PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
? ? ? ? "http://mybatis.org/dtd/mybatis-3-config.dtd">
UserMapper接口
publicinterfaceUserMapper{UserselectUser(Integer id);}
UserMapper配置
<?xml version="1.0"encoding="UTF-8"?><!DOCTYPE mapper
? ? ? ? PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
? ? ? ? "http://mybatis.org/dtd/mybatis-3-mapper.dtd">select *? ? ? ? from user? ? ? ? where id = #{id}
User實(shí)體
publicclassUser{privateintid;privateString username;privateString password;getter and setter .....}
Main方法
publicstaticvoidmain(String[] args)throwsIOException{? ? ? ? String resource ="mybatis-config.xml";? ? ? ? InputStream inputStream = Resources.getResourceAsStream(resource);? ? ? ? SqlSessionFactory sqlSessionFactory =newSqlSessionFactoryBuilder().build(inputStream);? ? ? ? SqlSession sqlSession = sqlSessionFactory.openSession();? ? ? ? User user = sqlSession.selectOne("user.selectUser",2);? ? ? ? System.out.println(user.toString());? ? }
在此我向大家推薦一個(gè)架構(gòu)學(xué)習(xí)交流群财骨。交流學(xué)習(xí)群號(hào)：938837867 暗號(hào)：555 里面會(huì)分享一些資深架構(gòu)師錄制的視頻錄像：有Spring镐作，MyBatis，Netty源碼分析隆箩，高并發(fā)该贾、高性能、分布式捌臊、微服務(wù)架構(gòu)的原理杨蛋，JVM性能優(yōu)化、分布式架構(gòu)等這些成為架構(gòu)師必備
