扒開 SqlSession 的外衣

老規矩，先上案例代碼，我們按照這個案例一步一步的搞定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源碼系列好像什麼時候纔有下文了，爲此老田熬夜寫了這篇。

繼續開擼~~

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();
  }

這個方法中的主要內容有：

下面咱們就來逐個攻破。

建立事務Transaction

事務工廠類型能夠配置爲JDBC類型或者MANAGED類型。

❝

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爲默認類型。

爲何要讓抽象類BaseExecutor實現Executor接口，而後讓具體實現類繼承抽象類呢？

這就是模板方法模式的實現。

❝

模板方法模式就是定義一個算法骨架，並容許子類爲一個或者多個步驟提供實現。模板方法是得子類能夠再不改變算法結構的狀況下，從新定義算法的某些步驟。

❞

關於模板方法模式推薦閱讀：

如何快速掌握模板方法模式

抽象方法是在子類彙總實現的，每種執行器本身實現本身的邏輯，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

好了，到此，執行器建立的就搞定了。

建立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裏保存着配置文件內容。

本文源碼分析的整個流程以下圖：

碼字不易，點個贊唄