天天看點
傳回

MyBatis 核心配置綜述之Executor

目錄

    • MyBatis四大元件之 Executor執行器
      • Executor的繼承結構
      • Executor建立過程以及源碼分析
      • Executor接口的主要方法
      • Executor 的現實抽象

上一篇我們對SqlSession和SqlSessionFactory的建立過程有了一個詳細的了解，但上述的建立過程隻是為SQL執行和SQL映射做了基礎的鋪墊而已，就和我們Spring源碼為Bean容器的加載進行許多初始化的工作相同，那麼做好前期的準備工作接下來該做什麼了？該做資料庫連接配接驅動管理和SQL解析工作了！那麼本篇本章就來讨論一下資料庫驅動連接配接管理和SQL解析的管理元件之 Executor執行器。

MyBatis四大元件之 Executor執行器

每一個SqlSession都會擁有一個Executor對象，這個對象負責增删改查的具體操作，我們可以簡單的将它了解為JDBC中Statement的封裝版。

Executor的繼承結構

MyBatis 核心配置綜述之Executor

如圖所示，位于繼承體系最頂層的是Executor執行器，它有兩個實作類，分别是

BaseExecutor

和

CachingExecutor

。

BaseExecutor

是一個抽象類，這種通過抽象的實作接口的方式是

擴充卡設計模式之接口适配

的展現，是Executor的預設實作，實作了大部分Executor接口定義的功能，降低了接口實作的難度。BaseExecutor的子類有三個，分别是

SimpleExecutor

、

ReuseExecutor

和

BatchExecutor

。

SimpleExecutor: 簡單執行器，是MyBatis中預設使用的執行器，每執行一次update或select，就開啟一個Statement對象，用完就直接關閉Statement對象(可以是Statement或者是PreparedStatment對象)

ReuseExecutor: 可重用執行器，這裡的重用指的是重複使用Statement，它會在内部使用一個Map把建立的Statement都緩存起來，每次執行SQL指令的時候，都會去判斷是否存在基于該SQL的Statement對象，如果存在Statement對象并且對應的connection還沒有關閉的情況下就繼續使用之前的Statement對象，并将其緩存起來。因為每一個SqlSession都有一個新的Executor對象，是以我們緩存在ReuseExecutor上的Statement作用域是同一個SqlSession。

BatchExecutor: 批處理執行器，用于将多個SQL一次性輸出到資料庫

CachingExecutor

: 緩存執行器，先從緩存中查詢結果，如果存在，就傳回；如果不存在，再委托給Executor delegate 去資料庫中取，delegate可以是上面任何一個執行器

Executor建立過程以及源碼分析

上面我們分析完SqlSessionFactory的建立過程的準備工作後，我們下面就開始分析會話的建立以及Executor的執行過程。

在建立完SqlSessionFactory之後，調用其

openSession

方法:

SqlSession sqlSession = factory.openSession();

SqlSessionFactory的預設實作是DefaultSqlSessionFactory，是以我們需要關心的就是DefaultSqlSessionFactory中的openSession()方法

openSession調用的是

openSessionFromDataSource

方法，傳遞執行器的類型，方法傳播級别，是否自動送出，然後在openSessionFromDataSource方法中會建立一個執行器

public SqlSession openSession() {
  return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);
}

private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
    Transaction tx = null;
    try {
      // 得到configuration 中的environment
      final Environment environment = configuration.getEnvironment();
      // 得到configuration 中的事務工廠
      final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
      tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
      // 擷取執行器
      final Executor executor = configuration.newExecutor(tx, execType);
      // 傳回預設的SqlSession
      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();
    }
  }

調用newExecutor方法，根據傳入的ExecutorType類型來判斷是哪種執行器，然後執行相應的邏輯

public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
    // defaultExecutorType預設是簡單執行器, 如果不傳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);
    }
    // 如果允許緩存，則使用緩存執行器
    // 預設是true，如果不允許緩存的話，需要手動設定
    if (cacheEnabled) {
      executor = new CachingExecutor(executor);
    }
    // 插件開發。
    executor = (Executor) interceptorChain.pluginAll(executor);
    return executor;
  }

ExecutorType的選擇：

ExecutorType來決定Configuration對象建立何種類型的執行器，它的指派可以通過兩個地方進行指派：

  • 可以通過标簽來設定目前工程中所有的SqlSession對象使用預設的Executor 
<settings>
<!--取值範圍 SIMPLE, REUSE, BATCH -->
  <setting name="defaultExecutorType" value="SIMPLE"/>
