MyBatis 源码解析：Configuration 对象的生成与初始化

原创

已于 2024-08-29 23:54:25 修改 · 1.5k 阅读

12 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis #java

于 2024-08-29 23:46:25 首次发布

前言

在 MyBatis 框架中，Configuration 对象是核心配置的载体，它包含了所有与 MyBatis 运行相关的配置信息，如环境配置、映射器、SQL 语句缓存等。理解 Configuration 对象的生成与初始化过程，对于深入掌握 MyBatis 的工作原理非常重要。

本篇文章将通过自定义实现一个详细的 Configuration 类，模拟 MyBatis 中的配置管理，随后深入解析 MyBatis 源码中 Configuration 对象的生成与初始化细节。希望通过这些内容，帮助你全面理解 MyBatis 的配置管理机制。

自定义实现：详细的 Configuration 类

目标与功能

我们将实现一个详细的 Configuration 类，主要功能包括：

管理 MyBatis 的全局配置项。
管理环境配置和数据源。
管理映射器、SQL 语句等配置项。
提供接口进行配置的初始化、验证和使用。

实现过程

1. 定义详细版 Configuration 类

我们将实现一个类似 MyBatis 的 Configuration 类，包含环境配置、全局设置、映射器等配置项。

import java.util.HashMap;
import java.util.Map;

/**
 * Configuration 类模拟 MyBatis 中的详细配置管理。
 */
public class DetailedConfiguration {
   
   
    private String environment;  // 当前环境
    private Map<String, String> settings = new HashMap<>();  // 全局配置项
    private Map<String, String> mappers = new HashMap<>();  // 映射器配置
    private Map<String, String> sqlStatements = new HashMap<>();  // SQL 语句配置

    /**
     * 设置当前环境。
     * @param environment 环境名称
     */
    public void setEnvironment(String environment) {
   
   
        this.environment = environment;
    }

    /**
     * 添加一个全局配置项。
     * @param key 配置项名称
     * @param value 配置项值
     */
    public void addSetting(String key, String value) {
   
   
        settings.put(key, value);
    }

    /**
     * 添加一个映射器配置。
     * @param name 映射器名称
     * @param mapperClass 映射器类
     */
    public void addMapper(String name, String mapperClass) {
   
   
        mappers.put(name, mapperClass);
    }

    /**
     * 添加一个 SQL 语句配置。
     * @param id SQL 语句的唯一标识
     * @param sql SQL 语句内容
     */
    public void addSqlStatement(String id, String sql) {
   
   
        sqlStatements.put(id, sql);
    }

    public String getEnvironment() {
   
   
        return environment;
    }

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

    public Map<String, String> getMappers() {
   
   
        return mappers;
    }

    public Map<String, String> getSqlStatements() {
   
   
        return sqlStatements;
    }

    /**
     * 验证配置的完整性和正确性。
     */
    public void validate() {
   
   
        if (environment == null || environment.isEmpty()) {
   
   
            throw new IllegalStateException("Environment must be set");
        }
        if (settings.isEmpty()) {
   
   
            throw new IllegalStateException("Global settings must be provided");
        }
        if (mappers.isEmpty()) {
   
   
            throw new IllegalStateException("At least one mapper must be provided");
        }
        if (sqlStatements.isEmpty()) {
   
   
            throw new IllegalStateException("At least one SQL statement must be provided");
        }
        System.out.println("Configuration validated successfully.");
    }
}

2. 初始化配置

我们实现一个 ConfigurationBuilder 类，用于模拟 MyBatis 中 Configuration 对象的生成过程，包括解析配置文件、初始化配置和验证配置。

public class ConfigurationBuilder {
   
   
    private DetailedConfiguration configuration = new DetailedConfiguration();

    /**
     * 模拟从配置文件中加载环境配置。
     */
    public void loadEnvironment(String environment) {
   
   
        configuration.setEnvironment(environment);
        System.out.println("Environment set to: " + environment);
    }

    /**
     * 模拟从配置文件中加载全局配置项。
     */
    public void loadSettings() {
   
   
        configuration.addSetting("cacheEnabled",