MyBatis - 初始化（八）加载 mybatis-config.xml

偏执的太偏执、 2023-01-02 15:26 116阅读 0赞

# MyBatis - 初始化（八）加载 mybatis-config.xml #

> 该系列文档是本人在学习 Mybatis 的源码过程中总结下来的，可能对各位读者会不太友好，阅读前需要对 MyBatis 和 Spring 有一定的了解。比较适合刚接触，会使用但是一直没去探究底层的同学。
> 
> MyBatis 版本：3.5.6
> 
> MyBatis-Spring 版本：2.0.3
> 
> MyBatis-Spring-Boot-Starter 版本：2.1.4
> 
> 该系列其他文档请查看：[**《 MyBatis 系列 - 导读》**][MyBatis _ -]

## 一、MyBatis的初始化 ##

在MyBatis初始化过程中，大致会有以下几个步骤：

1.  创建`Configuration`全局配置对象，会往`TypeAliasRegistry`别名注册中心添加Mybatis需要用到的相关类，并设置默认的语言驱动类为`XMLLanguageDriver`
2.  加载`mybatis-config.xml`配置文件、Mapper接口中的注解信息和XML映射文件，解析后的配置信息会形成相应的对象并保存到Configuration全局配置对象中
3.  构建`DefaultSqlSessionFactory`对象，通过它可以创建`DefaultSqlSession`对象，MyBatis中`SqlSession`的默认实现类

因为整个初始化过程涉及到的代码比较多，所以拆分成了四个模块依次对MyBatis的初始化进行分析：

*  [**《MyBatis - 初始化（八）加载 mybatis-config.xml 》** ][MyBatis - _ mybatis-config.xml _]
 *  [**《MyBatis - 初始化（九）加载Mapper接口与XML映射文件》**][MyBatis - _Mapper_XML]
 *  [**《MyBatis - 初始化（十）SQL初始化（上）》**][MyBatis - _SQL]
 *  [**《MyBatis - 初始化（十一）SQL初始化（下）》**][MyBatis - _SQL 1]

由于在MyBatis的初始化过程中去解析Mapper接口与XML映射文件涉及到的篇幅比较多，XML映射文件的解析过程也比较复杂，所以才分成了后面三个模块，逐步分析，这样便于理解

## 初始化（一）之加载mybatis-config.xml ##

本文主要分享的是在MyBatis初始化过程中，是如何加载`mybatis-config.xml`配置文件的，配置描述请参考：[MyBatis官方文档的配置说明][MyBatis]

初始化入口在`org.apache.ibatis.session.SqlSessionFactoryBuilder`构造器中，因为需要通过`mybatis-config.xml`配置文件构建一个SqlSessionFactory工厂，用于创建SqlSession会话

主要涉及到以下几个类：

*  `org.apache.ibatis.session.SqlSessionFactoryBuilder`：用于构建SqlSessionFactory工厂
 *  `org.apache.ibatis.builder.xml.XMLConfigBuilder`：根据配置文件进行解析，开始Mapper接口与XML映射文件的初始化，生成Configuration全局配置对象
 *  `org.apache.ibatis.builder.xml.XMLMapperBuilder`：继承BaseBuilder抽象类，用于解析XML映射文件内的标签
 *  `org.apache.ibatis.session.Configuration`：MyBatis的全局配置对象，保存所有的配置与初始化过程所产生的对象

### SqlSessionFactoryBuilder ###

`org.apache.ibatis.session.SqlSessionFactoryBuilder`：构建SqlSessionFactory工厂类，里面定义了许多build重载方法，主要分为处理Reader和InputStream两种文件资源对象

我们来看看其中的一个`build`方法：

public class SqlSessionFactoryBuilder { 
    
    	public SqlSessionFactory build(Reader reader) { 
    		return build(reader, null, null);
    	}
    
    	/** * 构造 SqlSessionFactory 对象 * * @param reader Reader 对象 * @param environment 环境 * @param properties Properties 变量 * @return SqlSessionFactory 对象 */
    	public SqlSessionFactory build(Reader reader, String environment, Properties properties) { 
    		try { 
    			/* * <1> 创建 XMLConfigBuilder 对象 * 会生成一个 XPathParser，包含 Document 对象 * 会创建一个 Configuration 全局配置对象 */
    			XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
    			/* * <2> 解析 XML 文件并配置到 Configuration 全局配置对象中 * <3> 创建 DefaultSqlSessionFactory 对象 */
    			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.
    			}
    		}
    	}
    }

`build`方法主要做了三件事：