</settings>
  • 另外一種直接通過Java對方法指派的方式 
session = factory.openSession(ExecutorType.BATCH);
ExecutorType是一個枚舉，它隻有三個值SIMPLE, REUSE, BATCH

建立完成Executor之後，會把Executor執行器放入一個DefaultSqlSession對象中來對四個屬性進行指派，他們分别是

configuration

、

executor

、

dirty

、

autoCommit

。

Executor接口的主要方法

Executor接口的方法還是比較多的，這裡我們就幾個主要的方法和調用流程來做一個簡單的描述

大緻流程

Executor中的大部分方法的調用鍊其實是差不多的，下面都是深入源碼分析執行過程，如果你沒有時間或者暫時不想深入研究的話，給你下面的執行流程圖作為參考。

MyBatis 核心配置綜述之Executor

query()方法

query方法有兩種形式，一種是直接查詢；一種是從緩存中查詢，下面來看一下源碼

<E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey cacheKey, BoundSql boundSql) throws SQLException;

<E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException;

當有一個查詢請求通路的時候，首先會經過Executor的實作類CachingExecutor，先從緩存中查詢SQL是否是第一次執行，如果是第一次執行的話，那麼就直接執行SQL語句，并建立緩存，如果第二次通路相同的SQL語句的話，那麼就會直接從緩存中提取

CachingExecutor.j

// 第一次查詢，并建立緩存
public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
  BoundSql boundSql = ms.getBoundSql(parameterObject);
  CacheKey key = createCacheKey(ms, parameterObject, rowBounds, boundSql);
  return query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
}

MapperStatement

 維護了一條<select|update|delete|insert>節點的封裝，包括資源(resource)，配置(configuration)，SqlSource(sql源檔案)等。使用Configuration的getMappedStatement方法來擷取MappedStatement對象
MyBatis 核心配置綜述之Executor

BoundSql

 這個類包括SQL的基本資訊，基本的SQL語句，參數映射，參數類型等
MyBatis 核心配置綜述之Executor

上述的query方法會調用到CachingExecutor類中的query查詢緩存的方法

public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
  throws SQLException {
  // 得到緩存
  Cache cache = ms.getCache();
  if (cache != null) {
    // 如果需要的話重新整理緩存
    flushCacheIfRequired(ms);
    if (ms.isUseCache() && resultHandler == null) {
      ensureNoOutParams(ms, boundSql);
      @SuppressWarnings("unchecked")
      List<E> list = (List<E>) tcm.getObject(cache, key);
      if (list == null) {
        list = delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
        tcm.putObject(cache, key, list); 
      }
      return list;
    }
  }
  // 委托模式，交給SimpleExecutor等實作類去實作方法。
  return delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
}

由delegate執行query方法，delegate即是BaseExecutor，然後由具體的執行器去真正執行query方法

注意：源碼中一般以do** 開頭的方法都是真正加載執行的方法 
// 經過一系列的調用，會調用到下面的方法(與主流程無關，故省略)
// 以SimpleExecutor簡單執行器為例
public <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
  Statement stmt = null;
  try {
    // 擷取環境配置
    Configuration configuration = ms.getConfiguration();
    // 建立StatementHandler，解析SQL語句
    StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, resultHandler, boundSql);
    stmt = prepareStatement(handler, ms.getStatementLog());
    // 由handler來對SQL語句執行解析工作
    return handler.<E>query(stmt, resultHandler);
  } finally {
    closeStatement(stmt);
  }
}

由上面的源碼可以看出，Executor執行器所起的作用相當于是管理StatementHandler 的整個生命周期的工作，包括建立、初始化、解析、關閉。

ReuseExecutor完成的doQuery 工作：幾乎和SimpleExecutor完成的工作一樣，其内部不過是使用一個Map來存儲每次執行的查詢語句，為後面的SQL重用作準備。

BatchExecutor完成的doQuery 工作：和SimpleExecutor完成的工作一樣。

update() 方法

在分析完上面的查詢方法後，我們再來聊一下update()方法，update()方法不僅僅指的是update()方法，它是一條update鍊，什麼意思呢？就是*insert、update、delete在語義上其實都是更新的意思，而查詢在語義上僅僅隻是表示的查詢，那麼我們來偷窺一下update方法的執行流程，與select的主要執行流程很相似，是以一次性貼出。

// 首先在***接口中定義update 方法，交由子類或者抽象子類去實作

