当前位置： 首页 > article >正文

MyBatis 源码解析：SqlSessionFactoryBuilder 解析与实现

article 2025/1/31 10:42:47

摘要

在使用 MyBatis 时，SqlSessionFactory 是我们进行数据库操作的核心对象，而 SqlSessionFactoryBuilder 则负责根据配置文件生成这个核心对象。你是否曾经好奇，MyBatis 是如何将配置文件解析成 SqlSessionFactory 的？本文将通过自定义实现一个简化版的 SqlSessionFactoryBuilder，带你深入了解 MyBatis 的初始化过程，并掌握如何在实际项目中更好地应用这些知识。

前言

SqlSessionFactoryBuilder 是 MyBatis 的核心组件之一，它负责根据配置文件或配置对象生成 SqlSessionFactory，而 SqlSessionFactory 又是整个 MyBatis 执行 SQL 操作的关键入口。理解 SqlSessionFactoryBuilder 的解析与实现有助于掌握 MyBatis 的初始化流程。本文将通过自定义实现一个简化版的 SqlSessionFactoryBuilder，并深入解析 MyBatis 中的 SqlSessionFactoryBuilder 的实现细节。

自定义实现：简化版 SqlSessionFactoryBuilder

目标与功能

我们将实现一个简化版的 SqlSessionFactoryBuilder，通过读取配置文件或配置对象来生成 SqlSessionFactory，这个实现将帮助我们理解 MyBatis 是如何初始化 SqlSessionFactory 并准备执行环境的。

核心流程

  1. 解析配置：从 XML 文件或配置对象中读取 MyBatis 的配置信息。
  2. 构建 SqlSessionFactory：基于解析后的配置生成 SqlSessionFactory。
  3. 管理资源：在生成 SqlSessionFactory 的过程中，管理资源的加载与关闭。

实现过程

1. 定义 Configuration 类

首先，我们定义一个 Configuration 类，用于存储 MyBatis 的配置信息，包括环境配置、数据源配置、映射器配置等。

/**
 * Configuration 类用于存储 MyBatis 的配置信息。
 * 包括环境配置、数据源配置、映射器配置等。
 */
public class Configuration {
    private EnvironmentConfig environmentConfig;  // 存储环境配置信息
    // 其他配置项（如映射器配置）可以在这里添加

    /**
     * 获取环境配置信息。
     * 
     * @return EnvironmentConfig 对象
     */
    public EnvironmentConfig getEnvironmentConfig() {
        return environmentConfig;
    }

    /**
     * 设置环境配置信息。
     * 
     * @param environmentConfig EnvironmentConfig 对象
     */
    public void setEnvironmentConfig(EnvironmentConfig environmentConfig) {
        this.environmentConfig = environmentConfig;
    }
}
2. 定义 SqlSessionFactory 接口与 DefaultSqlSessionFactory 类

我们定义 SqlSessionFactory 接口，并实现一个简化版的 DefaultSqlSessionFactory 类。

/**
 * SqlSessionFactory 接口，用于生成 SqlSession 对象。
 */
public interface SqlSessionFactory {
    SqlSession openSession();
}

/**
 * DefaultSqlSessionFactory 类是 SqlSessionFactory 的一个简化实现。
 * 它基于 Configuration 配置生成 SqlSession 对象。
 */
public class DefaultSqlSessionFactory implements SqlSessionFactory {
    private final Configuration configuration;

    public DefaultSqlSessionFactory(Configuration configuration) {
        this.configuration = configuration;
    }

    @Override
    public SqlSession openSession() {
        // 简化的实现，实际应该包含事务、连接等管理逻辑
        return new DefaultSqlSession(configuration);
    }
}
3. 定义 SqlSession 接口与 DefaultSqlSession 类

SqlSession 是 MyBatis 操作数据库的核心接口，我们定义 SqlSession 接口，并实现一个简化版的 DefaultSqlSession 类。

/**
 * SqlSession 接口，定义了 MyBatis 中执行 SQL 的核心操作。
 */
public interface SqlSession {
    <T> T selectOne(String statement);
    // 其他数据库操作方法可以在这里定义
}

/**
 * DefaultSqlSession 是 SqlSession 接口的一个简化实现。
 * 它基于 Configuration 配置执行 SQL 操作。
 */
public class DefaultSqlSession implements SqlSession {
    private final Configuration configuration;

    public DefaultSqlSession(Configuration configuration) {
        this.configuration = configuration;
    }

    @Override
    public <T> T selectOne(String statement) {
        // 简化的实现，实际操作中应该执行 SQL 并返回结果
        System.out.println("Executing SQL statement: " + statement);
        return null;
    }
}
4. 实现 SqlSessionFactoryBuilder 类

SqlSessionFactoryBuilder 类负责根据配置生成 SqlSessionFactory 对象。我们实现一个简化版的 SqlSessionFactoryBuilder，支持从 XML 配置文件生成 SqlSessionFactory。

import java.io.InputStream;

/**
 * SqlSessionFactoryBuilder 类负责根据配置生成 SqlSessionFactory 对象。
 */
public class SqlSessionFactoryBuilder {

    /**
     * 从 XML 配置文件中构建 SqlSessionFactory。
     * 
     * @param inputStream 输入流，指向配置文件
     * @return 构建好的 SqlSessionFactory 对象
     */
    public SqlSessionFactory build(InputStream inputStream) {
        // 使用 EnvironmentConfigParser 解析 XML 配置文件
        Configuration configuration = new Configuration();
        EnvironmentConfig environmentConfig = parseConfig(inputStream);
        configuration.setEnvironmentConfig(environmentConfig);

        return new DefaultSqlSessionFactory(configuration);
    }

    /**
     * 解析 XML 配置文件，返回 EnvironmentConfig 对象。
     * 
     * @param inputStream 输入流，指向配置文件
     * @return EnvironmentConfig 对象
     */
    private EnvironmentConfig parseConfig(InputStream inputStream) {
        // 使用自定义的解析器解析 XML 文件
        try {
            return EnvironmentConfigParser.parse(inputStream);
        } catch (Exception e) {
            throw new RuntimeException("Failed to parse config file", e);
        }
    }
}
5. 测试 SqlSessionFactoryBuilder

最后，我们编写一个简单的测试类来验证 SqlSessionFactoryBuilder 的功能。

import java.io.InputStream;

public class SqlSessionFactoryBuilderTest {
    public static void main(String[] args) {
        // 读取 MyBatis 配置文件
        InputStream inputStream = SqlSessionFactoryBuilderTest.class.getResourceAsStream("/mybatis-config.xml");

        // 使用 SqlSessionFactoryBuilder 构建 SqlSessionFactory
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = builder.build(inputStream);

        // 获取 SqlSession 并执行查询操作
        SqlSession session = factory.openSession();
        session.selectOne("com.example.mapper.selectById");
    }
}

自定义实现类图
Configuration
- EnvironmentConfig environmentConfig
+getEnvironmentConfig()
+setEnvironmentConfig(EnvironmentConfig)
«interface»
SqlSessionFactory
+openSession()
DefaultSqlSessionFactory
- Configuration configuration
+openSession()
«interface»
SqlSession
+selectOne(String statement)
DefaultSqlSession
- Configuration configuration
+selectOne(String statement)
SqlSessionFactoryBuilder
+build(InputStream inputStream)
-parseConfig(InputStream inputStream)
EnvironmentConfig

代码解析流程图
开始
读取 XML 配置文件
解析配置
初始化 Configuration
构建 SqlSessionFactory
返回 SqlSessionFactory
打开 SqlSession
执行 SQL 操作

源码解析：MyBatis 中的 SqlSessionFactoryBuilder

1. SqlSessionFactoryBuilder 的初始化

在 MyBatis 中，SqlSessionFactoryBuilder 主要负责根据配置文件或配置对象构建 SqlSessionFactory 对象。它的核心流程包括解析配置、初始化 Configuration 对象，并最终构建 SqlSessionFactory。

public SqlSessionFactory build(InputStream inputStream) {
    try {
        // 使用 XMLConfigBuilder 解析配置文件
        XMLConfigBuilder parser = new XMLConfigBuilder(inputStream);
        Configuration config = parser.parse();
        return build(config);
    } catch (Exception e) {
        throw new BuilderException("Error building SqlSession.", e);
    }
}
  • 解析配置：使用 XMLConfigBuilder 解析 XML 配置文件，生成 Configuration 对象。
  • 构建 SqlSessionFactory：调用 build(Configuration config) 方法，基于 Configuration 对象构建 SqlSessionFactory。

2. SqlSessionFactory 的生成

在 MyBatis 中，SqlSessionFactory 的生成主要依赖于 Configuration 对象。Configuration 存储了 MyBatis 的所有配置信息，如环境配置、数据源配置、映射器配置等。

public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
}
  • Configuration 对象：包含了 MyBatis 的所有配置信息，是 SqlSessionFactory 生成的核心依赖。
  • DefaultSqlSessionFactory：MyBatis 提供的默认 SqlSessionFactory 实现类，基于 Configuration 对象生成 SqlSessionFactory。

3. XMLConfigBuilder 的解析过程

XMLConfigBuilder 是 MyBatis 用于解析 mybatis-config.xml 配置文件的核心类。它将 XML 文件中的各项配置解析为 Configuration 对象。

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

private void parseConfiguration(XNode root) {
    try {
        propertiesElement(root.evalNode("properties"));
        settingsAsProperties(root.evalNode("settings"));
        typeAliasesElement(root.evalNode("typeAliases"));
        // 其他配置解析过程
        environmentsElement(root.evalNode("environments"));
        mappersElement(root.evalNode("mappers"));
    } catch (Exception e) {
        throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
}
  • propertiesElement：解析 <properties> 节点，将外部属性文件加载到 Configuration 中。
  • settingsAsProperties：解析 <settings> 节点，将全局设置应用到 Configuration 中。
  • environmentsElement：解析 <environments> 节点，配置多环境支持，选择默认环境。
  • mappersElement：解析 <mappers> 节点，加载 Mapper 配置。

4. Configuration 对象的核心配置

Configuration 是 MyBatis 的核心配置类，负责管理所有 MyBatis 运行时所需的配置信息，包括环境配置、数据源配置、事务管理器配置等。

public class Configuration {
    protected Environment environment;
    protected boolean lazyLoadingEnabled = false;
    protected boolean aggressiveLazyLoading = false;
    protected boolean multipleResultSetsEnabled = true;
    protected boolean useGeneratedKeys = false;
    protected boolean useColumnLabel = true;
    protected boolean cacheEnabled = true;
    // 其他配置属性...

    // 配置项的 Getter 和 Setter 方法
}
  • Environment 对象：封装了数据源和事务管理器等环境相关的配置。
  • lazyLoadingEnabled：是否启用懒加载功能。
  • cacheEnabled：是否启用二级缓存。

5. 对比与总结

通过自定义实现的 SqlSessionFactoryBuilder 和 MyBatis 源码解析，可以看出二者的主要区别在于细节处理上。自定义实现简化了许多配置管理和资源管理的逻辑，而 MyBatis 提供了更为丰富的功能和更强的可扩展性。理解这些原理有助于在日常开发中更好地使用 MyBatis，同时也为深入优化和扩展 MyBatis 提供了思路。

总结与互动

通过本文，我们详细探讨了 MyBatis 中 SqlSessionFactoryBuilder 的解析与实现，并通过自定义实现加深了对 MyBatis 初始化流程的理解。掌握这些知识有助于更好地配置和管理 MyBatis，提升应用程序的稳定性和性能。

如果您觉得这篇文章对您有帮助，请点赞、收藏并关注！此外，欢迎在评论区留言，与我们分享您的见解或提出疑问！


http://www.kler.cn/a/286536.html

相关文章：

  • Git 版本控制：基础介绍与常用操作
  • 国产碳化硅（SiC）MOSFET模块在电镀电源中全面取代进口IGBT模块
  • Java基础知识总结（三十二）--API--- java.lang.Runtime
  • Visual Studio使用GitHub Copilot提高.NET开发工作效率
  • Git图形化工具【lazygit】
  • shiro学习五：使用springboot整合shiro。在前面学习四的基础上，增加shiro的缓存机制，源码讲解：认证缓存、授权缓存。
  • LeetCode15. 三数之和（2024秋季每日一题 8）
  • Navicat连接Mongodb成功了，但是无法显示数据库怎么办？
  • 第三十九篇-TeslaP40+CosyVoice-安装
  • tornado获取请求参数
  • 2408wtl,玻璃类
  • 构建大师：深入理解Linux下的Make和Makefile
  • 火焰传感器详解（STM32）
  • 【案例63】SSL RC4 加密套件支持检测 (Bar Mitzvah)修复方案
  • 《使用 LangChain 进行大模型应用开发》学习笔记（一）
  • 动手学深度学习（pytorch）学习记录17-房价预测[学习记录]
  • OpenCV绘图函数（6）绘制椭圆函数ellipse()的使用
  • 线性回归算法详解
  • 简单工作流-节点增加输入内容
  • 工业软件架构5:(QT和C++实现)
  • .NetCore发布到IIS
  • 基于单片机的仿生水母水下机器人设计
  • CentOS 7 的默认YUM源更换为国内的镜像源保姆级教程（附：常见的国内 CentOS 镜像源地址）
  • 线程池在接受到30个比较耗时的任务时的状态，在前面30个比较耗时的任务还没执行完成的情况下，再来多少个任务会触发拒绝策略？
  • 【Unity3D优化】优化内置shader的内存占用
  • Web3前端开发：重塑互联网的未来