1.  创建`XMLConfigBuilder`对象，生成`XPathParser`配置文件解析器对象和`Configuration`全局配置对象
2.  通过`XMLConfigBuilder`对象解析XML映射文件，配置信息、生成的相应对象都会保存至`Configuration`全局配置对象中
3.  构建一个`DefaultSqlSessionFactory`对象

### XMLConfigBuilder ###

`org.apache.ibatis.builder.xml.XMLConfigBuilder`：根据配置文件进行解析，开始Mapper接口与XML映射文件的初始化，生成Configuration全局配置对象

#### 构造方法 ####

public XMLConfigBuilder(Reader reader, String environment, Properties props) { 
        this(new XPathParser(reader, true, props, new XMLMapperEntityResolver()), environment, props);
    }
    private XMLConfigBuilder(XPathParser parser, String environment, Properties props) { 
        // <1> 创建 Configuration 对象
        super(new Configuration());
        // 创建一个当前线程的上下文，记录错误信息
        ErrorContext.instance().resource("SQL Mapper Configuration");
        // <2> 设置 Configuration 的 variables 属性
        this.configuration.setVariables(props);
        this.parsed = false;
        this.environment = environment;
        this.parser = parser;
    }

1.  首先会进入`XPathParser`的构造方法，将XML配置文件解析成`org.w3c.dom.Document`对象，这里传入了`XMLMapperEntityResolver`作为解析实例对象，其中使用到MyBatis本地的DTD文件
2.  然后进入`XMLConfigBuilder`的另一个构造方法，会先创建一个Configuration全局配置对象，初始化一些对象

#### parse方法 ####

public Configuration parse() { 
        // <1.1> 若已解析，抛出 BuilderException 异常
        if (parsed) { 
            throw new BuilderException("Each XMLConfigBuilder can only be used once.");
        }
        // <1.2> 标记已解析
        parsed = true;
        // <2> 解析 XML configuration 节点
        parseConfiguration(parser.evalNode("/configuration"));
        return configuration;
    }
    private void parseConfiguration(XNode root) { 
        try { 
            // issue #117 read properties first
            // <1> 解析 <properties /> 标签
            propertiesElement(root.evalNode("properties"));
            // <2> 解析 <settings /> 标签，解析配置生成 Properties 对象
            Properties settings = settingsAsProperties(root.evalNode("settings"));
            // 根据配置加载自定义 VFS 实现类
            loadCustomVfs(settings);
            // 根据配置加载自定义的 Log 实现类
            loadCustomLogImpl(settings);
            // <3> 解析 <typeAliases /> 标签，生成别名与类的映射关系
            typeAliasesElement(root.evalNode("typeAliases"));
            // <4> 解析 <plugins /> 标签，添加自定义拦截器插件
            pluginElement(root.evalNode("plugins"));
            // <5> 解析 <objectFactory /> 标签，自定义实例工厂
            objectFactoryElement(root.evalNode("objectFactory"));
            // <6> 解析 <objectWrapperFactory /> 标签，自定义 ObjectWrapperFactory 工厂，无默认实现
            objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
            // <7> 解析 <reflectorFactory /> 标签，自定义 Reflector 工厂
            reflectorFactoryElement(root.evalNode("reflectorFactory"));
            // 将 <settings /> 配置信息添加到 Configuration 属性
            settingsElement(settings);
            // read it after objectFactory and objectWrapperFactory issue #631
            // <8> 解析 <environments /> 标签，自定义当前环境信息
            environmentsElement(root.evalNode("environments"));
            // <9> 解析 <databaseIdProvider /> 标签，数据库标识符
            databaseIdProviderElement(root.evalNode("databaseIdProvider"));
            // <10> 解析 <typeHandlers /> 标签，自定义类型处理器
            typeHandlerElement(root.evalNode("typeHandlers"));
            // <11> 解析 <mappers /> 标签，扫描Mapper接口并进行解析
            mapperElement(root.evalNode("mappers"));
        } catch (Exception e) { 
            throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
        }
    }

在`parse()`解析方法中，获取到Document对象的`<configuration />`节点，然后调用`parseConfiguration`进行解析，依次解析以下标签：

`<1>`解析`<properties />`标签，调用`propertiesElement`方法

`<2>`解析`<settings />`标签，解析配置生成 Properties 对象，调用`settingsAsProperties`方法

`<3>`解析`<typeAliases />`标签，生成别名与类的映射关系，调用`typeAliasesElement`方法

`<4>`解析`<plugins />`标签，添加自定义拦截器插件，调用`pluginElement`方法

