Executor 執(zhí)行器

今天分享一下 Executor。它在框架中是具體sql的執(zhí)行器偶房，sqlSession（門面模式）封裝通用的api，把具體操作委派給 Executor 執(zhí)行军浆，Executor協(xié)同BoundSql棕洋，StatementHandler，ParameterHandler 和 ResultSetHandler 完成工作乒融。

它使用裝飾器的方式組織 Executor 對象掰盘。如 CachingExecutor 裝飾了SimpleExecutor 提供二級緩存功能。

可以通過插件機(jī)制擴(kuò)展功能赞季。mybatisplus 就是通過插件機(jī)制擴(kuò)展的功能愧捕。

下面是更新流程，Executor 處于流程中間藍(lán)色部分申钩，緩存執(zhí)行器次绘，基礎(chǔ)執(zhí)行器，簡單執(zhí)行器三個 Executor 通過責(zé)任鏈的方式組織起來撒遣，各司其職邮偎，一同完成執(zhí)行工作。义黎，可以感受到它的作用是承上啟下禾进。

更新流程圖片來自 http://coderead.cn/

執(zhí)行器介紹

Executor 的繼承關(guān)系

Mybatis 一共提供了四種執(zhí)行器的實(shí)現(xiàn)和一個模板類：

基礎(chǔ)執(zhí)行器 BaseExecutor：實(shí)現(xiàn)Executor接口的抽象類，實(shí)現(xiàn)了框架邏輯轩缤，具體的邏輯委派給子類實(shí)現(xiàn)命迈。一級緩存也是在這里實(shí)現(xiàn)的。
緩存執(zhí)行器 CachingExecutor：實(shí)現(xiàn)了二級緩存火的，是jvm級別的全局緩存壶愤。
簡單執(zhí)行器 SimpleExecutor：繼承自 BaseExecutor，具體執(zhí)行邏輯的實(shí)現(xiàn)馏鹤。
重用執(zhí)行器 ReuseExecutor：相同的 sql 只會預(yù)編譯一次征椒。
批處理執(zhí)行器 BatchExecutor：批處理執(zhí)行器使用 JDBC 的batch API 執(zhí)行 SQL 的批量操作，如insert 或者 update湃累。select的邏輯和 SimpleExecutor 的實(shí)現(xiàn)一樣勃救。

今天介紹 SimpleExecutor，ReuseExecutor 和 BatchExecutor 三個執(zhí)行器的特定和邏輯治力， CachingExecutor 的功能是提供二級緩存蒙秒，暫時不在這里介紹。

SimpleExecutor

簡單執(zhí)行器顧名思義宵统，處理的邏輯比較簡單直接晕讲，來一個 sql 預(yù)編譯一個，處理一個马澈。
示例代碼如下：

// 創(chuàng)建 SimpleExecutor 
SimpleExecutor simpleExecutor = new SimpleExecutor(sessionFactory.getConfiguration(),
jdbcTransaction);
// 獲取 MappedStatement 
final MappedStatement ms = sessionFactory.getConfiguration().getMappedStatement("example.mapper.UserMapper.getUserByID");
final BoundSql boundSql = ms.getBoundSql(1);
// 執(zhí)行 2 次查詢
simpleExecutor.doQuery(ms, 1, RowBounds.DEFAULT, Executor.NO_RESULT_HANDLER, boundSql);
simpleExecutor.doQuery(ms, 1, RowBounds.DEFAULT, Executor.NO_RESULT_HANDLER, boundSql);

執(zhí)行結(jié)果：


