這篇文章主要介紹“Mybatis源碼分析之如何理解SQLSession初始化”，在日常操作中，相信很多人在Mybatis源碼分析之如何理解SQLSession初始化問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”Mybatis源碼分析之如何理解SQLSession初始化”的疑惑有所幫助！接下來，請跟著小編一起來學(xué)習(xí)吧！
10年積累的網(wǎng)站設(shè)計(jì)制作、網(wǎng)站制作經(jīng)驗(yàn)，可以快速應(yīng)對客戶對網(wǎng)站的新想法和需求。提供各種問題對應(yīng)的解決方案。讓選擇我們的客戶得到更好、更有力的網(wǎng)絡(luò)服務(wù)。我雖然不認(rèn)識(shí)你，你也不認(rèn)識(shí)我。但先做網(wǎng)站后付款的網(wǎng)站建設(shè)流程，更有紅安免費(fèi)網(wǎng)站建設(shè)讓你可以放心的選擇與我們合作。
這次打算寫一個(gè) Mybatis 源碼分析的系列,大致分為
Mybatis 啟動(dòng)流程分析
Mybatis 的SQL 執(zhí)行流程分析
Mybatis 的拓展點(diǎn)以及與 Spring Boot 的整合
這篇文章先來分析 Mybati初始化流程,如何讀取配置文件到,以及創(chuàng)建出 SqlSession 示例.主要內(nèi)容包括
讀取、解析mybatis 全局配置文件
映射 mapper.java 文件
解析 mapper.xml 文件
解析 mapper.xml 各個(gè)節(jié)點(diǎn)配置，包括 namespace、緩存、增刪改查節(jié)點(diǎn)
Mybatis 緩存機(jī)制
構(gòu)建DefaultSqlSessionFactory
SQLSession對外提供了用戶和數(shù)據(jù)庫之間交互需要的所有方法，隱藏了底層的細(xì)節(jié)。默認(rèn)實(shí)現(xiàn)類是DefaultSqlSession
通過一個(gè)mybatis 官方提供的示例,看下如何手動(dòng)創(chuàng)建 SQLSession
//Mybatis 配置文件,通常包含:數(shù)據(jù)庫連接信息,Mapper.class 全限定名包路徑,事務(wù)配置,插件配置等等 String resource = "org/mybatis/builder/mybatis-config.xml"; //以輸入流的方式讀取配置 InputStream inputStream = Resources.getResourceAsStream(resource); //實(shí)例化出 SQLSession 的必要步驟 SqlSessionFactoryBuilder --> SqlSessionFactory --> SqlSession SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder(); SqlSessionFactory factory = builder.build(inputStream); SqlSession session = factory.openSession();
接下來就通過new SqlSessionFactoryBuilder() 開始我們的構(gòu)建 SQLSession 源碼分析
重慶分公司
重慶分公司
//SqlSessionFactory 有4 個(gè)構(gòu)造方法,最終都會(huì)執(zhí)行到全參的構(gòu)造方法
public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
try {
//首先會(huì)實(shí)例化一個(gè) XMLConfigBuilder ,這里先有個(gè)基本的認(rèn)知:XMLConfigBuilder 就是用來解析 XML 文件配置的
XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
//經(jīng)過parser.parse()之后,XML配置文件已經(jīng)被解析成了Configuration ,Configuration 對象是包含著mybatis的所有屬性.
return build(parser.parse());
} catch (Exception e) {
throw ExceptionFactory.wrapException("Error building SqlSession.", e);
} finally {
//... 關(guān)閉流,拋異常
}
}
MLConfigBuilder : 解析全局配置文件即 mybatis-config.xml
XMLMapperBuilder : 解析 Mapper 文件,配置在mybatis-config.xml 文件中 mapper.java 的包路徑
XMLStatementBuilder :解析 mapper 文件的節(jié)點(diǎn)中 ,SQL 語句標(biāo)簽:select,update,insert,delete
SQLSourceBuilder:動(dòng)態(tài)解析 SQL 語句,根據(jù) SqlNode 解析 Sql 語句中的標(biāo)簽,比如
當(dāng)然 BaseBuilder 的實(shí)現(xiàn)類不僅這 4 個(gè),這里只介紹這 4 類,在后續(xù)一步步分析中都能看到這幾個(gè)的身影 點(diǎn)進(jìn)去看一下 parser.parse()
public Configuration parse() {
// 若已經(jīng)解析過了 就拋出異常
if (parsed) {
throw new BuilderException("Each XMLConfigBuilder can only be used once.");
}
// 設(shè)置解析標(biāo)志位
parsed = true;
// 解析mybatis-config.xml的節(jié)點(diǎn),讀取配置文件,加載到 Configuration 中
parseConfiguration(parser.evalNode("/configuration"));
return configuration;
}解析成 Configuration 成之前會(huì)先將 xml 配置文件解析成 XNode 對象
public XNode evalNode(Object root, String expression) {
//mybatis 自已定義了一個(gè)XPathParser 對象來解析 xml ,其實(shí)對Document做了封裝
Node node = (Node) evaluate(expression, root, XPathConstants.NODE);
if (node == null) {
return null;
}
return new XNode(this, node, variables);
}接下來就看看下mybatis 是如何一步步讀取配置文件的
/**
* 解析 mybatis-config.xml的 configuration節(jié)點(diǎn)
* 解析 XML 中的各個(gè)節(jié)點(diǎn)
*/
private void parseConfiguration(XNode root) {
try {
/**
* 解析 properties節(jié)點(diǎn)
*
*
*/
Properties settings = settingsAsProperties(root.evalNode("settings"));
/**
* 基本沒有用過該屬性
* VFS含義是虛擬文件系統(tǒng)；主要是通過程序能夠方便讀取本地文件系統(tǒng)、FTP文件系統(tǒng)等系統(tǒng)中的文件資源。
Mybatis中提供了VFS這個(gè)配置，主要是通過該配置可以加載自定義的虛擬文件系統(tǒng)應(yīng)用程序
解析到：org.apache.ibatis.session.Configuration#vfsImpl
*/
loadCustomVfs(settings);
/**
* 指定 MyBatis 所用日志的具體實(shí)現(xiàn)，未指定時(shí)將自動(dòng)查找。
* SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING
* 解析到org.apache.ibatis.session.Configuration#logImpl
*/
loadCustomLogImpl(settings);
/**
* 解析我們的別名
*
解析到oorg.apache.ibatis.session.Configuration#typeAliasRegistry.typeAliases
*/
typeAliasesElement(root.evalNode("typeAliases"));
/**
* 解析我們的插件(比如分頁插件)
* mybatis自帶的
* Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
ParameterHandler (getParameterObject, setParameters)
ResultSetHandler (handleResultSets, handleOutputParameters)
StatementHandler (prepare, parameterize, batch, update, query)
解析到：org.apache.ibatis.session.Configuration#interceptorChain.interceptors
*/
pluginElement(root.evalNode("plugins"));
objectFactoryElement(root.evalNode("objectFactory"));
objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
reflectorFactoryElement(root.evalNode("reflectorFactory"));
// 設(shè)置settings 和默認(rèn)值
settingsElement(settings);
// read it after objectFactory and objectWrapperFactory issue #631
/**
* 解析我們的mybatis環(huán)境,解析 DataSource
解析到：org.apache.ibatis.session.Configuration#typeHandlerRegistry.typeHandlerMap
*/
typeHandlerElement(root.evalNode("typeHandlers"));
/**
* 最最重要的就是解析我們的mapper
*
resource：來注冊我們的class類路徑下的
url:來指定我們磁盤下的或者網(wǎng)絡(luò)資源的
class:
若注冊Mapper不帶xml文件的,這里可以直接注冊
若注冊的Mapper帶xml文件的，需要把xml文件和mapper文件同名 同路徑
-->
-->
* 解析 mapper:
* 1.解析mapper.java接口 解析到：org.apache.ibatis.session.Configuration#mapperRegistry.knownMappers
* 2.解析 mapper.xml 配置
*/
mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
} private void mapperElement(XNode parent) throws Exception {
if (parent != null) {
//獲取我們mappers節(jié)點(diǎn)下的一個(gè)一個(gè)的mapper節(jié)點(diǎn)
for (XNode child : parent.getChildren()) {
/**
* 指定 mapper 的 4 中方式:
* 1.指定的 mapper 所在的包路徑,批量注冊
* 2.通過 resource 目錄指定
* 3.通過 url 指定,從網(wǎng)絡(luò)資源或者本地磁盤
* 4.通過 class 路徑注冊
*/
//判斷我們mapper是不是通過批量注冊的
if ("package".equals(child.getName())) {
String mapperPackage = child.getStringAttribute("name");
configuration.addMappers(mapperPackage);
} else {
//判斷從classpath下讀取我們的mapper
String resource = child.getStringAttribute("resource");
//判斷是不是從我們的網(wǎng)絡(luò)資源讀取(或者本地磁盤得)
String url = child.getStringAttribute("url");
//解析這種類型(要求接口和xml在同一個(gè)包下)
String mapperClass = child.getStringAttribute("class");
//解析 mapper 文件
if (resource != null && url == null && mapperClass == null) {
ErrorContext.instance().resource(resource);
// 把mapper文件讀取出一個(gè)流,是不是似曾相識(shí),最開始的時(shí)候讀取mybatis-config.xml 配置文件也是通過輸入流的方式讀取的
InputStream inputStream = Resources.getResourceAsStream(resource);
//創(chuàng)建讀取XmlMapper構(gòu)建器對象,用于來解析我們的mapper.xml文件,上面提到過的 XMLMapperBuilder對象
/**
* 讀取的 mapper 文件會(huì)被放入到 MapperRegistry 中的 knownMappers中
* Map, MapperProxyFactory> knownMappers = new HashMap<>();
* 為后續(xù)創(chuàng)建 Mapper 代理對象做準(zhǔn)備
*/
XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
//真正的解析我們的mapper.xml配置文件,這里就會(huì)來解析我們的sql
mapperParser.parse();
} else if (resource == null && url != null && mapperClass == null) {
ErrorContext.instance().resource(url);
InputStream inputStream = Resources.getUrlAsStream(url);
XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
mapperParser.parse();
} else if (resource == null && url == null && mapperClass != null) {
Class mapperInterface = Resources.classForName(mapperClass);
configuration.addMapper(mapperInterface);
} else {
throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
}
}
}
}
} 解析Mapper.xml 中的 SQL 標(biāo)簽
//解析的 SQL 語句節(jié)點(diǎn)會(huì)放在Configuration.MappedStatement.SqlSource 中,SqlSource 中包含了一個(gè)個(gè)的 SQLNode,一個(gè)標(biāo)簽對應(yīng)一個(gè) SQLNode
public void parse() {
//判斷當(dāng)前的Mapper是否被加載過
if (!configuration.isResourceLoaded(resource)) {
//真正的解析我們的mapper
configurationElement(parser.evalNode("/mapper"));
//把資源保存到我們Configuration中
configuration.addLoadedResource(resource);
bindMapperForNamespace();
}
parsePendingResultMaps();
parsePendingCacheRefs();
parsePendingStatements();
}解析 mapper.xml 中的各個(gè)節(jié)點(diǎn)
