java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > MyBatis 配置加载

MyBatis实现配置加载的步骤

作者：半夏之沫

本文主要介绍了MyBatis实现配置加载的步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

前言

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

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

正文

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

InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

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

实际上，基于配置文件字符流和基于配置文件字节流构建的方式，最终都是将字符流或字节流解析并生成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类
        XMLConfigBuilder parser = new XMLConfigBuilder(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的类图，如下所示。

XMLConfigBuilder类图

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

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

public Configuration parse() {
    if (parsed) {
        throw new BuilderException("Each XMLConfigBuilder can only be used once.");
    }
    parsed = true;
    parseConfiguration(parser.evalNode("/configuration"));
    return configuration;
}

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

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <setting name="useGeneratedKeys" value="true"/>
    </settings>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/test?characterEncoding=utf-8&amp;serverTimezone=UTC&amp;useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <package name="com.mybatis.learn.dao"/>
    </mappers>
</configuration>

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

private void parseConfiguration(XNode root) {
    try {
        propertiesElement(root.evalNode("properties"));
        Properties settings = 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) {
        throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
}

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

public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
}

DefaultSqlSessionFactory类图如下所示。

DefaultSqlSessionFactory类图

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

总结

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

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

到此这篇关于MyBatis实现配置加载的步骤的文章就介绍到这了,更多相关MyBatis 配置加载内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文