MyBatis 源码解析：XMLConfigBuilder 解析过程

原创

于 2024-08-26 23:38:39 发布 · 1.2k 阅读

26 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis #java

前言

在 MyBatis 框架中，XMLConfigBuilder 是一个关键类，负责解析 mybatis-config.xml 配置文件。理解这个类的工作原理有助于掌握 MyBatis 的配置管理和框架初始化过程。本篇文章将通过自定义实现一个简化版的 XML 配置解析器，并深入解析 MyBatis 中 XMLConfigBuilder 的实现细节。

自定义实现：简化版 XML 配置解析器

目标与功能

我们将实现一个简化版的 XML 配置解析器，主要功能是解析 <properties> 和 <settings> 节点，并生成一个基本的配置对象。这个实现将帮助我们理解 MyBatis 的配置解析过程，为后续的源码解读打下基础。

XML 样例

在开始实现之前，我们先来看一个典型的 mybatis-config.xml 文件的片段：

<?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>
    <properties resource="db.properties">
        <property name="username" value="root"/>
        <property name="password" value="password"/>
    </properties>

    <settings>
        <setting name="cacheEnabled" value="true"/>
        <setting name="lazyLoadingEnabled" value="false"/>
    </settings>
</configuration>

<properties> 节点：加载外部的属性文件或定义属性。
<settings> 节点：定义 MyBatis 的全局设置，如缓存启用和懒加载等。

实现过程

1. 定义解析器类

首先，我们创建一个名为 SimpleXMLConfigParser 的类，用于处理 XML 文件的解析。类中定义了两个 Map，分别用于存储 <properties> 和 <settings> 节点的内容。

import org.w3c.dom.*;
import javax.xml.parsers.*;
import java.io.File;
import java.util.HashMap;
import java.util.Map;

public class SimpleXMLConfigParser {
   
   
    private Map<String, String> properties = new HashMap<>();  // 存储 <properties> 节点内容
    private Map<String, String> settings = new HashMap<>();    // 存储 <settings> 节点内容

2. 加载与解析 XML 文件

我们编写 parse 方法，该方法负责加载 XML 文件并依次解析 <properties> 和 <settings> 节点。

    public void parse(String filePath) throws Exception {
   
   
        // 创建解析器工厂和解析器
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        DocumentBuilder builder = factory.newDocumentBuilder();
        Document document = builder.parse(new File(filePath));  // 解析 XML 文件

        // 解析 <properties> 节点
        parseProperties(document);
        // 解析 <settings> 节点
        parseSettings(document);
        // 校验配置的有效性
        validateConfiguration();
    }

DocumentBuilderFactory 和 DocumentBuilder：用于创建 XML 文档解析器。
Document：表示整个 XML 文件内容的对象，供我们解析和操作。

3. 解析 `<properties>` 节点

接下来，我们编写 parseProperties 方法来解析 <properties> 节点，并将解析结果存储在 properties Map 中。

    private void parseProperties(Document document) {
   
   
        NodeList propertyNodes = document.getElementsByTagName("property");
        for (int i = 0; i < propertyNodes.getLength(); i++) {
   
   
            Element property = (Element) propertyNodes.item(i);
            properties.put(property.getAttribute("name"), property.getAttribute("value"));
        }
    }

NodeList 和 Element：NodeList 是一个包含多个 XML 节点的列表，Element 是具体的 XML 元素节点。我们通过 getAttribute 方法获取属性值。

4. 解析 `<settings>` 节点

我们以类似的方式解析 <settings> 节点。

    private void parseSettings(Document document) {
   
   
        NodeList settingNodes = document.getElementsByTagName("setting");
        for (int i = 0; i < settingNodes.getLength(); i++) {
   
   
            Element setting = (Element) settingNodes.item(i);
            settings.put(setting.getAttribute("name"), setting.getAttribute("value"));
        }
    }

解析过程：遍历 <setting> 节点列表，并将 name 和 value 属性值存储在 settings Map 中。

5. 校验配置

解析完 <properties> 和 <settings> 节点后，我们需要对配置进行校验，确保必须的设置项都已定义。

    private void validateConfiguration() {
   
   
        if (!settings.containsKey("cacheEnabled")) {
   
   
            throw new IllegalArgumentException("缺少必要的设置：cacheEnabled");
        }
    }

校验逻辑：我们检查 settings Map 中是否包含 cacheEnabled 设置项，如果缺少则抛出异常。

6. 提供结果的获取方法

我们提供 getProperties 和 getSettings 方法，让用户能够获取解析后的配置内容。

    public Map<String, String> getProperties() {
   
   
        return properties;
    }

    public Map<String, String> getSettings() {
   
   
        return settings;
    }

7. 编写主方法测试

最后，我们编写一个简单的 main 方法来测试这个解析器。

    public static void main(String[] args) throws Exception {
   
   
        SimpleXMLConfigParser parser = new SimpleXMLConfigParser();
        parser.parse("path/to/mybatis-config.xml");
        System.out.println("Properties: " + parser.getProperties());
        System.out.println("Settings: " + parser.getSettings());
    }
}

完整代码汇总

import org.w3c.dom.*;
import javax.xml.parsers.*;
import java.io.File;
import java.util.HashMap;
import java.util.Map;

public class SimpleXMLConfigParser {
   
   
    private Map<String, String> properties = new HashMap<>();
    private Map<String, String> settings = new HashMap<>();

    public void parse(String filePath) throws Exception {
   
   
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        DocumentBuilder builder = factory.newDocumentBuilder();
        Document document = builder.parse(new File(filePath));

        parseProperties(document);
        parseSettings(document);
        validateConfiguration();
    }

    private void parseProperties(Document document) {
   
   
        NodeList propertyNodes = document.getElementsByTagName("property");
        for (int i = 0; i < propertyNodes.getLength(); i++) {
   
   
            Element property = (Element) propertyNodes.item(i);
            properties.put(property.