`<5>`解析`<objectFactory />`标签，自定义实例工厂，调用`objectFactoryElement`方法

`<6>`解析`<objectWrapperFactory />`标签，自定义 ObjectWrapperFactory 工厂，调用`objectWrapperFactoryElement`方法

`<7>`解析`<reflectorFactory />`标签，自定义 Reflector 工厂，调用`reflectorFactoryElement`方法

`<8>`解析`<environments />`标签，自定义当前环境信息，调用`environmentsElement`方法

`<9>`解析`<databaseIdProvider />`标签，数据库标识符，调用`databaseIdProviderElement`方法

`<10>`解析`<typeHandlers />`标签，自定义类型处理器，调用`typeHandlerElement`方法

`<11>`解析`<mappers />`标签，扫描Mapper接口并进行解析，调用`mapperElement`方法

关于MyBatis的配置描述请参考[MyBatis官方文档的配置说明][MyBatis]

上面涉及到的解析方法就不一一列出来了，这里做个简单的描述，具体请阅读这个类

#### propertiesElement方法 ####

1.  解析 `<properties />` 标签，成 Properties 对象。
2.  覆盖 `configuration` 中的 Properties 对象到上面的结果。
3.  设置结果到 `parser` 和 `configuration` 中。

#### settingsAsProperties方法 ####

1.  将 `<setting />` 标签解析为 Properties 对象
2.  接下来会根据该属性对象加载用户自定义的VFS实现类和Log实现类，并将配置信息配置到Configuration全局配置对象中

#### typeAliasesElement方法 ####

1.  对 `<typeAliases />` 的子标签进行解析
2.  如果是`<package />`字标签，则对其配置的name包名进行解析，将别名去Class对象进行映射往TypeAliasRegistry注册，调用`TypeAliasRegistry.registerAliases`方法
3.  否则就是配置的单个别名配置，进行解析并添加到TypeAliasRegistry中

#### pluginElement方法 ####

1.  对`<plugins />` 的子标签进行解析
2.  生成对应的Interceptor拦截器对象并设置配置的属性
3.  将拦截器添加到 Configuration 全局配置的 InterceptorChain 拦截器调用链中，后续会讲到，例如`com.github.pagehelper.PageInterceptor`分页插件

#### mapperElement方法 ####

在该方法中会解析Mapper接口，创建对应的MapperProxyFactory动态代理工厂，同时也会解析Mapper接口对应的XML映射文件

整个的解析过程涉及到的代码有点多，在下一个模块[**《MyBatis - 初始化（九）加载Mapper接口与XML映射文件》**][MyBatis - _Mapper_XML]中进行分析

### Configuration ###

`org.apache.ibatis.session.Configuration`：MyBatis的全局配置对象，保存所有的配置与初始化过程所产生的对象，内容有点多，这里就不列出来了，参考：[Configuration.java][]

### 总结 ###

MyBatis会在`SqlSessionFactoryBuilder`构造器中根据`mybatis-config.xml`配置文件初始化`Configuration`全局配置对象，然后创建对应的`DefaultSqlSessionFactory`工厂

在解析配置文件的过程中，MyBatis的配置都会保存在`Configuration`对象中，对Mapper接口和XML映射文件进行解析生成相应的对象都会保存在其中

参考文章：[《MyBatis 源码分析》][MyBatis 1]

\--------------最后感谢大家的阅读，愿大家技术越来越流弊！--------------

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo_size_16_color_FFFFFF_t_70]

\--------------也希望大家给我点支持，谢谢各位大佬了！！！--------------

[MyBatis _ -]: https://blog.csdn.net/Zack_tzh/article/details/112189633
[MyBatis - _ mybatis-config.xml _]: https://blog.csdn.net/Zack_tzh/article/details/112270507
[MyBatis - _Mapper_XML]: https://blog.csdn.net/Zack_tzh/article/details/112270581
[MyBatis - _SQL]: https://blog.csdn.net/Zack_tzh/article/details/112270630
[MyBatis - _SQL 1]: https://blog.csdn.net/Zack_tzh/article/details/112270717
[MyBatis]: https://mybatis.org/mybatis-3/zh/configuration.html
[Configuration.java]: https://github.com/liu844869663/mybatis-3/blob/master/src/main/java/org/apache/ibatis/session/Configuration.java
[MyBatis 1]: http://svip.iocoder.cn/categories/MyBatis/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1phY2tfdHpo_size_16_color_FFFFFF_t_70]: /images/20221119/b89b4df128a345c5b66dcc1bc6389efe.png