MyBatis原理分析之三：初始化（配置文件读取和解析）

Posted 2020-08-26 竹山一叶

1. 准备工作

  编写测试代码（具体请参考《Mybatis入门示例》）,设置断点,以Debug模式运行,具体代码如下: 

Java代码  

1. String resource = "mybatis.cfg.xml";  
2.   
3. Reader reader = Resources.getResourceAsReader(resource);  
4.   
5. SqlSessionFactory ssf = new SqlSessionFactoryBuilder().build(reader);  
6.   
7. SqlSession session = ssf.openSession();  

 

2.源码分析

我们此次就对上面的代码进行跟踪和分析，let\'s go。

首先我们按照顺序先看看第一行和第二行代码，看看它主要完成什么事情：

Java代码  

1. String resource = "mybatis.cfg.xml";  
2.   
3. Reader reader = Resources.getResourceAsReader(resource);  

 

读取Mybaits的主配置配置文件，并返回该文件的输入流，我们知道Mybatis所有的SQL语句都写在XML配置文件里面,所以第一步就需要读取这些XML配置文件，这个不难理解，关键是读取文件后怎么存放。

 

我们接着看第三行代码（如下），该代码主要是读取配置文件流并将这些配置信息存放到Configuration类中。

Java代码  

1. SqlSessionFactory ssf = new SqlSessionFactoryBuilder().build(reader);  

 

 

SqlSessionFactoryBuilder的build的方法如下:

Java代码  

1. public SqlSessionFactory build(Reader reader) {  
2.     return build(reader, null, null);  
3.   }  

 

其实是调用该类的另一个build方法来执行的,具体代码如下:

Java代码  

1. public SqlSessionFactory build(Reader reader, String environment, Properties properties) {  
2.   
3.     try {  
4.   
5.       XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);  
6.   
7.       return build(parser.parse());  
8.   
9.     } catch (Exception e) {  
10.   
11.       throw ExceptionFactory.wrapException("Error building SqlSession.", e);  
12.   
13.     } finally {  
14.   
15.       ErrorContext.instance().reset();  
16.   
17.       try {  
18.   
19.         reader.close();  
20.   
21.       } catch (IOException e) {  
22.   
23.         // Intentionally ignore. Prefer previous error.  
24.   
25.       }  
26.   
27.     }  
28.   
29.   }  

 

我们重点看一下里面两行:

Java代码  

1. //创建一个配置文件流的解析对象XMLConfigBuilder,其实这里是将环境和配置文件流赋予解析类  
2. XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);  
3.   
4. // 解析类对配置文件进行解析并将解析的内容存放到Configuration对象中,并返回SqlSessionFactory  
5. return build(parser.parse());  

 

这里的XMLConfigBuilder初始化其实调用的代码如下: 

Java代码  

1. private XMLConfigBuilder(XPathParser parser, String environment, Properties props) {  
2.     super(new Configuration());  
3.   
4.     ErrorContext.instance().resource("SQL Mapper Configuration");  
5.   
6.     this.configuration.setVariables(props);  
7.   
8.     this.parsed = false;  
9.   
10.     this.environment = environment;  
11.   
12.     this.parser = parser;   
13.   
14.   }  

 

 

 XMLConfigBuilder的parse方法执行代码如下:  

Java代码  

1. public Configuration parse() {  
2.   
3.     if (parsed) {  
4.   
5.       throw new BuilderException("Each MapperConfigParser can only be used once.");  
6.   
7.     }  
8.   
9.     parsed = true;  
10.   
11.     parseConfiguration(parser.evalNode("/configuration"));  
12.   
13.     return configuration;  
14.   
15.   }  

 

解析的内容主要是在parseConfiguration方法中,它主要完成的工作是读取配置文件的各个节点,然后将这些数据映射到内存配置对象Configuration中,我们看一下parseConfiguration方法内容: 

Java代码  

1. private void parseConfiguration(XNode root) {  
2.   
3.     try {  
4.   
5.       typeAliasesElement(root.evalNode("typeAliases"));  
6.   
7.       pluginElement(root.evalNode("plugins"));  
8.   
9.       objectFactoryElement(root.evalNode("objectFactory"));  
10.   
11.       objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));  
12.   
13.       propertiesElement(root.evalNode("properties"));  
14.   
15.       settingsElement(root.evalNode("settings"));  
16.   
17.       environmentsElement(root.evalNode("environments"));  
18.   
19.       typeHandlerElement(root.evalNode("typeHandlers"));  
20.   
21.       mapperElement(root.evalNode("mappers"));  
22.   
23.     } catch (Exception e) {  
24.   
25.       throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);  
26.   
27.     }  
28.   
29.   }  

 

 

最后的build方法其实是传入配置对象进去,创建DefaultSqlSessionFactory实例出来. DefaultSqlSessionFactory是SqlSessionFactory的默认实现. 

Java代码  

1. public SqlSessionFactory build(Configuration config) {  
2.     return new DefaultSqlSessionFactory(config);  
3. }  

   

 最后我们看一下第四行代码： 

Java代码  

1. SqlSession session = ssf.openSession();  

 

通过调用DefaultSqlSessionFactory的openSession方法返回一个SqlSession实例,我们看一下具体是怎么得到一个SqlSession实例的。首先调用openSessionFromDataSource方法。  

Java代码  

1. public SqlSession openSession() {  
2.     return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);  
3. }  

 

 下面我们看一下openSessionFromDataSource方法的逻辑：  

Java代码  

1. private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {  
2.     Connection connection = null;  
3.   
4. try {  
5.   
6. //获取配置信息里面的环境信息，这些环境信息都是包括使用哪种数据库，连接数据库的信息，事务  
7. final Environment environment = configuration.getEnvironment();  
8.   
9. //根据环境信息关于数据库的配置获取数据源  
10. final DataSource dataSource = getDataSourceFromEnvironment(environment);  
11.   
12. //根据环境信息关于事务的配置获取事务工厂  
13. TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);  
14.   
15.       connection = dataSource.getConnection();  
16.   
17.       if (level != null) {  
18.   
19.         //设置连接的事务隔离级别  
20.       connection.setTransactionIsolation(level.getLevel());  
21.       }  
22.   
23.       //对connection进行包装，使连接具备日志功能，这里用的是代理。  
24.       connection = wrapConnection(connection);  
25.   
26.       //从事务工厂获取一个事务实例  
27. 以上是关于MyBatis原理分析之三：初始化（配置文件读取和解析）的主要内容，如果未能解决你的问题，请参考以下文章

    Mybatis工作原理（含部分源码）

    mybatis的工作原理

    MyBatis原理简介和小试牛刀

    你分析过mybatis工作原理吗？

    Mybatis实现 --文件夹

    mybatis源码配置文件解析之四：解析plugins标签