如何扒开 SqlSession 的外衣

迷南。 2022-12-31 13:26 111阅读 0赞

关注“Java后端技术全栈”

回复“面试”获取全套面试资料

老规矩，先上案例代码，我们按照这个案例一步一步的搞定Mybatis源码。

public class MybatisApplication {
        public static final String URL = "jdbc:mysql://localhost:3306/mblog";
        public static final String USER = "root";
        public static final String PASSWORD = "123456";
    
        public static void main(String[] args) {
            String resource = "mybatis-config.xml";
            InputStream inputStream = null;
            SqlSession sqlSession = null;
            try {
                inputStream = Resources.getResourceAsStream(resource);
                SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
                sqlSession = sqlSessionFactory.openSession();
                UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
                System.out.println(userMapper.selectById(1));
    
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
                sqlSession.close();
            }
        }

前面我们已经讲了Mybatis是如何解析相关配置文件的，如果怕迷路，还是建议先看前一篇文章：

[Mybatis是如何解析配置文件的？看完终于明白了][Mybatis]

由于很多小伙伴在催，说Mybatis源码系列好像何时才有下文了，为此老田熬夜写了这篇。

![format_png][]

继续开撸~~

SqlSession sqlSession = sqlSessionFactory.openSession();

前面那篇文章已经分析了，这里的sqlSessionFactory其实就是DefaultSqlSessionFactory。

所以这里，我们就从DefaultSqlSessionFactory里的openSession方法开始。

public class DefaultSqlSessionFactory implements SqlSessionFactory {
    
      private final Configuration configuration;
    
      public DefaultSqlSessionFactory(Configuration configuration) {
        this.configuration = configuration;
      }
      //创建session，这个方法直接调用本类中的另外一个方法
      @Override
      public SqlSession openSession() {
        return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
      }
      //其实是调用这个方法
      private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
        Transaction tx = null;
        try {
          //对应xml标签<environments> ,这个在配置文件解析的时候就已经存放到configuration中了。
          final Environment environment = configuration.getEnvironment();
          final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
          tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
          //创建一个executor来执行SQL  
          final Executor executor = configuration.newExecutor(tx, execType);
          //这里也说明了，为什么我们代码里的SqlSession是DefaultSqlSession
          return new DefaultSqlSession(configuration, executor, autoCommit);
        } catch (Exception e) {
          closeTransaction(tx); // may have fetched a connection so lets call close()
          throw ExceptionFactory.wrapException("Error opening session.  Cause: " + e, e);
        } finally {
          ErrorContext.instance().reset();
        }
      }
      
        private TransactionFactory getTransactionFactoryFromEnvironment(Environment environment) {
        if (environment == null || environment.getTransactionFactory() == null) {
          return new ManagedTransactionFactory();
        }
        return environment.getTransactionFactory();
      }

### 这个方法中的主要内容有：    ###

![format_png 1][]

下面我们就来逐个攻破。

### 创建事务Transaction ###

事务工厂类型可以配置为JDBC类型或者MANAGED类型。

![format_png 2][]

> ❝
> 
> JdbcTransactionFactory生产JdbcTransaction。
> 
> ManagedTransactionFactory生产ManagedTransaction。
> 
> ❞

如果配置的JDBC，则会使用Connection对象的commit()、rollback()、close()方法来管理事务。

如果我们配置的是MANAGED，会把事务交给容器来管理，比如JBOSS，Weblogic。因为我们是本地跑的程序，如果配置成MANAGED就会不有任何事务。

但是，如果我们项目中是Spring集成Mybatis，则没有必要配置事务，因为我们会直接在applicationContext.xml里配置数据源和事务管理器，从而覆盖Mybatis的配置。

### 创建执行器Executor ###

调用configuration的`newExecutor`方法创建Executor。

final Executor executor = configuration.newExecutor(tx, execType);
    //Configuration中
    public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
        executorType = executorType == null ? defaultExecutorType : executorType;
        executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
        Executor executor;
        //第一步
        if (ExecutorType.BATCH == executorType) {
          executor = new BatchExecutor(this, transaction);
        } else if (ExecutorType.REUSE == executorType) {
          executor = new ReuseExecutor(this, transaction);
        } else {
          executor = new SimpleExecutor(this, transaction);
        }
        //第二步
        if (cacheEnabled) {
          executor = new CachingExecutor(executor);
        }
        //第三步
        executor = (Executor) interceptorChain.pluginAll(executor);
        return executor;
      }

此方法分三个步骤。

#### 第一步：创建执行器 ####

Executor的基本类型有三种：

public enum ExecutorType {
      SIMPLE, REUSE, BATCH
    }

SIMPLE为默认类型。

![format_png 3][]

为什么要让抽象类BaseExecutor实现Executor接口，然后让具体实现类继承抽象类呢？

这就是模板方法模式的实现。

> ❝
> 
> 模板方法模式就是定义一个算法骨架，并允许子类为一个或者多个步骤提供实现。模板方法是得子类可以再不改变算法结构的情况下，重新定义算法的某些步骤。
> 
> ❞

