MyBatis 源码解析：Environment 与 DataSource 配置实现

捕风捉你2024-08-30 8:37

前言

在 MyBatis 框架中，Environment 和 DataSource 是配置管理的核心部分。Environment 负责管理不同的运行环境（如开发、测试、生产环境），而 DataSource 则管理数据库连接的配置和管理。理解这两个组件的工作原理有助于我们更好地掌握 MyBatis 的配置管理和框架初始化过程。

本篇文章将通过自定义实现一个环境配置管理类来简化 Environment 和 DataSource 的实现，随后深入解析 MyBatis 中这两个组件的源码实现细节。希望通过这些内容，帮助读者全面理解 MyBatis 的环境和数据源配置。

自定义实现：环境与数据源配置管理

目标与功能

我们将实现一个简化版的环境配置管理类，功能包括：

  1. 支持多环境的配置管理（如开发、测试、生产环境）。
  2. 支持不同环境的事务管理器配置（如 JDBC 或 JNDI）。
  3. 支持多种数据源配置方式。
  4. 提供接口切换当前环境，并获取对应的数据库连接。

实现过程

1. 定义环境配置类

首先，我们定义一个名为 EnvironmentConfig 的类，用于存储每个环境的配置信息，包括环境名称、事务管理器类型以及数据源配置项。

java 复制代码 
import java.util.HashMap;
import java.util.Map;

/**
 * EnvironmentConfig 类用于存储单个环境的配置，包括环境名称、事务管理器类型和数据源配置。
 */
public class EnvironmentConfig {
    private String environmentName;  // 环境名称，如 "development", "production"
    private String transactionManagerType;  // 事务管理器类型，如 "JDBC", "MANAGED"
    private Map<String, String> dataSourceConfig = new HashMap<>();  // 数据源配置项

    /**
     * 构造函数，初始化环境名称和事务管理器类型。
     * @param environmentName 环境名称
     * @param transactionManagerType 事务管理器类型
     */
    public EnvironmentConfig(String environmentName, String transactionManagerType) {
        this.environmentName = environmentName;
        this.transactionManagerType = transactionManagerType;
    }

    /**
     * 设置数据源配置项。
     * @param key 配置项的键（如 "url", "username", "password"）
     * @param value 配置项的值
     */
    public void setDataSourceConfig(String key, String value) {
        dataSourceConfig.put(key, value);
    }

    /**
     * 获取数据源配置项的 Map。
     * @return 包含所有数据源配置项的 Map
     */
    public Map<String, String> getDataSourceConfig() {
        return dataSourceConfig;
    }

    public String getEnvironmentName() {
        return environmentName;
    }

    public String getTransactionManagerType() {
        return transactionManagerType;
    }
}
2. 创建多环境配置管理类

我们需要一个 EnvironmentManager 类来管理多个 EnvironmentConfig 实例。该类应支持添加环境配置、切换当前环境，并获取当前环境的配置项。

java 复制代码 
import java.util.HashMap;
import java.util.Map;

/**
 * EnvironmentManager 类用于管理多个环境配置，并支持切换不同环境。
 */
public class EnvironmentManager {
    private Map<String, EnvironmentConfig> environments = new HashMap<>();  // 存储多个环境配置
    private EnvironmentConfig currentEnvironment;  // 当前选定的环境配置

    /**
     * 添加一个环境配置。
     * @param environmentConfig 要添加的环境配置对象
     */
    public void addEnvironment(EnvironmentConfig environmentConfig) {
        environments.put(environmentConfig.getEnvironmentName(), environmentConfig);
    }

    /**
     * 根据环境名称切换当前环境配置。
     * @param environmentName 要切换的环境名称
     */
    public void switchEnvironment(String environmentName) {
        currentEnvironment = environments.get(environmentName);
        if (currentEnvironment == null) {
            throw new IllegalArgumentException("环境配置 '" + environmentName + "' 不存在！");
        }
    }

    /**
     * 获取当前环境的配置。
     * @return 当前环境的 EnvironmentConfig 对象
     */
    public EnvironmentConfig getCurrentEnvironment() {
        return currentEnvironment;
    }

