这篇文章主要介绍“Mybatis源码分析之如何理解SQLSession初始化”，在日常操作中，相信很多人在Mybatis源码分析之如何理解SQLSession初始化问题上存在疑惑，小编查阅了各式资料，整理出简单好用的操作方法，希望对大家解答”Mybatis源码分析之如何理解SQLSession初始化”的疑惑有所帮助！接下来，请跟着小编一起来学习吧！
10年积累的网站设计制作、网站制作经验，可以快速应对客户对网站的新想法和需求。提供各种问题对应的解决方案。让选择我们的客户得到更好、更有力的网络服务。我虽然不认识你，你也不认识我。但先做网站后付款的网站建设流程，更有红安免费网站建设让你可以放心的选择与我们合作。
这次打算写一个 Mybatis 源码分析的系列,大致分为
Mybatis 启动流程分析
Mybatis 的SQL 执行流程分析
Mybatis 的拓展点以及与 Spring Boot 的整合
这篇文章先来分析 Mybati初始化流程,如何读取配置文件到,以及创建出 SqlSession 示例.主要内容包括
读取、解析mybatis 全局配置文件
映射 mapper.java 文件
解析 mapper.xml 文件
解析 mapper.xml 各个节点配置，包括 namespace、缓存、增删改查节点
Mybatis 缓存机制
构建DefaultSqlSessionFactory
SQLSession对外提供了用户和数据库之间交互需要的所有方法，隐藏了底层的细节。默认实现类是DefaultSqlSession
通过一个mybatis 官方提供的示例,看下如何手动创建 SQLSession
//Mybatis 配置文件,通常包含:数据库连接信息,Mapper.class 全限定名包路径,事务配置,插件配置等等 String resource = "org/mybatis/builder/mybatis-config.xml"; //以输入流的方式读取配置 InputStream inputStream = Resources.getResourceAsStream(resource); //实例化出 SQLSession 的必要步骤 SqlSessionFactoryBuilder --> SqlSessionFactory --> SqlSession SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder(); SqlSessionFactory factory = builder.build(inputStream); SqlSession session = factory.openSession();
接下来就通过new SqlSessionFactoryBuilder() 开始我们的构建 SQLSession 源码分析
//SqlSessionFactory 有4 个构造方法,最终都会执行到全参的构造方法
public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
try {
//首先会实例化一个 XMLConfigBuilder ,这里先有个基本的认知:XMLConfigBuilder 就是用来解析 XML 文件配置的
XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
//经过parser.parse()之后,XML配置文件已经被解析成了Configuration ,Configuration 对象是包含着mybatis的所有属性.
return build(parser.parse());
} catch (Exception e) {
throw ExceptionFactory.wrapException("Error building SqlSession.", e);
} finally {
//... 关闭流,抛异常
}
}
MLConfigBuilder : 解析全局配置文件即 mybatis-config.xml
XMLMapperBuilder : 解析 Mapper 文件,配置在mybatis-config.xml 文件中 mapper.java 的包路径
XMLStatementBuilder :解析 mapper 文件的节点中 ,SQL 语句标签:select,update,insert,delete
SQLSourceBuilder:动态解析 SQL 语句,根据 SqlNode 解析 Sql 语句中的标签,比如
当然 BaseBuilder 的实现类不仅这 4 个,这里只介绍这 4 类,在后续一步步分析中都能看到这几个的身影 点进去看一下 parser.parse()
public Configuration parse() {
// 若已经解析过了 就抛出异常
if (parsed) {
throw new BuilderException("Each XMLConfigBuilder can only be used once.");
}
// 设置解析标志位
parsed = true;
// 解析mybatis-config.xml的节点,读取配置文件,加载到 Configuration 中
parseConfiguration(parser.evalNode("/configuration"));
return configuration;
}解析成 Configuration 成之前会先将 xml 配置文件解析成 XNode 对象
public XNode evalNode(Object root, String expression) {
//mybatis 自已定义了一个XPathParser 对象来解析 xml ,其实对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节点
* 解析 XML 中的各个节点
*/
private void parseConfiguration(XNode root) {
try {
/**
* 解析 properties节点
*
*
*/
Properties settings = settingsAsProperties(root.evalNode("settings"));
/**
* 基本没有用过该属性
* VFS含义是虚拟文件系统；主要是通过程序能够方便读取本地文件系统、FTP文件系统等系统中的文件资源。
Mybatis中提供了VFS这个配置，主要是通过该配置可以加载自定义的虚拟文件系统应用程序
解析到：org.apache.ibatis.session.Configuration#vfsImpl
*/
loadCustomVfs(settings);
/**
* 指定 MyBatis 所用日志的具体实现，未指定时将自动查找。
* 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"));
// 设置settings 和默认值
settingsElement(settings);
// read it after objectFactory and objectWrapperFactory issue #631
/**
* 解析我们的mybatis环境,解析 DataSource
解析到：org.apache.ibatis.session.Configuration#typeHandlerRegistry.typeHandlerMap
*/
typeHandlerElement(root.evalNode("typeHandlers"));
/**
* 最最重要的就是解析我们的mapper
*
resource：来注册我们的class类路径下的
url:来指定我们磁盘下的或者网络资源的
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节点下的一个一个的mapper节点
for (XNode child : parent.getChildren()) {
/**
* 指定 mapper 的 4 中方式:
* 1.指定的 mapper 所在的包路径,批量注册
* 2.通过 resource 目录指定
* 3.通过 url 指定,从网络资源或者本地磁盘
* 4.通过 class 路径注册
*/
//判断我们mapper是不是通过批量注册的
if ("package".equals(child.getName())) {
String mapperPackage = child.getStringAttribute("name");
configuration.addMappers(mapperPackage);
} else {
//判断从classpath下读取我们的mapper
String resource = child.getStringAttribute("resource");
//判断是不是从我们的网络资源读取(或者本地磁盘得)
String url = child.getStringAttribute("url");
//解析这种类型(要求接口和xml在同一个包下)
String mapperClass = child.getStringAttribute("class");
//解析 mapper 文件
if (resource != null && url == null && mapperClass == null) {
ErrorContext.instance().resource(resource);
// 把mapper文件读取出一个流,是不是似曾相识,最开始的时候读取mybatis-config.xml 配置文件也是通过输入流的方式读取的
InputStream inputStream = Resources.getResourceAsStream(resource);
//创建读取XmlMapper构建器对象,用于来解析我们的mapper.xml文件,上面提到过的 XMLMapperBuilder对象
/**
* 读取的 mapper 文件会被放入到 MapperRegistry 中的 knownMappers中
* Map, MapperProxyFactory> knownMappers = new HashMap<>();
* 为后续创建 Mapper 代理对象做准备
*/
XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
//真正的解析我们的mapper.xml配置文件,这里就会来解析我们的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 标签
//解析的 SQL 语句节点会放在Configuration.MappedStatement.SqlSource 中,SqlSource 中包含了一个个的 SQLNode,一个标签对应一个 SQLNode
public void parse() {
//判断当前的Mapper是否被加载过
if (!configuration.isResourceLoaded(resource)) {
//真正的解析我们的mapper
configurationElement(parser.evalNode("/mapper"));
//把资源保存到我们Configuration中
configuration.addLoadedResource(resource);
bindMapperForNamespace();
}
parsePendingResultMaps();
parsePendingCacheRefs();
parsePendingStatements();
}解析 mapper.xml 中的各个节点
