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

1. 准备工作

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

Java代码  

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

2.源码分析

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

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

Java代码  

1. String resource = "mybatis.cfg.xml";
2. 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. try {
3. XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
4. return build(parser.parse());
5. } catch (Exception e) {
6. throw ExceptionFactory.wrapException("Error building SqlSession.", e);
7. } finally {
8. ErrorContext.instance().reset();
9. try {
10. reader.close();
11. } catch (IOException e) {
12. // Intentionally ignore. Prefer previous error.
13. }
14. }
15. }

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

Java代码  

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

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

Java代码  

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

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

Java代码  

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

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

Java代码  

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

最后的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. try {
4. //获取配置信息里面的环境信息，这些环境信息都是包括使用哪种数据库，连接数据库的信息，事务
5. final Environment environment = configuration.getEnvironment();
6. //根据环境信息关于数据库的配置获取数据源
7. final DataSource dataSource = getDataSourceFromEnvironment(environment);
8. //根据环境信息关于事务的配置获取事务工厂
9. TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
10. connection = dataSource.getConnection();
11. if (level != null) {
12. //设置连接的事务隔离级别
13. connection.setTransactionIsolation(level.getLevel());
14. }
15. //对connection进行包装，使连接具备日志功能，这里用的是代理。
16. connection = wrapConnection(connection);
17. //从事务工厂获取一个事务实例
18. Transaction tx = transactionFactory.newTransaction(connection, autoCommit);
19. //从配置信息中获取一个执行器实例
20. Executor executor = configuration.newExecutor(tx, execType);
21. //返回SqlSession的一个默认实例
22. return new DefaultSqlSession(configuration, executor, autoCommit);
23. } catch (Exception e) {
24. closeConnection(connection);
25. throw ExceptionFactory.wrapException("Error opening session.  Cause: " + e, e);
26. } finally {
27. ErrorContext.instance().reset();
28. }
29. }

传入参数说明：

（1）ExecutorType：执行类型，ExecutorType主要有三种类型：SIMPLE, REUSE, BATCH，默认是SIMPLE，都在枚举类ExecutorType里面。

（2）TransactionIsolationLevel：事务隔离级别，都在枚举类TransactionIsolationLevel中定义。

（3）autoCommit：是否自动提交，主要是事务提交的设置。

DefaultSqlSession是SqlSession的实现类，该类主要提供操作数据库的方法给开发人员使用。

这里总结一下上面的过程，总共由三个步骤：

步骤一：读取Ibatis的主配置文件，并将文件读成文件流形式(InputStream)。

步骤二：从主配置文件流中读取文件的各个节点信息并存放到Configuration对象中。读取mappers节点的引用文件，并将这些文件的各个节点信息存放到Configuration对象。

步骤三：根据Configuration对象的信息获取数据库连接，并设置连接的事务隔离级别等信息，将经过包装数据库连接对象SqlSession接口返回，DefaultSqlSession是SqlSession的实现类，所以这里返回的是DefaultSqlSession，SqlSession接口里面就是对外提供的各种数据库操作。

来源： http://chenjc-it.iteye.com/blog/1409984

null