    /**
     * 打印当前所有的环境配置名称。
     */
    public void printAllEnvironments() {
        System.out.println("Available environments: " + environments.keySet());
    }
}
3. 实现数据源管理

数据源配置是环境配置的重要部分。我们实现一个 DataSourceManager 类，该类可以根据 EnvironmentConfig 中的配置项创建数据库连接。

java 复制代码 
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.Map;

/**
 * DataSourceManager 类用于管理数据源，并根据环境配置创建数据库连接。
 */
public class DataSourceManager {

    /**
     * 根据当前环境的配置创建数据库连接。
     * @param environmentConfig 当前环境配置
     * @return 数据库连接对象
     * @throws SQLException 数据库连接失败时抛出异常
     */
    public static Connection createConnection(EnvironmentConfig environmentConfig) throws SQLException {
        Map<String, String> config = environmentConfig.getDataSourceConfig();

        String url = config.get("url");
        String username = config.get("username");
        String password = config.get("password");

        // 判断事务管理器类型，假设这里只支持 JDBC
        if ("JDBC".equalsIgnoreCase(environmentConfig.getTransactionManagerType())) {
            return DriverManager.getConnection(url, username, password);
        } else {
            throw new UnsupportedOperationException("当前事务管理器类型不支持: " + environmentConfig.getTransactionManagerType());
        }
    }
}
4. 使用示例

我们可以创建多个 EnvironmentConfig 实例来代表不同的环境，并为每个环境配置不同的数据源，然后通过 EnvironmentManager 进行环境切换和数据库连接管理。

