Mybatis源码学习(28)-Mybatis中的执行器BatchExecutor

一、前言

接着前面的《Mybatis中的执行器Executor（一）》继续分析学习Executor。在分析BatchExecutor类之前，先了解一下JDBC的批处理相关知识。

二、JDBC批处理

  批量处理允许将相关的SQL语句分组到批处理中，并通过对数据库的一次调用来提交它们，一次执行完成与数据库之间的交互。需要注意的是：JDBC中的批处理只支持 insert、update 、delete 等类型的SQL语句，不支持select类型的SQL语句。

  一次向数据库发送多个SQL语句时，可以减少通信开销，从而提高性能。

• 不需要JDBC驱动程序来支持此功能。应该使用DatabaseMetaData.supportsBatchUpdates()方法来确定目标数据库是否支持批量更新处理。如果JDBC驱动程序支持此功能，该方法将返回true。
• Statement，PreparedStatement和CallableStatement的addBatch()方法用于将单个语句添加到批处理。 executeBatch()用于执行组成批量的所有语句。
• executeBatch()返回一个整数数组，数组的每个元素表示相应更新语句的更新计数。
• 就像将批处理语句添加到处理中一样，可以使用clearBatch()方法删除它们。此方法将删除所有使用addBatch()方法添加的语句。 但是，无法指定选择某个要删除的语句。

1、使用Statement对象进行批处理的过程

  以下是使用Statement对象的批处理的典型步骤序列

• 使用createStatement()方法创建Statement对象。
• 使用setAutoCommit()将自动提交设置为false。
• 使用addBatch()方法在创建的Statement对象上添加SQL语句到批处理中。
• 在创建的Statement对象上使用executeBatch()方法执行所有SQL语句。
• 最后，使用commit()方法提交所有更改。

2、使用PrepareStatement对象进行批处理

  以下是使用PrepareStatement对象进行批处理的典型步骤顺序 -

• 使用占位符创建SQL语句。
• 使用prepareStatement()方法创建PrepareStatement对象。
• 使用setAutoCommit()将自动提交设置为false。
• 使用addBatch()方法在创建的Statement对象上添加SQL语句到批处理中。
• 在创建的Statement对象上使用executeBatch()方法执行所有SQL语句。
• 最后，使用commit()方法提交所有更改。

三、BatchExecutor类

  BatchExecutor同样继承了BaseExecutor抽象类，实现了批处理多条 SQL 语句的功能。因为JDBC不支持select类型的SQL语句，只支持insert、update、delete类型的SQL语句，所以在BatchExecutor类中，批处理主要针对的是update()方法。BatchExecutor类实现的整体逻辑：其中的doUpdate()方法，主要是把需要批处理的SQL语句通过 statement.addBatch()方法添加到批处理的Statement或PrepareStatement对象中，然后通过doFlushStatements()方法执行Statement的executeBatch()方法执行批处理，在doQueryCursor()方法和doQuery()方法中，首先会执行flushStatements()方法，flushStatements()方法底层其实就是doFlushStatements()方法，所以相当于先把已经添加到Statement或PrepareStatement对象中的批处理语句执行，然后在执行查询操作。

1、构造函数、属性

  public static final int BATCH_UPDATE_RETURN_VALUE = Integer.MIN_VALUE + 1002;
  //缓存多个Statement对象，其中每个Statement对象中都缓存了多条SQL语句
  private final List<Statement> statementList = new ArrayList<Statement>();
  //记录批处理的结果， BatchResult中通过updateCounts字段（ int ［］数纽类型）记录每个Statement执行批处理的结果
  private final List<BatchResult> batchResultList = new ArrayList<BatchResult>();
  //记录当前执行的SQL语句
  private String currentSql;
  //记录当前执行的MappedStatement对象
  private MappedStatement currentStatement;

  public BatchExecutor(Configuration configuration, Transaction transaction) {
    super(configuration, transaction);
  }

2、doUpdate()方法

  该方法主要是把需要批处理的SQL语句通过 statement.addBatch()方法添加到批处理的Statement或PrepareStatement对象中,等待执行批处理。其中主要根据判断当前执行的 SQL 模式与上次执行的SQL模式是否相同且对应的 MappedStatement 对象相同来确定使用已经存在的Statement对象，还是创建新的Statement对象来执行addBatch()操作。

@Override
  public int doUpdate(MappedStatement ms, Object parameterObject) throws SQLException {
    final Configuration configuration = ms.getConfiguration();
    final StatementHandler handler = configuration.newStatementHandler(this, ms, parameterObject, RowBounds.DEFAULT, null, null);
    final BoundSql boundSql = handler.getBoundSql();
    final String sql = boundSql.getSql();
    final Statement stmt;
    if (sql.equals(currentSql) && ms.equals(currentStatement)) {
      int last = statementList.size() - 1;
      stmt = statementList.get(last);
      applyTransactionTimeout(stmt);
      handler.parameterize(stmt);//fix Issues 322
      BatchResult batchResult = batchResultList.get(last);
      batchResult.addParameterObject(parameterObject);
    } else {
      Connection connection = getConnection(ms.getStatementLog());
      stmt = handler.prepare(connection, transaction.getTimeout());
      handler.parameterize(stmt);    //fix Issues 322
      currentSql = sql;
      currentStatement = ms;
      statementList.add(stmt);
      batchResultList.add(new BatchResult(ms, sql, parameterObject));
    }
  // handler.parameterize(stmt);
    handler.batch(stmt);
    return BATCH_UPDATE_RETURN_VALUE;
  }