[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==>  Preparing: select * from `user` where id = ? 
[DEBUG][main] m.p.ThresholdInterceptor.intercept ThresholdInterceptor plugin... 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==> Parameters: 1(Integer) 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug <==      Total: 1 

[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==>  Preparing: select * from `user` where id = ? 
[DEBUG][main] m.p.ThresholdInterceptor.intercept ThresholdInterceptor plugin... 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==> Parameters: 1(Integer) 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug <==      Total: 1

通過日志看到瓢省，雖然執(zhí)行相同的 sql 但是每次都要執(zhí)行預(yù)編譯。這是一個需要優(yōu)化的點(diǎn)痊班。

ReuseExecutor

ReuseExecutor 對相同 SQL 重復(fù)編譯做了優(yōu)化勤婚，相同的 sql 的 Statement 只創(chuàng)建一個。

示例代碼上面一樣涤伐，只是把 SimpleExecutor 換成 ReuseExecutor 馒胆。
從執(zhí)行我們看到，Preparing 只有一次凝果，執(zhí)行結(jié)果也是正確的：

[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==>  Preparing: select * from `user` where id = ? 
[DEBUG][main] m.p.ThresholdInterceptor.intercept ThresholdInterceptor plugin... 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==> Parameters: 1(Integer) 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug <==      Total: 1 

[DEBUG][main] m.p.ThresholdInterceptor.intercept ThresholdInterceptor plugin... 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==> Parameters: 1(Integer) 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug <==      Total: 1

他是怎么做到的呢国章？翻開代碼看看實(shí)現(xiàn)，其實(shí)邏輯也很簡單豆村，用 SQL 當(dāng)作 key 保存對應(yīng)的 Statement 來實(shí)現(xiàn)重用液兽。

  private Statement prepareStatement(StatementHandler handler, Log statementLog) throws SQLException {
    Statement stmt;
    BoundSql boundSql = handler.getBoundSql();
    String sql = boundSql.getSql();
    // 關(guān)鍵邏輯，通過 sql 判斷是否已經(jīng)創(chuàng)建了 Statement掌动，如果有則重用四啰。
    if (hasStatementFor(sql)) {
      stmt = getStatement(sql);
      applyTransactionTimeout(stmt);
    } else {
      Connection connection = getConnection(statementLog);
      stmt = handler.prepare(connection, transaction.getTimeout());
      putStatement(sql, stmt);
    }
    handler.parameterize(stmt);
    return stmt;
  }
  private final Map<String, Statement> statementMap = new HashMap<>();
  private boolean hasStatementFor(String sql) {
    try {
      Statement statement = statementMap.get(sql);
      return statement != null && !statement.getConnection().isClosed();
    } catch (SQLException e) {
      return false;
    }
  }

BatchExecutor

有些場景下，我們要批量保存或者刪除粗恢，更新數(shù)據(jù)柑晒，這時候我們一條一條的執(zhí)行效率就會很低，需要一個批量執(zhí)行的機(jī)制眷射。

JDBC 批量操作

批量操作可以把相關(guān)的sql打包成一個 batch匙赞，一次發(fā)送到服務(wù)器佛掖，減少和服務(wù)器的交互，也就是 RTT 時間涌庭。

使用批量操作前要確認(rèn)服務(wù)器是否支持批量操作芥被，可通過 DatabaseMetaData.supportsBatchUpdates() 方法的返回值來判斷。

實(shí)例代碼坐榆，通過 JDBC 提供的 API 執(zhí)行批量操作拴魄。

Connection conn = DriverManager.getConnection(DB_URL, USER, PASS);

DatabaseMetaData metaData = conn.getMetaData();
System.out.println("metaData.supportsBatchUpdates() = " + metaData.supportsBatchUpdates());

//執(zhí)行 sql
System.out.println("Creating statement...");
String sql = "update user set name=? where id = ?";
pstmt = conn.prepareStatement(sql);

// 設(shè)置變量
pstmt.setString(1, "Pappu");
pstmt.setInt(2, 1);
// 添加到 batch
pstmt.addBatch();

// 設(shè)置變量
pstmt.setString(1, "Pawan");
pstmt.setInt(2, 2);
// 添加到 batch
pstmt.addBatch();

//執(zhí)行，并獲取結(jié)果
int[] count = pstmt.executeBatch();

Mybatis 如何實(shí)現(xiàn)

Mybatis 只有對 update 有支持批量操作席镀，并且需要手動 flushStatements匹中。

insert、delete豪诲、update顶捷，都是update操作

    BatchExecutor batchExecutor = new BatchExecutor(configuration, jdbcTransaction);

    final MappedStatement update = configuration
        .getMappedStatement("dm.UserMapper.updateName");
    final MappedStatement delete = configuration
        .getMappedStatement("dm.UserMapper.deleteById");
    final MappedStatement get = sessionFactory.getConfiguration()
        .getMappedStatement("dm.UserMapper.getUserByID");
    final MappedStatement insertUser = sessionFactory.getConfiguration()
        .getMappedStatement("dm.UserMapper.insertUser");

    // query
    batchExecutor.doUpdate(insertUser, new User().setName("" + new Date()));
    batchExecutor.doUpdate(insertUser, new User().setName("" + new Date()));

    // batch update
    User user = new User();
    user.setId(2);
    user.setName("" + new Date());
    batchExecutor.doUpdate(update, user);

    user.setId(3);
    batchExecutor.doUpdate(update, user);

    batchExecutor.doUpdate(insertUser, new User().setName("" + new Date()));

    //
    final List<BatchResult> batchResults = batchExecutor.flushStatements(false);
    jdbcTransaction.commit();
    printBatchResult(batchResults);

執(zhí)行日志：

[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==>  Preparing: insert into `user` (name) values(?); 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==> Parameters: Sat Jul 04 15:07:30 CST 2020(String) 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==> Parameters: Sat Jul 04 15:07:30 CST 2020(String) 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==>  Preparing: update `user` set name=? where id = ? 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==> Parameters: Sat Jul 04 15:07:30 CST 2020(String), 2(Integer) 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==> Parameters: Sat Jul 04 15:07:30 CST 2020(String), 3(Integer) 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==>  Preparing: insert into `user` (name) values(?); 
[DEBUG][main] o.a.i.l.j.BaseJdbcLogger.debug ==> Parameters: Sat Jul 04 15:07:30 CST 2020(String) 
[DEBUG][main] o.a.i.t.j.JdbcTransaction.commit Committing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@4b3ed2f0] 
第 1 個結(jié)果
[1, 1]
第 2 個結(jié)果
[1, 1]
第 3 個結(jié)果
[1]

從日志可以看到看到清晰的執(zhí)行過程。

第一個insert語句后面跟著兩個參數(shù)屎篱，是一個statement焊切。對應(yīng)第 1 個結(jié)果
第二個update語句后面跟著兩個參數(shù)，是一個statement芳室。對應(yīng)第 2 個結(jié)果
第三個insert語句后面跟著兩個參數(shù)专肪，是一個statement。對應(yīng)第 3 個結(jié)果

整體邏輯和程序是一致的堪侯，但是有個問題嚎尤，為什么三個相同的 insert，會分開兩個結(jié)果返回呢伍宦？

這是因?yàn)?Mybatis 為了保證批次和邏輯順序一致做了優(yōu)化芽死，并不是相同的sql就放到相同的statement。而是要按照執(zhí)行順序把相同的sql當(dāng)作一個批次次洼。

從代碼中可以看到這部分邏輯：

public int doUpdate(MappedStatement ms, Object parameterObject) throws SQLException {
  if (sql.equals(currentSql) && ms.equals(currentStatement)) {
    使用當(dāng)前的 statement
  } else {
    創(chuàng)建新的statement
  }
}

總結(jié)

網(wǎng)絡(luò)上有些文章介紹使用 foreach 的方式執(zhí)行批量操作关贵，我個人不建議這樣操作。

因?yàn)?JDBC 已經(jīng)提供了批量操作的接口卖毁，符合規(guī)范揖曾，兼容性和性能更好。
foreach拼接的 sql 比較長亥啦，會增加網(wǎng)絡(luò)流量炭剪，而且驅(qū)動對sql長度是有限制的，并且要增加allowMultiQueries參數(shù)翔脱。
foreach 拼接的 sql 每次都不一定相同奴拦，服務(wù)器會重新編譯。

Mysql 的 sql 執(zhí)行流程是連接器届吁，查詢緩存错妖，分析器绿鸣，優(yōu)化器，執(zhí)行器暂氯。分析器先會做“詞法分析”潮模。優(yōu)化器是在表里面有多個索引的時候，決定使用哪個索引株旷；或者在一個語句有多表關(guān)聯(lián)（join）的時候再登，決定各個表的連接順序尔邓。在適合的場景使用 ReuseExecutor 或 BatchExecutor 不僅可以提高性能晾剖，還可以減少對 Mysql 服務(wù)器的壓力。

參考

更新流程圖片來自源碼閱讀網(wǎng)

Mybatis 執(zhí)行器雀瓢，執(zhí)行一個sql分這么多種類型

Mybatis 執(zhí)行器障斋，執(zhí)行一個sql分這么多種類型