创建工具类获取 SqlSession 🛠️🔍

在使用 MyBatis 进行数据库操作时，SqlSession 是核心组件之一，用于执行 SQL 语句、提交事务或关闭连接。为了提高代码复用性和易维护性，通常会创建一个工具类来获取 SqlSession。本文将详细介绍如何创建这样的工具类。

一、工具类的作用与设计原则 🎯

创建获取 SqlSession 的工具类可以带来以下优势：

减少重复代码：不需要每次都手动编写获取 SqlSession 的代码，提升开发效率。
提高代码可维护性：集中管理资源，易于对数据库连接进行维护和配置。
降低错误风险：通过工具类统一管理 SqlSession 的打开和关闭，避免资源泄露。

二、创建工具类获取 SqlSession 📝

在 MyBatis 中，获取 SqlSession 的核心步骤包括加载配置文件、构建 SqlSessionFactory，最后获取 SqlSession。以下代码展示了如何实现这些步骤。

2.1 SqlSession 工具类代码

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.InputStream;

public class MyBatisUtil {

    private static SqlSessionFactory sqlSessionFactory;

    // 静态代码块，用于加载 MyBatis 配置文件并构建 SqlSessionFactory
    static {
        try {
            String resource = "mybatis-config.xml"; // MyBatis 配置文件路径
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
            throw new RuntimeException("初始化 SqlSessionFactory 失败！");
        }
    }

    /**
     * 获取 SqlSession 对象
     * @return SqlSession
     */
    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession(); // 默认开启非自动提交事务
    }

    /**
     * 关闭 SqlSession
     * @param sqlSession 要关闭的 SqlSession 对象
     */
    public static void closeSqlSession(SqlSession sqlSession) {
        if (sqlSession != null) {
            sqlSession.close();
        }
    }
}

2.2 代码解释与说明

静态代码块加载配置文件：工具类通过静态代码块加载 mybatis-config.xml 配置文件，并创建 SqlSessionFactory 对象。这种方式确保 SqlSessionFactory 只初始化一次，节约资源。
```
static {
    try {
        String resource = "mybatis-config.xml"; // MyBatis 配置文件路径
        InputStream inputStream = Resources.getResourceAsStream(resource);
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    } catch (IOException e) {
        e.printStackTrace();
        throw new RuntimeException("初始化 SqlSessionFactory 失败！");
    }
}
```
解释：Resources.getResourceAsStream(resource) 用于读取 MyBatis 配置文件。SqlSessionFactoryBuilder 用于创建 SqlSessionFactory，如果加载失败，抛出运行时异常。
获取 SqlSession 对象：getSqlSession() 方法用于从 SqlSessionFactory 中获取 SqlSession，默认情况下是手动提交事务（非自动提交）。
```
public static SqlSession getSqlSession() {
    return sqlSessionFactory.openSession(); // 默认开启非自动提交事务
}
```
解释：openSession() 方法返回一个新的 SqlSession，默认是手动提交的事务模式，以便开发者控制事务提交或回滚。
关闭 SqlSession：closeSqlSession() 方法用于关闭 SqlSession，避免资源泄露。
```
public static void closeSqlSession(SqlSession sqlSession) {
    if (sqlSession != null) {
        sqlSession.close();
    }
}
```
解释：在完成数据库操作后，调用 close() 方法释放 SqlSession，确保数据库连接得到及时关闭。

三、工具类的使用示例 💡

public class UserService {

    public void getUserById(int userId) {
        SqlSession sqlSession = null;
        try {
            sqlSession = MyBatisUtil.getSqlSession(); // 获取 SqlSession
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            User user = userMapper.selectUserById(userId);
            System.out.println(user);
            sqlSession.commit(); // 提交事务
        } catch (Exception e) {
            if (sqlSession != null) {
                sqlSession.rollback(); // 出现异常时回滚事务
            }
            e.printStackTrace();
        } finally {
            MyBatisUtil.closeSqlSession(sqlSession); // 关闭 SqlSession
        }
    }
}

代码解释：

获取 SqlSession：通过工具类 MyBatisUtil.getSqlSession() 获取 SqlSession。
执行数据库操作：通过 UserMapper 接口调用数据库操作方法。
事务控制：出现异常时，回滚事务；操作完成后，提交事务。
关闭资源：无论是否发生异常，最后都调用工具类的 closeSqlSession() 方法关闭 SqlSession。

四、实现流程图 🧩

graph TD
    A[加载 MyBatis 配置] --> B[创建 SqlSessionFactory]
    B --> C[获取 SqlSession]
    C --> D[执行数据库操作]
    D --> E{操作成功？}
    E -- 是 --> F[提交事务]
    E -- 否 --> G[回滚事务]
    G --> H[关闭 SqlSession]
    F --> H

解释：流程图展示了使用 MyBatisUtil 工具类获取 SqlSession 的基本流程，包括加载配置、获取 SqlSession、执行数据库操作、事务控制和关闭资源的过程。

五、最佳实践与注意事项 🏅

事务控制：默认情况下，SqlSession 是手动提交的，这意味着在执行完增删改操作后，需要手动调用 commit() 方法提交事务，或在异常情况下调用 rollback() 进行回滚。
资源释放：在每次使用完 SqlSession 后，必须调用 close() 方法释放资源，避免资源泄露导致数据库连接过多。
避免重复创建 SqlSessionFactory：SqlSessionFactory 的创建成本较高，应该在应用启动时一次性创建并重用。工具类通过静态代码块实现了这种单例模式的效果。