3、doFlushStatements()方法

  在doFlushStatements()方法中，底层执行了Statement的executeBatch()方法进行批处理操作的提交。其中BatchResult对象保持了一个Statement.executeBatch()方法的执行结果。和JDBC批处理相比，这里相当于封装了多个executeBatch()方法。

@Override
  public List<BatchResult> doFlushStatements(boolean isRollback) throws SQLException {
    try {
      List<BatchResult> results = new ArrayList<BatchResult>();
      //如果明确指定了要回滚事务，则直接返回空集合，忽略 statementList集合中记录的 SQL语句
      if (isRollback) {
        return Collections.emptyList();
      }
      //遍历statementList集合
      for (int i = 0, n = statementList.size(); i < n; i++) {
        Statement stmt = statementList.get(i);
        applyTransactionTimeout(stmt);
        //获取对应BatchResult对象
        BatchResult batchResult = batchResultList.get(i);
        try {
          //调用 Statement.executeBatch()方法批量执行其中记录的 SQL语句，并使用返回的int数组
          //更新 BatchResult.updateCounts字段，其中每一个元素都表示一条 SQL语句影响的记录条数
          batchResult.setUpdateCounts(stmt.executeBatch());
          MappedStatement ms = batchResult.getMappedStatement();
          List<Object> parameterObjects = batchResult.getParameterObjects();
          //获取配置的KeyGenerator对象
          KeyGenerator keyGenerator = ms.getKeyGenerator();
          if (Jdbc3KeyGenerator.class.equals(keyGenerator.getClass())) {
        	//获取数据库生成的主键，并设置到parameterObjects中
            Jdbc3KeyGenerator jdbc3KeyGenerator = (Jdbc3KeyGenerator) keyGenerator;
            jdbc3KeyGenerator.processBatch(ms, stmt, parameterObjects);
          } else if (!NoKeyGenerator.class.equals(keyGenerator.getClass())) { //issue #141
            for (Object parameter : parameterObjects) {
              //对于其他类型的 keyGenerator，会调用其processAfter()方法
              keyGenerator.processAfter(this, ms, stmt, parameter);
            }
          }
          // Close statement to close cursor #1109
          closeStatement(stmt);
        } catch (BatchUpdateException e) {//异常处理
          StringBuilder message = new StringBuilder();
          message.append(batchResult.getMappedStatement().getId())
              .append(" (batch index #")
              .append(i + 1)
              .append(")")
              .append(" failed.");
          if (i > 0) {
            message.append(" ")
                .append(i)
                .append(" prior sub executor(s) completed successfully, but will be rolled back.");
          }
          throw new BatchExecutorException(message.toString(), e, results, batchResult);
        }
        //添加batchResult到results集合中
        results.add(batchResult);
      }
      return results;
    } finally {//关闭或清空对应对象
      for (Statement stmt : statementList) {
        closeStatement(stmt);
      }
      currentSql = null;
      statementList.clear();
      batchResultList.clear();
    }
  }

4、doQuery()方法、doQueryCursor()方法

  在doQuery()、doQueryCursor()方法中，和SimpleExecutro类中的类似，唯一区别在于：首先执行了flushStatements()方法，其中flushStatements()方法底层其实就是doFlushStatements()方法，所以相当于先把已经添加到Statement或PrepareStatement对象中的批处理语句执行，然后在执行查询操作。

 @Override
  public <E> List<E> doQuery(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql)
      throws SQLException {
    Statement stmt = null;
    try {
      flushStatements();
      Configuration configuration = ms.getConfiguration();
      StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameterObject, rowBounds, resultHandler, boundSql);
      Connection connection = getConnection(ms.getStatementLog());
      stmt = handler.prepare(connection, transaction.getTimeout());
      handler.parameterize(stmt);
      return handler.<E>query(stmt, resultHandler);
    } finally {
      closeStatement(stmt);
    }
  }

  @Override
  protected <E> Cursor<E> doQueryCursor(MappedStatement ms, Object parameter, RowBounds rowBounds, BoundSql boundSql) throws SQLException {
    flushStatements();
    Configuration configuration = ms.getConfiguration();
    StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, null, boundSql);
    Connection connection = getConnection(ms.getStatementLog());
    Statement stmt = handler.prepare(connection, transaction.getTimeout());
    handler.parameterize(stmt);
    return handler.<E>queryCursor(stmt);
  }