最近工作不忙,上班时间看了下 mybatis 源码,学习学习…
我们要使用 mybatis,就必须得有 SqlSession 对象,它是 mybatis 的核心接口,它提供了执行 sql 、获取 mapper 和管理事物的功能。而想要得到 SqlSession 对象。从源码可知 SqlSession 是一个接口,并不能直接 new 出来,那么肯定就有实现类让我们使用,而 mybatis 确实也提供了对它的一个默认实现 DefaultSqlSession,它的源码如下:
public class DefaultSqlSession implements SqlSession {
private Configuration configuration;
// Sql 执行器
private Executor executor;
private boolean autoCommit;
private boolean dirty;
public DefaultSqlSession(Configuration configuration, Executor executor, boolean autoCommit) {
this.configuration = configuration;
this.executor = executor;
this.dirty = false;
this.autoCommit = autoCommit;
}
public DefaultSqlSession(Configuration configuration, Executor executor) {
this(configuration, executor, false);
}
// 其它是对 sql 操作方法,不列举
}
从上述源码可以知道,如果直接通过 new 的方式创建 SqlSession 对象,就需要自己构造 Configuration 和 Executor 对象,而以硬编码方式创建 Configuration 对象比较麻烦。因此 mybatis 提供了通过 SqlSessionFactory 工程来获取 SqlSession 对象,所以下面主要分析下 SqlSessionFactory 对象的创建过程。
SqlSessionFactory 工厂对象提供了几个重载的 build() 方法来创建 SqlSessionFactory 对象,我们就拿这其中的一个进行分析。
如上图所示,其中核心代码已圈红,XMLConfigBuilder 对象是准备好解析 xml 配置文件的工具,真正解析 xml 配置文件的是 XMLConfigBuilder 的 parser() 方法。
parse() 方法会首先判断 xml 文件是否已被解析,感觉这个方法非线程安全的,如果多线程调用这个方法,可能都会执行 parserConfiguration() 方法。接下来就是通过 parseConfiguration() 方法解析 xml 文件中的各个元素,从如下源码中可以看出,每个元素对应一个解析方法,所有解析的内容之后都会作为 Configuration 对象的成员变量,其中最重要的元素解析方法是 mapperElement() 方法。
private void parseConfiguration(XNode root) {
try {
//issue #117 read properties first
propertiesElement(root.evalNode("properties"));
Properties settings = settingsAsProperties(root.evalNode("settings"));
loadCustomVfs(settings);
typeAliasesElement(root.evalNode("typeAliases"));
pluginElement(root.evalNode("plugins"));
objectFactoryElement(root.evalNode("objectFactory"));
objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
reflectorFactoryElement(root.evalNode("reflectorFactory"));
settingsElement(settings);
// read it after objectFactory and objectWrapperFactory issue #631
environmentsElement(root.evalNode("environments"));
databaseIdProviderElement(root.evalNode("databaseIdProvider"));
typeHandlerElement(root.evalNode("typeHandlers"));
mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
}
对 xml 配置文件解析完之后,返回 Configuration 对象,此对象包含了所有 mybatis 运行的配置信息,然后生成 DefaultSqlSessionFactory 对象。
public SqlSessionFactory build(Configuration config) {
return new DefaultSqlSessionFactory(config);
}
至此,创建 SqlSessionFactory 对象的过程就完了,整个流程还是比较简单清晰明了的。最后附上整个流程的时序图: