MyBatis 源码解析：DefaultSqlSessionFactory 的创建与管理

摘要

在 MyBatis 中，SqlSessionFactory 是执行数据库操作的核心对象，它负责创建和管理 SqlSession 的生命周期。你是否想了解 SqlSessionFactory 的创建和管理过程？本文将通过自定义实现一个简化版的 DefaultSqlSessionFactory，带你深入探讨 MyBatis 中 DefaultSqlSessionFactory 的创建与管理机制，并帮助你更好地掌握 SqlSession 的创建和管理流程。

---

前言

DefaultSqlSessionFactory 是 MyBatis 提供的 SqlSessionFactory 的默认实现类，它负责根据 Configuration 对象生成 SqlSession，并管理 SqlSession 的生命周期。理解 DefaultSqlSessionFactory 的创建与管理，有助于深入掌握 MyBatis 的数据库操作机制。本文将通过自定义实现一个简化版的 DefaultSqlSessionFactory，并深入解析 MyBatis 中 DefaultSqlSessionFactory 的实现细节。

---

自定义实现：简化版 DefaultSqlSessionFactory

目标与功能

我们将实现一个简化版的 DefaultSqlSessionFactory，该工厂类将负责管理 SqlSession 的创建、事务的处理以及资源的管理。通过这个实现，我们可以更好地理解 MyBatis 是如何管理 SqlSession 的生命周期。

核心流程

1. 创建 SqlSession：根据传入的配置创建 SqlSession 对象。
2. 管理事务：确保在 SqlSession 的整个生命周期内正确地管理事务。
3. 关闭资源：在 SqlSession 关闭时，确保所有资源被正确释放。

实现过程

1. 定义 SqlSessionFactory 接口

我们定义一个 SqlSessionFactory 接口，用于生成 SqlSession 对象，并为事务和资源管理提供支持。

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

2. 实现 DefaultSqlSessionFactory 类

DefaultSqlSessionFactory 是 SqlSessionFactory 的一个默认实现类，我们将其设计为基于 Configuration 对象生成 SqlSession 对象，并管理事务和资源。

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

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

    @Override
    public SqlSession openSession() {
        return openSession(false); // 默认不开启自动提交
    }

    @Override
    public SqlSession openSession(boolean autoCommit) {
        // 获取数据源，打开数据库连接
        Connection connection = getConnection(configuration.getEnvironmentConfig().getDataSourceConfig());

        // 创建并返回一个新的 SqlSession
        return new DefaultSqlSession(configuration, connection, autoCommit);
    }

    /**
     * 获取数据库连接。
     * 
     * @param dataSourceConfig 数据源配置
     * @return 数据库连接对象
     */
    private Connection getConnection(DataSourceConfig dataSourceConfig) {
        try {
            // 创建并返回一个数据库连接（简化版，实际应考虑连接池等管理）
            Class.forName(dataSourceConfig.getProperties().get("driver"));
            return DriverManager.getConnection(
                    dataSourceConfig.getProperties().get("url"),
                    dataSourceConfig.getProperties().get("username"),
                    dataSourceConfig.getProperties().get("password"));
        } catch (Exception e) {
            throw new RuntimeException("Failed to get database connection", e);
        }
    }
}

3. 实现 DefaultSqlSession 类

DefaultSqlSession 类是 SqlSession 接口的一个实现类，负责执行 SQL 操作，并管理事务和资源的关闭。

import java.sql.Connection;
import java.sql.SQLException;

/**
 * DefaultSqlSession 是 SqlSession 接口的一个简化实现。
 * 它基于 Configuration 配置执行 SQL 操作，并管理事务和资源。
 */
public class DefaultSqlSession implements SqlSession {
    private final Configuration configuration;
    private final Connection connection;
    private final boolean autoCommit;

    public DefaultSqlSession(Configuration configuration, Connection connection, boolean autoCommit) {
        this.configuration = configuration;
        this.connection = connection;
        this.autoCommit = autoCommit;
    }

    @Override
    public <T> T selectOne(String statement) {
        // 简化的 SQL 执行逻辑，实际操作中应包括 SQL 编译、执行和结果映射等
        System.out.println("Executing SQL statement: " + statement);
        return null;
    }

    /**
     * 提交事务。
     */
    public void commit() {
        try {
            if (!autoCommit) {
                connection.commit();
            }
        } catch (SQLException e) {
            throw new RuntimeException("Failed to commit transaction", e);
        }
    }

    /**
     * 回滚事务。
     */
    public void rollback() {
        try {
            if (!autoCommit) {
                connection.rollback();
            }
        } catch (SQLException e) {
            throw new RuntimeException("Failed to rollback transaction", e);
        }
    }

    /**
     * 关闭 SqlSession 并释放资源。
     */
    @Override
    public void close() {
        try {
            connection.close();
        } catch (SQLException e) {
            throw new RuntimeException("Failed to close connection", e);
        }
    }
}

4. 测试 DefaultSqlSessionFactory