关于模板方法模式推荐阅读：

[如何快速掌握模板方法模式][Link 1]

抽象方法是在子类汇总实现的，每种执行器自己实现自己的逻辑，BaseExecutor最终会调用到具体的子类中。

##### 抽象方法 #####

protected abstract int doUpdate(MappedStatement ms, Object parameter) throws SQLException;
    
    protected abstract List<BatchResult> doFlushStatements(boolean isRollback) throws SQLException;
    
    protected abstract <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException;
    
    protected abstract <E> Cursor<E> doQueryCursor(MappedStatement ms, Object parameter, RowBounds rowBounds, BoundSql boundSql)  throws SQLException;

#### 第二步：缓存装饰 ####

在上面代码中的第二步

if (cacheEnabled) {
          executor = new CachingExecutor(executor);
    }

如果`cacheEnabled=true`，会用装饰器设计模式对Executor进行装饰。

#### 第三步：插件代理 ####

缓存装饰完后，就会执行

executor = (Executor) interceptorChain.pluginAll(executor);

这里会对Executor植入插件逻辑。

比如：分页插件中就需要把插件植入的Executor

![format_png 4][]

好了，到此，执行器创建的就搞定了。

### 创建DefaultSqlSession对象 ###

把前面解析配置文件创建的Configuration对象和创建的执行器Executor赋给DefaultSqlSession中的属性。

public DefaultSqlSession(Configuration configuration, Executor executor, boolean autoCommit) {
      this.configuration = configuration;
      this.executor = executor;
      this.dirty = false;
      this.autoCommit = autoCommit;
    }

到这里，SqlSession（DefaultSqlSession）对象就创建完毕。

### 总结 ###

本文我们讲了如何创建SqlSession的几个步骤，最后我们获得一个DefaultSqlSession对象，里面包含了执行器Executor和配置对象Configuration。Executor是SQL的实际执行对象。Configuration里保存着配置文件内容。

本文源码分析的整个流程如下图：

![format_png 5][]

**码字不易，给个在看，点个赞呗**

推荐阅读

[面试官：Mybatis里的设计模式有哪些？我一口气答了8种][Mybatis_8]

[面试官问我：能说几个常见的Linux性能调优命令吗？][Linux]

[吊打面试官系列：说说hashCode和equals方法][hashCode_equals]

[《程序员面试宝典》.pdf下载][.pdf]

[JVM真香系列：如何判断对象是否可被回收？][JVM]

![format_png 6][]

[Mybatis]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd554541ca22cc57af8d3df7c81421dbbc991240323ae9c16e32c70b80683a1406c9f8f45330&idx=1&mid=2247495082&scene=21&sn=7dfd8ce506deffb2924e32c085d1849e#wechat_redirect
[format_png]: /images/20221120/4dd666ebb35f4e81a0bfa647300da63f.png
[format_png 1]: /images/20221120/6cd1bf30ffa64a1b8846e15e44fd6224.png
[format_png 2]: /images/20221120/a1a7177170894f4ead45e0fdfc64d127.png
[format_png 3]: /images/20221120/d83c4dc5a1524cf79a5832b905abb12b.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd554efcca22c7eabbc62133de387d4636e28d29d3890f65a50c77e492f2cf606ffc522b50f5&idx=1&mid=2247493143&scene=21&sn=4ae3087480c9e8dbbaa9ec0f3189ba7a#wechat_redirect
[format_png 4]: /images/20221120/532f83e9a7394e62ac7907d3e91c8d78.png
[format_png 5]: /images/20221120/80190571725a4da4bb885ad0722a7b98.png
[Mybatis_8]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd55468eca22cf98fcc1a143c9c37e607625516fd0f0c1cc3419419cf369bbe52775792210d0&idx=1&mid=2247495269&scene=21&sn=8df119e4b5cf6b594048e5bd01b47521#wechat_redirect
[Linux]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd5544a4ca22cdb2d0d3524822cdb9bcac75dfb5d6fd5a1eaf65c7f65bfdd2e83f601f4eb179&idx=1&mid=2247494735&scene=21&sn=f82250247c3eb781e54ad8d1d3ca5dde#wechat_redirect
[hashCode_equals]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd5543f0ca22cae69adf58aafbd4757d9cc1f6bf67dfee16cfceeaca386e8d5d537a55cb3ee8&idx=1&mid=2247494427&scene=21&sn=e3034f9f8905711873f809f5f17a2f5a#wechat_redirect
[.pdf]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd5540c2ca22c9d43adaea71eac78fd27ccbc395d86ab9a0bd7058ec846752854ba6891c29aa&idx=2&mid=2247493673&scene=21&sn=56f250a42913fed1b56fe6be41810b56#wechat_redirect
[JVM]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd5540c2ca22c9d40f0d49f9af7081dd14656a8a1d184d934a0b50adb22b0a7ffe0233cbdcf3&idx=1&mid=2247493673&scene=21&sn=b302f71066ab185fe00aa0f75ce570c4#wechat_redirect
[format_png 6]: /images/20221120/0471ec53886e4f77aaa4ae55c00a59a1.png