// 也是首先去緩存中查詢是否具有已經執行過的相同的update語句
public int update(MappedStatement ms, Object parameterObject) throws SQLException {
  flushCacheIfRequired(ms);
  return delegate.update(ms, parameterObject);
}

// 然後再交由BaseExecutor 執行update 方法
public int update(MappedStatement ms, Object parameter) throws SQLException {
  ErrorContext.instance().resource(ms.getResource()).activity("executing an update").object(ms.getId());
  if (closed) {
    throw new ExecutorException("Executor was closed.");
  }
  clearLocalCache();
  return doUpdate(ms, parameter);
}

// 往往do* 開頭的都是真正執行解析的方法，是以doUpdate 應該就是真正要執行update鍊的解析方法了
// 交給具體的執行器去執行
public int doUpdate(MappedStatement ms, Object parameter) throws SQLException {
  Statement stmt = null;
  try {
    Configuration configuration = ms.getConfiguration();
    StatementHandler handler = configuration.newStatementHandler(this, ms, parameter, RowBounds.DEFAULT, null, null);
    stmt = prepareStatement(handler, ms.getStatementLog());
    return handler.update(stmt);
  } finally {
    closeStatement(stmt);
  }
}

ReuseExecutor完成的doUpdate 工作：幾乎和SimpleExecutor完成的工作一樣，其内部不過是使用一個Map來存儲每次執行的更新語句，為後面的SQL重用作準備。

BatchExecutor完成的doUpdate 工作：和SimpleExecutor完成的工作相似，隻是其内部有一個List清單來一次行的存儲多個Statement，用于将多個sql語句一次性輸送到資料庫執行.

queryCursor()方法

我們查閱其源碼的時候，在執行器的執行過程中并沒有發現其與query方法有任何不同之處，但是在doQueryCursor 方法中我們可以看到它傳回了一個cursor對象，網上搜尋cursor的相關資料并查閱其基本結構，得出來的結論是：用于逐條讀取SQL語句，應對資料量

// 查詢可以傳回Cursor<T>類型的資料，類似于JDBC裡的ResultSet類，
// 當查詢百萬級的資料的時候，使用遊标可以節省記憶體的消耗，不需要一次性取出所有資料，可以進行逐條處理或逐條取出部分批量處理。
public interface Cursor<T> extends Closeable, Iterable<T> {

    boolean isOpen();

    boolean isConsumed();
  
    int getCurrentIndex();
}

flushStatements() 方法

flushStatement()的主要執行流程和query，update 的執行流程差不多，我們這裡就不再詳細貼代碼了，簡單說一下flushStatement()的主要作用，flushStatement()主要用來釋放statement，或者用于ReuseExecutor和BatchExecutor來重新整理緩存

createCacheKey() 方法

createCacheKey()方法主要由BaseExecutor來執行并建立緩存，MyBatis中的緩存分為一級緩存和二級緩存，關于緩存的讨論我們将在Mybatis系列的緩存章節

Executor 中的其他方法

Executor 中還有其他方法，送出commit，復原rollback，判斷是否時候緩存isCached，關閉close，擷取事務getTransaction一級清除本地緩存clearLocalCache等

Executor 的現實抽象

在上面的分析過程中我們了解到，Executor執行器是MyBatis中很重要的一個元件，Executor相當于是外包的boss，它定義了甲方(SQL)需要幹的活(Executor的主要方法)，這個外包公司是個小公司，沒多少人，每個人都需要幹很多工作，boss接到開發任務的話，一般都找項目經理(CachingExecutor)，項目經理幾乎不懂技術，它主要和技術leader(BaseExecutor)打交道，技術leader主要負責架構的搭建，具體的工作都會交給下面的程式員來做，程式員的技術也有優劣，進階程式員(BatchExecutor)、中級程式員(ReuseExecutor)、初級程式員(SimpleExecutor)，它們幹的活也不一樣。一般有新的項目需求傳達到項目經理這裡，項目經理先判斷自己手裡有沒有現成的類庫或者項目直接套用(Cache)，有的話就直接讓技術leader拿來直接套用就好，沒有的話就需要搭建架構，再把架構存入本地類庫中，再進行解析。

(本文完)

下文預告： MyBatis 核心配置綜述之StatementHandler

文章參考：

https://www.jianshu.com/p/19686af69b0d

http://www.mybatis.org/mybatis-3/getting-started.html

https://www.cnblogs.com/virgosnail/p/10067964.html

MybatisJava
上一篇: 【POJ - 1426】Find The Multiple（dfs）
下一篇: 靜态路由實驗配置舉例

繼續閱讀