我们编写一个简单的测试类来验证 DefaultSqlSessionFactory 的功能。

import java.io.InputStream;

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

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

        // 获取 SqlSession 并执行查询操作
        SqlSession session = factory.openSession();
        try {
            session.selectOne("com.example.mapper.selectById");
            session.commit(); // 提交事务
        } finally {
            session.close(); // 关闭资源
        }
    }
}

自定义实现类图

代码解析流程图

---

源码解析：MyBatis 中的 DefaultSqlSessionFactory

1. DefaultSqlSessionFactory 的创建

在 MyBatis 中，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 openSession(false);
    }

    @Override
    public SqlSession openSession(boolean autoCommit) {
        Connection connection = transactionFactory.newTransaction(environment.getDataSource(), autoCommit).getConnection();
        return new DefaultSqlSession(configuration, connection, autoCommit);
    }
}

• Configuration 对象：包含了 MyBatis 的所有配置信息，是 SqlSessionFactory 创建 SqlSession 的核心依赖。
• openSession 方法：根据配置创建一个新的 SqlSession 对象，并管理事务。

2. SqlSession 的管理

SqlSession 是 MyBatis 执行 SQL 操作的核心对象，它负责在数据库上执行 CRUD 操作，并管理事务的提交、回滚和资源的关闭。在 DefaultSqlSessionFactory 中，SqlSession 的管理主要通过以下几个方面来实现：

• 创建 SqlSession：每次调用 openSession 时，DefaultSqlSessionFactory 会创建一个新的 SqlSession 对象，并根据配置决定是否开启自动提交事务。
• 事务管理：SqlSession 对象会根据是否自动提交的配置，决定是否在每次操作后立即提交事务，或者由用户手动管理事务的提交和回滚。
• 资源管理：在 SqlSession 的 close 方法中，负责释放数据库连接和其他资源，确保系统资源的正确管理。

3. 事务管理与资源管理

在 MyBatis 中，事务管理和资源管理是 SqlSession 的重要职责。在默认实现中，事务管理的核心逻辑体现在 commit 和 rollback 方法中，而资源管理则体现在 close 方法中。

public class DefaultSqlSession implements SqlSession {
    private final Configuration configuration;
    private final Connection connection;
    private final boolean autoCommit;

    public DefaultSqlSession(Configuration configuration, Connection connection, boolean autoCommit) {
        this.configuration = configuration;
        this.connection = connection;
        this.autoCommit = autoCommit;
    }

    @Override
    public <T> T selectOne(String statement) {
        // 简化的 SQL 执行逻辑，实际操作中应包括 SQL 编译、执行和结果映射等
        System.out.println("Executing SQL statement: " + statement);
        return null;
    }

    /**
     * 提交事务。
     */
    public void commit() {
        try {
            if (!autoCommit) {
                connection.commit();
            }
        } catch (SQLException e) {
            throw new RuntimeException("Failed to commit transaction", e);
        }
    }

    /**
     * 回滚事务。
     */
    public void rollback() {
        try {
            if (!autoCommit) {
                connection.rollback();
            }
        } catch (SQLException e) {
            throw new RuntimeException("Failed to rollback transaction", e);
        }
    }

    /**
     * 关闭 SqlSession 并释放资源。
     */
    @Override
    public void close() {
        try {
            connection.close();
        } catch (SQLException e) {
            throw new RuntimeException("Failed to close connection", e);
        }
    }
}

• commit 方法：负责将事务提交到数据库，如果未开启自动提交，则手动提交事务。
• rollback 方法：当事务需要回滚时调用，如果未开启自动提交，则手动回滚事务。
• close 方法：负责关闭数据库连接和释放其他资源，确保在 SqlSession 使用完毕后不会造成资源泄露。

4. DefaultSqlSessionFactory 的完整流程

DefaultSqlSessionFactory 的完整工作流程可以总结为以下步骤：

1. 初始化 Configuration 对象：在构造 DefaultSqlSessionFactory 时，传入 Configuration 对象，保存 MyBatis 的全局配置信息。
2. 打开 SqlSession：调用 openSession 方法时，根据配置决定是否开启自动提交事务，并创建一个新的 SqlSession 对象。
3. 执行 SQL 操作：使用 SqlSession 对象执行 SQL 操作，并管理事务的提交和回滚。
4. 关闭 SqlSession：操作完成后，调用 close 方法关闭 SqlSession，释放数据库连接和其他资源。

---

总结与互动

通过本文，我们详细探讨了 MyBatis 中 DefaultSqlSessionFactory 的创建与管理，并通过自定义实现加深了对 SqlSession 生命周期管理的理解。掌握这些知识有助于在开发中更好地管理数据库操作和事务控制，提升应用程序的健壮性和可维护性。

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

---

这篇文章通过自定义实现和源码解析，帮助读者深入理解 MyBatis 中 DefaultSqlSessionFactory 的创建与管理机制。希望这些内容对您有所帮助！