MyBatis原理分析之三:初始化(配置文件读取和解析)
Posted 竹山一叶
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了MyBatis原理分析之三:初始化(配置文件读取和解析)相关的知识,希望对你有一定的参考价值。
1. 准备工作
编写测试代码(具体请参考《Mybatis入门示例》),设置断点,以Debug模式运行,具体代码如下:
- String resource = "mybatis.cfg.xml";
- Reader reader = Resources.getResourceAsReader(resource);
- SqlSessionFactory ssf = new SqlSessionFactoryBuilder().build(reader);
- SqlSession session = ssf.openSession();
2.源码分析
我们此次就对上面的代码进行跟踪和分析,let\'s go。
首先我们按照顺序先看看第一行和第二行代码,看看它主要完成什么事情:
读取Mybaits的主配置配置文件,并返回该文件的输入流,我们知道Mybatis所有的SQL语句都写在XML配置文件里面,所以第一步就需要读取这些XML配置文件,这个不难理解,关键是读取文件后怎么存放。
我们接着看第三行代码(如下),该代码主要是读取配置文件流并将这些配置信息存放到Configuration类中。
- SqlSessionFactory ssf = new SqlSessionFactoryBuilder().build(reader);
SqlSessionFactoryBuilder的build的方法如下:
其实是调用该类的另一个build方法来执行的,具体代码如下:
- public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
- try {
- XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
- return build(parser.parse());
- } catch (Exception e) {
- throw ExceptionFactory.wrapException("Error building SqlSession.", e);
- } finally {
- ErrorContext.instance().reset();
- try {
- reader.close();
- } catch (IOException e) {
- // Intentionally ignore. Prefer previous error.
- }
- }
- }
我们重点看一下里面两行:
这里的XMLConfigBuilder初始化其实调用的代码如下:
- private XMLConfigBuilder(XPathParser parser, String environment, Properties props) {
- super(new Configuration());
- ErrorContext.instance().resource("SQL Mapper Configuration");
- this.configuration.setVariables(props);
- this.parsed = false;
- this.environment = environment;
- this.parser = parser;
- }
XMLConfigBuilder的parse方法执行代码如下:
- public Configuration parse() {
- if (parsed) {
- throw new BuilderException("Each MapperConfigParser can only be used once.");
- }
- parsed = true;
- parseConfiguration(parser.evalNode("/configuration"));
- return configuration;
- }
解析的内容主要是在parseConfiguration方法中,它主要完成的工作是读取配置文件的各个节点,然后将这些数据映射到内存配置对象Configuration中,我们看一下parseConfiguration方法内容:
- private void parseConfiguration(XNode root) {
- try {
- typeAliasesElement(root.evalNode("typeAliases"));
- pluginElement(root.evalNode("plugins"));
- objectFactoryElement(root.evalNode("objectFactory"));
- objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
- propertiesElement(root.evalNode("properties"));
- settingsElement(root.evalNode("settings"));
- environmentsElement(root.evalNode("environments"));
- typeHandlerElement(root.evalNode("typeHandlers"));
- mapperElement(root.evalNode("mappers"));
- } catch (Exception e) {
- throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
- }
- }
- public SqlSessionFactory build(Configuration config) {
- return new DefaultSqlSessionFactory(config);
- }
最后我们看一下第四行代码:
- SqlSession session = ssf.openSession();
通过调用DefaultSqlSessionFactory的openSession方法返回一个SqlSession实例,我们看一下具体是怎么得到一个SqlSession实例的。首先调用openSessionFromDataSource方法。
- public SqlSession openSession() {
- return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
- }
下面我们看一下openSessionFromDataSource方法的逻辑:
- private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
- Connection connection = null;
- try {
- //获取配置信息里面的环境信息,这些环境信息都是包括使用哪种数据库,连接数据库的信息,事务
- final Environment environment = configuration.getEnvironment();
- //根据环境信息关于数据库的配置获取数据源
- final DataSource dataSource = getDataSourceFromEnvironment(environment);
- //根据环境信息关于事务的配置获取事务工厂
- TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
- connection = dataSource.getConnection();
- if (level != null) {
- //设置连接的事务隔离级别
- connection.setTransactionIsolation(level.getLevel());
- }
- //对connection进行包装,使连接具备日志功能,这里用的是代理。
- connection = wrapConnection(connection);
- //从事务工厂获取一个事务实例
- 以上是关于MyBatis原理分析之三:初始化(配置文件读取和解析)的主要内容,如果未能解决你的问题,请参考以下文章