Mybatis-工具类实现及解释

我们使用Mybatis时，会显式使用到的类就是以下三个了：

• SqlSessionFactoryBuilder：用来构建SqlSessionFactory的类。
• SqlSessionFactory：用来生产SqlSession的类。
• SqlSession：用来执行对应SQL的类。

Mybatis官方对这三个类的实例提出了一下要求：

SqlSessionFactoryBuilder

这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但是最好还是不要让其一直存在，以保证所有的 XML 解析资源可以被释放给更重要的事情。

我们从官方的建议中得出，该类就是用来创建SqlSessionFactory的，而且创建之后就不会再使用SqlSessionFactoryBuilder，所以我们并不需要让该类长期的占用资源，可以理解为：它就是一个“工具人”，用完就没用了 [/调皮]。

SqlSessionFactory

SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏味道（bad smell）”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

我们从官方的建议中知道，SqlSessionFactory是用于创建SqlSession的，官方建议我们将该类创建后就一直让它持续在内存中，而且建议它是单例的，这样对程序的运行效果是最佳的。

SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架，要考虑 SqlSession 放在一个和 HTTP 请求对象相似的作用域中。 换句话说，每次收到的 HTTP 请求，就可以打开一个 SqlSession，返回一个响应，就关闭它。 这个关闭操作是很重要的，你应该把这个关闭操作放到 finally 块中以确保每次都能执行关闭。

我们从官方得到，该类就是用于执行sql的，它不是线程安全的，不能共享它，而应该是，执行一次，创建一次，执行完之后立马销毁，这样才是最佳的使用方式。

---

所以我们通过官方的建议，将其封装为如下工具类MybatisUtil：

package com.ara.utils;

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;

/**
 * Mybatis工具类
 * 主要用于获取SqlSession
 */
public class MybatisUtil {

    //私有静态 加载就被执行 让其只存在一份在内存中
    private static SqlSessionFactory sqlSessionFactory;

    //通过静态代码块来实例化SqlSessionFactory
    static {
        try {
            //读取Mybatis的配置文件
            InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
            //实例化SqlSessionFactory 
            //因为SqlSessionFactoryBuilder在创建SqlSessionFactory之后就再也不会使用了，所以我们这里直接使用匿名对象创建SqlSessionFactory
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 获取SqlSession对象
     * 值得注意的是：获取的SqlSession对象在使用完毕之后应该立即关闭
     *
     * @return 返回SqlSession对象
     */
    public static SqlSession getSqlSession() {
        //通过SqlSessionFactory创建SqlSession供其他程序使用
        return sqlSessionFactory.openSession();
    }

}

通过上面的工具类，便于我们每次执行SQL时调用，需要注意的就是，SqlSession对象在使用完毕之后一定要关闭，一定要关闭，一定要关闭。