java 复制代码 
public class Main {
    public static void main(String[] args) {
        // 创建开发环境的配置
        EnvironmentConfig devEnvironment = new EnvironmentConfig("development", "JDBC");
        devEnvironment.setDataSourceConfig("url", "jdbc:mysql://localhost:3306/dev_db");
        devEnvironment.setDataSourceConfig("username", "dev_user");
        devEnvironment.setDataSourceConfig("password", "dev_password");

        // 创建生产环境的配置
        EnvironmentConfig prodEnvironment = new EnvironmentConfig("production", "JDBC");
        prodEnvironment.setDataSourceConfig("url", "jdbc:mysql://localhost:3306/prod_db");
        prodEnvironment.setDataSourceConfig("username", "prod_user");
        prodEnvironment.setDataSourceConfig("password", "prod_password");

        // 创建环境管理器
        EnvironmentManager environmentManager = new EnvironmentManager();
        environmentManager.addEnvironment(devEnvironment);
        environmentManager.addEnvironment(prodEnvironment);

        // 打印所有环境
        environmentManager.printAllEnvironments();

        // 切换到开发环境并创建连接
        environmentManager.switchEnvironment("development");
        try (Connection devConnection = DataSourceManager.createConnection(environmentManager.getCurrentEnvironment())) {
            System.out.println("Connected to Development DB: " + devConnection.getMetaData().getURL());
        } catch (SQLException e) {
            e.printStackTrace();
        }

        // 切换到生产环境并创建连接
        environmentManager.switchEnvironment("production");
        try (Connection prodConnection = DataSourceManager.createConnection(environmentManager.getCurrentEnvironment())) {
            System.out.println("Connected to Production DB: " + prodConnection.getMetaData().getURL());
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

下面是为自定义实现部分准备的类图和流程图。

自定义实现类图

uses manages EnvironmentConfig - String environmentName - String transactionManagerType - Map dataSourceConfig +getEnvironmentName() +getTransactionManagerType() +getDataSourceConfig() +setDataSourceConfig(String key, String value) EnvironmentManager - Map environments - EnvironmentConfig currentEnvironment +addEnvironment(EnvironmentConfig environmentConfig) +switchEnvironment(String environmentName) +getCurrentEnvironment() +printAllEnvironments() DataSourceManager +createConnection(EnvironmentConfig environmentConfig)

类图解释：
  • EnvironmentConfig 类用于存储单个环境的配置，包括环境名称、事务管理器类型和数据源配置。
  • EnvironmentManager 类管理多个 EnvironmentConfig 实例，并支持环境切换。
  • DataSourceManager 类根据 EnvironmentConfig 提供的数据源配置创建数据库连接。

自定义实现流程图

开始 定义 EnvironmentConfig 类 实现 EnvironmentManager 类 实现 DataSourceManager 类 创建并配置多个环境 切换到特定环境 创建数据库连接 完成

流程图解释：
  1. 定义 EnvironmentConfig 类：用于存储环境的配置信息。
  2. 实现 EnvironmentManager 类：管理多个环境并支持环境切换。
  3. 实现 DataSourceManager 类：根据当前环境配置创建数据库连接。
  4. 创建并配置多个环境：为不同的环境设置特定的数据库配置。
  5. 切换到特定环境：根据需求切换到目标环境。
  6. 创建数据库连接 ：使用 DataSourceManager 进行数据库连接的创建。
  7. 完成：整个流程结束。
5. 自定义实现总结

以上的自定义实现展示了如何在一个应用程序中管理多种环境配置，并根据不同环境动态创建数据库连接。该实现主要涵盖了以下几点：

  1. 环境配置管理 ：通过 EnvironmentConfig 类存储不同环境的配置信息，包括事务管理器和数据源配置。
  2. 多环境切换 ：使用 EnvironmentManager 类可以轻松切换不同的环境配置。
  3. 数据源管理 ：通过 DataSourceManager 类可以根据当前环境配置动态创建数据库连接。

这种实现方式与 MyBatis 框架中的 Environment 和 DataSource 管理有着异曲同工之妙，下面我们将深入解析 MyBatis 源码中的相关实现。

源码解析：MyBatis 中的 Environment 与 DataSource

1. Environment 的初始化

在 MyBatis 中，Environment 类用于配置不同的运行环境。每个 Environment 都包括一个事务管理器和数据源。

java 复制代码 
public class Environment {
    private final String id;  // 环境ID
    private final TransactionFactory transactionFactory;  // 事务管理器工厂
    private final DataSource dataSource;  // 数据源

    public Environment(String id, TransactionFactory transactionFactory, DataSource dataSource) {
        this.id = id;
        this

.transactionFactory = transactionFactory;
        this.dataSource = dataSource;
    }

    // Builder 模式用于构建 Environment 对象
    public static class Builder {
        private final String id;
        private TransactionFactory transactionFactory;
        private DataSource dataSource;

        public Builder(String id) {
            this.id = id;
        }

        public Builder transactionFactory(TransactionFactory transactionFactory) {
            this.transactionFactory = transactionFactory;
            return this;
        }

        public Builder dataSource(DataSource dataSource) {
            this.dataSource = dataSource;
            return this;
        }

        public Environment build() {
            return new Environment(id, transactionFactory, dataSource);
        }
    }
}
代码详解
  • Environment 类 ：表示 MyBatis 的运行环境，每个环境都包含了 id、transactionFactory 和 dataSource。
  • Builder 模式 ：用于创建 Environment 实例，通过链式调用设置事务管理器和数据源。

2. 解析 <environments> 节点

environmentsElement 方法用于解析 MyBatis 配置文件中的 <environments> 节点，并选择一个默认的环境进行初始化。

java 复制代码 
private void environmentsElement(XNode context) throws Exception {
    if (context != null) {
        String defaultEnvironment = context.getStringAttribute("default");  // 获取默认环境
        for (XNode child : context.getChildren()) {
            String id = child.getStringAttribute("id");
            if (isSpecifiedEnvironment(id, defaultEnvironment)) {
                TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
                DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
                DataSource dataSource = dsFactory.getDataSource();
                Environment.Builder environmentBuilder = new Environment.Builder(id)
                    .transactionFactory(txFactory)
                    .dataSource(dataSource);
                configuration.setEnvironment(environmentBuilder.build());
            }
        }
    }
}
代码详解
  • defaultEnvironment ：从 <environments> 节点中获取默认的环境 ID。
  • transactionManagerElement 和 dataSourceElement ：分别解析 <transactionManager> 和 <dataSource> 节点，返回对应的 TransactionFactory 和 DataSource 对象。
  • isSpecifiedEnvironment：判断当前解析的环境 ID 是否为默认环境。
  • configuration.setEnvironment ：最终将解析后的 Environment 对象设置到 MyBatis 的 Configuration 中。

3. 配置 DataSource

在 MyBatis 中，DataSource 的配置支持多种类型，如 JDBC 和 JNDI。MyBatis 提供了 DataSourceFactory 接口，允许开发者自定义数据源的创建逻辑。

java 复制代码 
public interface DataSourceFactory {
    void setProperties(Properties props);  // 设置数据源配置属性
    DataSource getDataSource();  // 获取数据源实例
}

MyBatis 自带了多个 DataSourceFactory 实现，如 UnpooledDataSourceFactory 和 PooledDataSourceFactory，分别对应不带连接池和带连接池的数据源配置。

配置示例

假设我们使用 UnpooledDataSourceFactory 配置一个简单的 JDBC 数据源：

java 复制代码 
Properties props = new Properties();
props.setProperty("driver", "com.mysql.cj.jdbc.Driver");
props.setProperty("url", "jdbc:mysql://localhost:3306/mybatis");
props.setProperty("username", "root");
props.setProperty("password", "password");

DataSourceFactory dsFactory = new UnpooledDataSourceFactory();
dsFactory.setProperties(props);

DataSource dataSource = dsFactory.getDataSource();

4. 总结

在这篇文章中，我们通过自定义实现与 MyBatis 源码解析，深入理解了 Environment 和 DataSource 的配置及其实现原理。Environment 作为 MyBatis 的核心配置类，允许开发者灵活地管理多环境配置，而 DataSource 则是数据库连接的关键组件。掌握这些知识点，将有助于你在实际项目中更好地应用 MyBatis。

如果你觉得这篇文章对你有帮助，请点赞、收藏并关注，这样你就不会错过我之后的更多精彩内容！如果你有任何问题或见解，欢迎在评论区留言讨论！

相关推荐
靖顺14 分钟前
【OceanBase 诊断调优】—— OceanBase 数据库统计信息被禁用，状态为 broken 的原因和解决方法
数据库·oceanbase
夜光小兔纸20 分钟前
Oracle 单机及 RAC 环境 db_files 参数修改
数据库·oracle
骑鱼过海的猫1231 小时前
【redis】redis
java·数据库·redis
CT随1 小时前
Redis 概 述 和 安 装
数据库·redis·缓存
不烦下雨c2 小时前
[Mysql基础] 表的操作
数据库·mysql
上官花雨2 小时前
超详细：数据库的基本架构
数据库·架构
枫叶落雨2222 小时前
mybatis-plus: mapper-locations: “classpath*:/mapper/**/*.xml“配置！！！解释
xml·java·mybatis
double丶flower2 小时前
mybatis在mapper.xml中怎么处理大于、小于、不等于号
xml·java·mybatis
ClouGence3 小时前
Kafka 到 Kafka 数据同步
数据库·数据分析·kafka·数据同步
瑕、疵3 小时前
使用机器学习优化数据库查询性能
数据库·机器学习·oracle
热门推荐
01聊聊 Python 中的同步原语，为什么有了 GIL 还需要同步原语02Ubuntu 20.04使用Livox mid 360 测试 FAST_LIO03【HarmonyOS】HUAWEI DevEco Studio 下载地址汇总04玄机平台应急响应—webshell查杀05软件工程从理论到实践客观题汇总(头歌第一章至第八章)06组基轨迹建模 GBTM的介绍与实现（Stata 或 R）07智能车联网安全发展形势、挑战08全面解析：构建基于深度学习的安全帽检测系统（UI界面+YOLO代码+数据集）09基于YOLOv10深度学习的CT扫描图像肾结石智能检测系统【python源码+Pyqt5界面+数据集+训练代码】深度学习实战、目标检测10Vue3优化之实现懒加载和子组件异步加载