应用框架之Mybatis初始化机制解析

导引

MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。本文从深入分析Mybatis的初始化过程。

初始化

任何框架的初始化,都是从配置信息开始。MyBatis的配置信息,大概包含以下信息,其层级结构(http://www.mybatis.org/mybatis-3/zh/configuration.html)如下图所示:

应用框架之Mybatis初始化机制解析

MyBatis的上述配置信息会配置在XML配置文件中,初始化时使用Configuration对象作为配置信息的容器。下面从一个简单例子分析创建Configuration对象的过程:String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession sqlSession = sqlSessionFactory.openSession();

SqlSessionFactoryBuilder根据传入的数据流生成Configuration对象,然后根据Configuration对象创建默认的SqlSessionFactory实例。

应用框架之Mybatis初始化机制解析

SqlSessionFactoryBuilder.build()

public SqlSessionFactory build(InputStream inputStream)
{
 return build(inputStream, null, null);
}
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties)
{
 try
 {
 //2. 创建XMLConfigBuilder对象用来解析XML配置文件,生成Configuration对象
 XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
 //3. 将XML配置文件内的信息解析成Java对象Configuration对象
 Configuration config = parser.parse();
 //4. 根据Configuration对象创建出SqlSessionFactory对象
 return build(config);
 }
 catch (Exception e)
 {
 throw ExceptionFactory.wrapException("Error building SqlSession.", e);
 }
 finally
 {
 ErrorContext.instance().reset();
 try
 {
 inputStream.close();
 }
 catch (IOException e)
 {
 // Intentionally ignore. Prefer previous error.
 }
 }
}
//从此处可以看出,MyBatis内部通过Configuration对象来创建SqlSessionFactory,用户也可以自己通过API构造好Configuration对象,调用此方法创建SqlSessionFactory
public SqlSessionFactory build(Configuration config)
{
 return new DefaultSqlSessionFactory(config);
}

XMLConfigBuilder.parser()

  1. XMLConfigBuilder会将XML配置文件的信息转换为Document对象,而XML配置定义文件DTD转换成XMLMapperEntityResolver对象,然后将二者封装到XpathParser对象中,XpathParser的作用是提供根据Xpath表达式获取基本的DOM节点Node信息的操作。如下图所示:

应用框架之Mybatis初始化机制解析


  1. 之后XMLConfigBuilder调用parse()方法:会从XPathParser中取出 <configuration>节点对应的Node对象,然后解析此Node节点的子Node:properties, settings, typeAliases,typeHandlers, objectFactory, objectWrapperFactory, plugins, environments,databaseIdProvider, mappers。
public Configuration parse()
 {
 if (parsed)
 {
 throw new BuilderException("Each XMLConfigBuilder can only be used once.");
 }
 parsed = true;
 parseConfiguration(parser.evalNode("/configuration"));
 return configuration;
 }
 /*
 解析 "/configuration"节点下的子节点信息,然后将解析的结果设置到Configuration对象中
 */
 private void parseConfiguration(XNode root) {
 try {
 //1.首先处理properties 节点 
 propertiesElement(root.evalNode("properties")); //issue #117 read properties first
 //2.处理typeAliases
 typeAliasesElement(root.evalNode("typeAliases"));
 //3.处理插件
 pluginElement(root.evalNode("plugins"));
 //4.处理objectFactory
 objectFactoryElement(root.evalNode("objectFactory"));
 //5.objectWrapperFactory
 objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
 //6.settings
 settingsElement(root.evalNode("settings"));
 //7.处理environments
 environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #631
 //8.database
 databaseIdProviderElement(root.evalNode("databaseIdProvider"));
 //9. typeHandlers
 typeHandlerElement(root.evalNode("typeHandlers"));
 //10 mappers,它将解析Mapper.xml配置文件
 mapperElement(root.evalNode("mappers"));
 } catch (Exception e) {
 throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
 }
 }

初始化过程的时序图如下:

应用框架之Mybatis初始化机制解析

涉及到的设计模式

初始化的过程涉及到创建各种对象,所以会使用一些创建型的设计模式。在初始化的过程中,Builder模式运用的比较多。例如SqlSessionFactory的创建:对于创建SqlSessionFactory时,会根据情况提供不同的参数。由于构造时参数不定,可以为其创建一个构造器Builder,将SqlSessionFactory的构建过程和表示分开:

应用框架之Mybatis初始化机制解析

相关推荐