浅析MyBatis的配置加载流程

野性酷女 2023-09-24 20:31 26阅读 0赞

![format_png][]

### 前言 ###

--------------------

在原始**MyBatis**的使用中，使用**MyBatis**时会先读取配置文件**mybatis-config.xml**为字符流或者字节流，然后通过**SqlSessionFactoryBuilder**基于配置文件的字符流或字节流来构建**SqlSessionFactory**。

本篇文章将结合**MyBatis**源码，对读取配置文件**mybatis-config.xml**和构建**SqlSessionFactory**的原理进行学习。

### 正文 ###

--------------------

原始**MyBatis**读取配置文件**mybatis-config.xml**和构建**SqlSessionFactory**的一个示例如下。

InputStreaminputStream= Resources.getResourceAsStream("mybatis-config.xml");
    SqlSessionFactorysqlSessionFactory=newSqlSessionFactoryBuilder().build(inputStream);
    复制代码

上述示例中的**Resources**工具类提供了方法可以读取**classpath**下指定名字的文件为字符流或者字节流，这里是使用了其提供的**getResourceAsStream()** 方法将**mybatis-config.xml** 文件读取为字节流。**SqlSessionFactoryBuilder**是一个建造者，其提供了共计9个重载的**build()** 方法用于构建**SqlSessionFactory**，这9个**build()** 方法可以分为三类，概括如下。

1.  基于配置文件**字符流**构建**SqlSessionFactory**；

1.  基于配置文件**字节流**构建**SqlSessionFactory**；

1.  基于**Configuration**类构建**SqlSessionFactory**。

实际上，基于配置文件字符流和基于配置文件字节流构建的方式，最终都是将字符流或字节流解析并生成**Configuration**类，然后基于**Configuration**类构建**SqlSessionFactory**。

下面以基于配置文件字节流构建**SqlSessionFactory**的过程为例，对整个读配置文件的流程进行说明。上面的示例中调用的**build()** 方法如下所示。

public SqlSessionFactory build(InputStream inputStream) {
        return build(inputStream, null, null);
    }
    复制代码

上面被调用的重载的**build()** 方法如下所示。

public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
        try {
            // XMLConfigBuilder会解析配置文件并生成Configuration类XMLConfigBuilderparser=newXMLConfigBuilder(inputStream, environment, properties);
            // 调用入参为Configuration的build()方法构建SqlSessionFactory并返回return build(parser.parse());
        } catch (Exception e) {
            throw ExceptionFactory.wrapException("Error building SqlSession.", e);
        } finally {
            ErrorContext.instance().reset();
            try {
                inputStream.close();
            } catch (IOException e) {
    
            }
        }
    }
    复制代码

可以发现，配置文件的解析是发生在**XMLConfigBuilder**的**parse()** 方法中，在查看**parse()** 方法前，先看一下**XMLConfigBuilder**的类图，如下所示。

![format_png 1][]

通过**XMLConfigBuilder**的类图可以知道，**XMLConfigBuilder**解析配置文件是依靠**XPathParser**，而**XPathParser**是**MyBatis**提供的基于**JAVA XPath**的解析器。同时，**XMLConfigBuilder**内部维护了一个**Configuration**，通过**XPathParser**解析配置文件得到的配置属性均会丰富到**Configuration**中。

现在开始分析**XMLConfigBuilder**的**parse()** 方法，其实现如下所示。

public Configuration parse() {
        if (parsed) {
            thrownewBuilderException("Each XMLConfigBuilder can only be used once.");
        }
        parsed = true;
        parseConfiguration(parser.evalNode("/configuration"));
        return configuration;
    }
    复制代码

要理解**parse()** 方法，最好是和一个实际的配置文件进行对照，如下给出一个实际的配置文件。

<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE configurationPUBLIC"-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd"><configuration><settings><settingname="useGeneratedKeys"value="true"/></settings><environmentsdefault="development"><environmentid="development"><transactionManagertype="JDBC"/><dataSourcetype="POOLED"><propertyname="driver"value="com.mysql.cj.jdbc.Driver"/><propertyname="url"value="jdbc:mysql://localhost:3306/test?characterEncoding=utf-8&serverTimezone=UTC&useSSL=false"/><propertyname="username"value="root"/><propertyname="password"value="root"/></dataSource></environment></environments><mappers><packagename="com.mybatis.learn.dao"/></mappers></configuration>复制代码

所以在**parse()** 方法中，首先是获取配置文件的**configuration**节点（根节点），然后将**configuration**节点传入**parseConfiguration()** 方法，接着在**parseConfiguration()** 方法中会根据传入的**configuration**节点依次获取子节点并读取子节点属性，最后将获取到的属性丰富进**Configuration**。**parseConfiguration()** 方法实现如下所示。

privatevoidparseConfiguration(XNode root) {
        try {
            propertiesElement(root.evalNode("properties"));
            Propertiessettings= settingsAsProperties(root.evalNode("settings"));
            loadCustomVfs(settings);
            loadCustomLogImpl(settings);
            typeAliasesElement(root.evalNode("typeAliases"));
            pluginElement(root.evalNode("plugins"));
            objectFactoryElement(root.evalNode("objectFactory"));
            objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
            reflectorFactoryElement(root.evalNode("reflectorFactory"));
            settingsElement(settings);
            // 丰富environments标签及其子标签的属性到Configuration中
            environmentsElement(root.evalNode("environments"));
            databaseIdProviderElement(root.evalNode("databaseIdProvider"));
            typeHandlerElement(root.evalNode("typeHandlers"));
            // 丰富mappers标签的属性到Configuration中
            mapperElement(root.evalNode("mappers"));
        } catch (Exception e) {
            thrownewBuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
        }
    }
    复制代码

最后**parse()** 方法会返回**Configuration**，**SqlSessionFactoryBuilder**会基于**Configuration**创建**DefaultSqlSessionFactory**并返回，如下所示。

public SqlSessionFactory build(Configuration config) {
        returnnewDefaultSqlSessionFactory(config);
    }
    复制代码

**DefaultSqlSessionFactory**类图如下所示。

![format_png 2][]

至此，读取配置文件**mybatis-config.xml**和构建**SqlSessionFactory**的基本原理已经介绍完毕。

### 总结 ###

--------------------

本篇文章对**MyBatis**读取配置文件并构建**SqlSessionFactory**的一个整体流程进行了介绍，可以概括如下。

1.  **Resources**工具类获取配置文件输入字符流或字节流；

1.  创建**SqlSessionFactoryBuilder**；

1.  **SqlSessionFactoryBuilder**中会创建**XMLConfigBuilder**来解析配置文件得到**全局唯一**的**Configuration**；

1.  基于**Configuration**创建**DefaultSqlSessionFactory**。

实际上，关于**MyBatis**配置文件的读取，最关键的部分在于如何注册**映射文件/映射接口**，该部分内容，会在后面的文章中进行学习。

[format_png]: https://img-blog.csdnimg.cn/img_convert/6784fcb66e9522c8fab3508942261db3.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/f107c6a4780b9958bdcc866d23c31583.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/c6965816ddf34d5ca8500d58f4f0bfd2.webp?x-oss-process=image/format,png