前言
在原始Mybatis
的使用中,使用Mybatis
时会先读取配置文件mybatis-config.xml
为字符流或者字节流,然后通过SqlSessionFactoryBuilder
基于配置文件的字符流或字节流来构建SqlSessionFactory
。本节将结合Mybatis
源码,对读取配置文件mybatis-config.xml
和构建SqlSessionFactory
的原理进行学习。
正文
原始Mybatis
读取配置文件mybatis-config.xml
和构建SqlSessionFactory
的一个示例如下。
InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
上述示例中的Resources
工具类提供了方法可以读取classpath下指定名字的文件为字符流或者字节流,这里是使用了其提供的getResourceAsStream()
方法将mybatis-config.xml
文件读取为字节流。SqlSessionFactoryBuilder
是一个建造者,其提供了共计9个重载的build()
方法用于构建SqlSessionFactory
,这9个build()
方法可以分为三类,概括如下。
- 基于配置文件字符流构建
SqlSessionFactory
; - 基于配置文件字节流构建
SqlSessionFactory
; - 基于
Configuration
类构建SqlSessionFactory
。
实际上,基于配置文件字符流和基于配置文件字节流构建的方式,最终都是将字符流或字节流解析并生成Configuration
类,然后基于Configuration
类构建SqlSessionFactory
。
下面以基于配置文件字节流构建SqlSessionFactory
的过程为例,对整个读配置文件的流程进行说明。上面的示例中调用的build()
方法如下所示。
public SqlSessionFactory build(InputStream inputStream) {
return build(inputStream, null, null);
}
上面被调用的重载的build()
方法如下所示。
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
try {
// XMLConfigBuilder会解析配置文件并生成Configuration类
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
// 调用入参为Configuration的build()方法构建SqlSessionFactory并返回
return build(parser.parse());
} catch (Exception e) {
throw ExceptionFactory.wrapException("Error building SqlSession.", e);
} finally {
ErrorContext.instance().reset();
try {
inputStream.close();
} catch (IOException e) {
}
}
}
可以发现,配置文件的解析是发生在XMLConfigBuilder
的parse()
方法中,在查看parse()
方法前,先看一下XMLConfigBuilder
的类图,如下所示。
通过XMLConfigBuilder
的类图可以知道,XMLConfigBuilder
解析配置文件是依靠XPathParser
,而XPathParser
是Mybatis
提供的基于JAVA XPath
的解析器。同时,XMLConfigBuilder
内部维护了一个Configuration
,通过XPathParser
解析配置文件得到的配置属性均会丰富到Configuration
中。
现在开始分析XMLConfigBuilder
的parse()
方法,其实现如下所示。
public Configuration parse() {
if (parsed) {
throw new BuilderException("Each XMLConfigBuilder can only be used once.");
}
parsed = true;
parseConfiguration(parser.evalNode("/configuration"));
return configuration;
}
要理解parse()
方法,最好是和一个实际的配置文件进行对照,如下给出一个实际的配置文件。
<?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">
<configuration>
<settings>
<setting name="useGeneratedKeys" value="true"/>
</settings>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/test?characterEncoding=utf-8&serverTimezone=UTC&useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<mappers>
<package name="com.mybatis.learn.dao"/>
</mappers>
</configuration>
所以在parse()
方法中,首先是获取配置文件的configuration节点(根节点),然后将configuration节点传入parseConfiguration()
方法,接着在parseConfiguration()
方法中会根据传入的configuration节点依次获取子节点并读取子节点属性,最后将获取到的属性丰富进Configuration
。parseConfiguration()
方法实现如下所示。
private void parseConfiguration(XNode root) {
try {
propertiesElement(root.evalNode("properties"));
Properties settings = 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标签及其子标签的属性到Configuration中
environmentsElement(root.evalNode("environments"));
databaseIdProviderElement(root.evalNode("databaseIdProvider"));
typeHandlerElement(root.evalNode("typeHandlers"));
// 丰富mappers标签的属性到Configuration中
mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
}
最后parse()
方法会返回Configuration
,SqlSessionFactoryBuilder
会基于Configuration
创建DefaultSqlSessionFactory
并返回,如下所示。
public SqlSessionFactory build(Configuration config) {
return new DefaultSqlSessionFactory(config);
}
DefaultSqlSessionFactory
类图如下所示。
至此,读取配置文件mybatis-config.xml
和构建SqlSessionFactory
的基本原理已经介绍完毕。
总结
本篇文章是对Mybatis
读取配置文件并构建SqlSessionFactory
的一个整体流程进行了介绍,即通过Resources
工具类获取配置文件输入字符流或字节流,然后通过SqlSessionFactoryBuilder
创建DefaultSqlSessionFactory
,在SqlSessionFactoryBuilder
中是通过XMLConfigBuilder
来完成配置文件属性的读取并丰富进Configuration
,SqlSessionFactoryBuilder
也是基于XMLConfigBuilder
返回的Configuration
创建的DefaultSqlSessionFactory
。实际上,关于Mybatis
配置文件的读取,最关键的部分在于如何注册映射文件/映射接口,该部分内容,会在后面的文章中进行学习。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。