【MyBatis】作用域&生命周期(四)

🚗MyBatis学习·第四站~
🚩起始站：MyBatis概述&环境搭建(一)
🚩本文已收录至专栏：数据库学习之旅
👍希望您能有所收获

一.引入

为了使用方便，我们经常能看到各种教程都将MyBatis抽离为工具类去读取配置文件，许多人可能会按照自己的想法进行一些修改，如果不理解不同作用域和生命周期类别，可能会由于错误的使用导致非常严重的并发问题。

如果选择使用依赖注入框架则可以创建线程安全的、基于事务的 SqlSession 和映射器，并将它们直接注入到你的 bean 中，可以直接忽略它们的生命周期。否则需要自己多多留意。

二.SqlSessionFactoryBuilder

SqlSessionFactoryBuilder类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。

使用 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 此外也可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但不建议一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。

SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

上述示例SqlSessionFactoryBuilder对象使用完便会被丢弃。

三.SqlSessionFactory

SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。

使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态(static)单例模式。

    private static SqlSessionFactory sqlSessionFactory = null;

    static {
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

例如上述我们可以使用静态代码块实现单例模式，确保SqlSessionFactory只被创建一次。

四.SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，

它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。

以下是错误示例，有的人可能不懂又图使用省事，可能进行如下改造：

    private static SqlSession sqlSession = null;

    static {
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            // 错误×
            sqlSession = sqlSessionFactory.openSession();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。

如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。

在JDK 7版本中出现了一种新的句式： try(资源)，它会自动帮助我们close资源，下面的示例就是一个确保 SqlSession 关闭的标准模式：

try (SqlSession session = sqlSessionFactory.openSession()) {
  // 你的应用逻辑代码
}

在所有代码中都遵循这种使用模式，可以保证所有数据库资源都能被正确地关闭。

五.Mapper映射器实例

映射器是一些绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。

 BlogMapper mapper = session.getMapper(BlogMapper.class);

虽然从技术层面上来讲，任何映射器实例的最大作用域与请求它们的 SqlSession 相同。但方法作用域才是映射器实例的最合适的作用域。 也就是说，映射器实例应该在调用它们的方法中被获取，使用完毕之后即可丢弃。 映射器实例并不需要被显式地关闭。尽管在整个请求作用域保留映射器实例不会有什么问题，但是你很快会发现，在这个作用域上管理太多像 SqlSession 的资源会让你忙不过来。 因此，最好将映射器放在方法作用域内。就像下面的例子一样：

try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // 你的应用逻辑代码
}

六.封装使用示例

网上还有一些使用ThreadLocal优化封装的工具类就不在此赘述，以下为按照上述讲解进行简单封装与使用的示例：

工具类：

public class SqlSessionUtils {
	// 单例模式创建
    private static SqlSessionFactory sqlSessionFactory = null;
	// 使用静态代码块实例化SqlSessionFactory
    static {
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    // 每次调用返回一个SqlSession
    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}

使用：

// 可自动close释放资源，注意需要自己commit提交事务
try (SqlSession sqlSession = SqlSessionUtils.getSqlSession()) {
    // 可以打印查看获取的SqlSession是否为同一对象
    System.err.println(sqlSession);
    // 获取映射器接口的实例
    NewsMapper newsMapper = sqlSession.getMapper(NewsMapper.class);
	// ....业务逻辑
}