MyBatis是如何初始化的？

作者：龙哥笔记。

MyBatis 初始化方法及介绍

MyBatis 可以通过两种方式进行初始化：

• 基于 XML 配置文件 ：基于配置文件 XML MyB 配置基于 XML 文件的方法是插入 XML MyB 配置的配置文件。 file ，MyBatis 通过加载 XML 配置文件，将配置文件信息组装成内部配置对象。
• 基于Java API：该方法不使用XML配置文件。它需要MyBatis用户在Java代码中手动创建一个配置对象，然后将配置参数插入到该配置对象中。

初始化方法-XML配置

接下来我们将通过基于XML配置文件方法的MyBatis初始化来探索MyBatis如何通过配置文件构建配置对象并使用它。

现在我们就从一个简单的使用MyBatis的例子开始，对MyBatis如何完成初始化以及初始化什么进行深入分析。看下面的代码：

// mybatis初始化
String resource = "mybatis-config.xml"; 
InputStream inputStream = Resources.getResourceAsStream(resource); 
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession(); 
// 执行SQL语句
List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");

使用过MyBatis的读者都会知道，上述语句的作用是执行com.foo.bean.BlogMapper.queryAllBlogInfo定义的SQL语句，并返回一个列表结果集。总的来说，上面的代码经历了三个阶段（本系列也对应三篇文章分别讲解）：

• mybatis初始化篇
• 创建SqlSession——稍后详细讲解
• 执行说明SQL语句

函数上面代码的作用是根据配置文件mybatis-config.xml创建一个SqlSessionFactory对象，然后生成一个SqlSession并执行SQL语句。 mybatis的初始化发生在第三条语句：SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);现在让我们看看第三句发生了什么。

MyBatis初始化的基本流程：

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

基本初始化流程如下时序图所示：

如上图所示，mybatis初始化需要以下简单步骤：

• 调用SQLSessionFactoryBuilder对象的build方法（inputStream）；
• SqlSessionFactoryBuilder会根据输入流inputStream等信息创建一个XMLConfigBuilder对象；
• SqlSessionFactoryBuilder 调用 XMLConfigBuilder 对象的 parse() 方法；
• XMLConfigBuilder 对象返回 Configuration 对象；
• SqlSessionFactoryBuilder根据配置对象创建一个DefaultSessionFactory对象；
• SqlSessionFactoryBuilder 返回 DefaultSessionFactory 对象，提供给客户端供客户端使用。

SqlSessionFactoryBuilder相关代码如下：

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); 
} 

上面的初始化过程涉及到以下对象：

• SqlSessionFactoryBuilder：SqlSessionFactory的构造函数，用于通过创建SqlS设计来创建SqlSessionFactory模式配置：这个对象都是mybatis - mybatis-config.xml文件中的配置信息
• SqlSessionFactory：SqlSession工厂类，使用工厂工厂设计模式
• XmlConfigPar-configible-converting mybatis，以工厂的形式创建SqlSession对象。 xmlConfigure文件解析成Configuration对象，并使用SQLSessionFactoryBuilder创建SQLSessionFactory

来创建Configuration对象。那么上面提到的MyBatis的基本流程的讨论就引发了上面的讨论。 ER运行BUILD()方法，并调用xmlconfigbuilder的PARSE()方法。然后返回配置对象。那么parse()方法是如何处理XML文件并生成配置对象的呢？

• XMLConfigBuilder 会将 XML 配置文件信息转换为 Document 对象

将 XML 配置定义文件 DTD 转换为 XMLMapperEntityResolver 对象，然后将两者封装为 XpathParser 对象。 XpathParser的作用是提供基于Xpath表达式的基本信息。操作DOM节点Node信息。如下图所示：

• 然后XMLConfigBuilder调用parse()方法

从XPathParser中取出节点对应的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"));  
 //为了让读者看得更明晰，源码拆分为以下两句 
 XNode configurationNode = parser.evalNode("/configuration"); 
 parseConfiguration(configurationNode); 
 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 
 mapperElement(root.evalNode("mappers")); 
 } catch (Exception e) { 
 throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e); 
 } 
} 

注意：上面的代码中，还有一个非常重要的地方，就是解析XML配置文件的子节点 mapperElements(root.evalNode("mappers"))，它会解析我们配置的Mapper.xml配置文件。 Mapper配置文件可以说是MyBatis的核心。 MyBatis的功能和理念都体现在这个Mapper的配置和设计上。

• 然后你解析这些值并将其插入到配置对象中

解析子节点的过程这里就不一一介绍了。用户可以参考MyBatis源码仔细查找。我们来看看上面的环境 (root.evalNode("environments"));下面介绍如何解析环境信息并插入到配置对象中：

/** 
 * 解析environments节点，并将结果设置到Configuration对象中 
 * 注意：创建envronment时，如果SqlSessionFactoryBuilder指定了特定的环境（即数据源）； 
 *      则返回指定环境（数据源）的Environment对象，否则返回默认的Environment对象； 
 *      这种方式实现了MyBatis可以连接多数据源 
 */ 
private void environmentsElement(XNode context) throws Exception { 
 if (context != null) 
 { 
 if (environment == null) 
 { 
            environment = context.getStringAttribute("default"); 
 } 
 for (XNode child : context.getChildren()) 
 { 
 String id = child.getStringAttribute("id"); 
 if (isSpecifiedEnvironment(id)) 
 { 
 //1.创建事务工厂 TransactionFactory 
 TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager")); 
 DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource")); 
 //2.创建数据源DataSource 
 DataSource dataSource = dsFactory.getDataSource(); 
 //3. 构造Environment对象 
 Environment.Builder environmentBuilder = new Environment.Builder(id) 
 .transactionFactory(txFactory) 
 .dataSource(dataSource); 
 //4. 将创建的Envronment对象设置到configuration 对象中 
 configuration.setEnvironment(environmentBuilder.build()); 
 } 
 } 
 } 
}
private boolean isSpecifiedEnvironment(String id) 
{ 
 if (environment == null) 
 { 
 throw new BuilderException("No environment specified."); 
 } 
 else if (id == null) 
 { 
 throw new BuilderException("Environment requires an id attribute."); 
 } 
 else if (environment.equals(id)) 
 { 
 return true; 
 } 
 return false; 
} 

• 返回配置对象

定义上面MyBatis基本初始化流程的时序图：

初始化方法-基于Java API ❀O当然我们可以使用XMLConfigBuilder手动解析XML配置文件来创建配置对象。代码如下：

String resource = "mybatis-config.xml"; 
InputStream inputStream = Resources.getResourceAsStream(resource); 
// 手动创建XMLConfigBuilder，并解析创建Configuration对象 
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, null,null); // 看这里 
Configuration configuration = parser.parse(); 
// 使用Configuration对象创建SqlSessionFactory 
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration); 
// 使用MyBatis 
SqlSession sqlSession = sqlSessionFactory.openSession(); 
List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");