MyBatis實現(xiàn)配置加載的步驟

更新時間：2023年05月11日 10:09:38 作者：半夏之沫

本文主要介紹了MyBatis實現(xiàn)配置加載的步驟，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

前言

在原始MyBatis的使用中，使用MyBatis時會先讀取配置文件mybatis-config.xml為字符流或者字節(jié)流，然后通過SqlSessionFactoryBuilder基于配置文件的字符流或字節(jié)流來構建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下指定名字的文件為字符流或者字節(jié)流，這里是使用了其提供的getResourceAsStream() 方法將mybatis-config.xml 文件讀取為字節(jié)流。SqlSessionFactoryBuilder是一個建造者，其提供了共計9個重載的build() 方法用于構建SqlSessionFactory，這9個build() 方法可以分為三類，概括如下。

基于配置文件字符流構建SqlSessionFactory；
基于配置文件字節(jié)流構建SqlSessionFactory；
基于Configuration類構建SqlSessionFactory。

實際上，基于配置文件字符流和基于配置文件字節(jié)流構建的方式，最終都是將字符流或字節(jié)流解析并生成Configuration類，然后基于Configuration類構建SqlSessionFactory。

下面以基于配置文件字節(jié)流構建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) {
        }
    }
}

可以發(fā)現(xiàn)，配置文件的解析是發(fā)生在XMLConfigBuilder的parse() 方法中，在查看parse() 方法前，先看一下XMLConfigBuilder的類圖，如下所示。

XMLConfigBuilder類圖

通過XMLConfigBuilder的類圖可以知道，XMLConfigBuilder解析配置文件是依靠XPathParser，而XPathParser是MyBatis提供的基于JAVA XPath的解析器。同時，XMLConfigBuilder內部維護了一個Configuration，通過XPathParser解析配置文件得到的配置屬性均會豐富到Configuration中。

現(xiàn)在開始分析XMLConfigBuilder的parse() 方法，其實現(xiàn)如下所示。

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節(jié)點（根節(jié)點），然后將configuration節(jié)點傳入parseConfiguration() 方法，接著在parseConfiguration() 方法中會根據傳入的configuration節(jié)點依次獲取子節(jié)點并讀取子節(jié)點屬性，最后將獲取到的屬性豐富進Configuration。parseConfiguration() 方法實現(xiàn)如下所示。

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創(chuàng)建DefaultSqlSessionFactory并返回，如下所示。

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

DefaultSqlSessionFactory類圖如下所示。

DefaultSqlSessionFactory類圖

至此，讀取配置文件mybatis-config.xml和構建SqlSessionFactory的基本原理已經介紹完畢。

總結

本篇文章對MyBatis讀取配置文件并構建SqlSessionFactory的一個整體流程進行了介紹，可以概括如下。

Resources工具類獲取配置文件輸入字符流或字節(jié)流；
創(chuàng)建SqlSessionFactoryBuilder；
SqlSessionFactoryBuilder中會創(chuàng)建XMLConfigBuilder來解析配置文件得到全局唯一的Configuration；
基于Configuration創(chuàng)建DefaultSqlSessionFactory。

實際上，關于MyBatis配置文件的讀取，最關鍵的部分在于如何注冊映射文件/映射接口，該部分內容，會在后面的文章中進行學習。

到此這篇關于MyBatis實現(xiàn)配置加載的步驟的文章就介紹到這了,更多相關MyBatis 配置加載內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: