Mybatis执行SQL的4大基础组件详解

2022-03-18 21:58:54

温馨提示：本篇是源码分析Mybatis ShardingJdbc SQL语句执行的前置篇。
源码分析Mybatis系列目录：

1、源码分析Mybatis MapperProxy初始化之Mapper对象的扫描与构建
2、源码分析Mybatis MappedStatement的创建流程

1、Executor

sql执行器，其对应的类全路径：org.apache.ibatis.executor.Executor。

1.1 Executor类图

Executor
执行器根据接口，定义update(更新或插入)、query(查询)、commit(提交事务)、rollback(回滚事务)。接下来简单介绍几个重要方法：
- int update(MappedStatement ms, Object parameter) throws SQLException
  更新或插入方法，其参数含义如下：、

1）MappedStatement ms：SQL映射语句（Mapper.xml文件每一个方法对应一个MappedStatement对象）
2）Object parameter：参数，通常是List集合。

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

查询方法，其参数含义如下：
1）RowBounds：行边界，主要值分页参数limit、offset。
2）ResultHandler resultHandler：结果处理器。

- CacheKey createCacheKey(MappedStatement ms, Object parameterObj, RowBounds bounds, BoundSql bSql)

创建缓存Key，Mybatis一二级缓存的缓存Key，可以看出Key由上述4个参数来决定。
1）BoundSql boundSql：可以通过该对象获取SQL语句。

CachingExecutor
支持结果缓存的SQL执行器，注意其设计模式的应用，该类中，会持有Executor的一个委托对象，CachingExecutor关注与缓存特定的逻辑，其最终的SQL执行由其委托对象来实现，即其内部的委托对象为BaseExecutor的实现类。

BaseExecutor
Executor的基础实现类，该类为抽象类，关于查询、更新具体的实现由其子类来实现，下面4个都是其子类。
SimpleExecutor
简单的Executor执行器。
BatchExecutor
支持批量执行的Executor执行器。
ClosedExecutor
表示一个已关闭的Executor。
ReuseExecutor
支持重复使用Statement,以SQL为键，缓存Statement对象。

1.2 创建Executor

在Mybatis中，Executor的创建由Configuration对象来创建，具体的代码如下：

Configuration#newExecitor

public Executor newExecutor(Transaction transaction) {
  return newExecutor(transaction, defaultExecutorType);   // @1
}


public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
  executorType = executorType == null ? defaultExecutorType : executorType;
  executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
  Executor executor;
  if (ExecutorType.BATCH == executorType) {   // @2
    executor = new BatchExecutor(this, transaction);
  } else if (ExecutorType.REUSE == executorType) {
    executor = new ReuseExecutor(this, transaction);
  } else {
    executor = new SimpleExecutor(this, transaction);
  }
  if (cacheEnabled) { // @3
    executor = new CachingExecutor(executor);
  }
  executor = (Executor) interceptorChain.pluginAll(executor);  // @4
  return executor;
}

从上面的代码可以看出，Executor的创建由如下三个关键点：
代码@1：默认的ExecutorType为ExecutorType.SIMPLE，即默认创建的Executory为SimpleExecutor。
代码@2：根据executorType的值创建对应的Executory。
代码@3：如果cacheEnabled为true，则创建CachingExecutory，然后在其内部持有上面创建的Executor,cacheEnabled默认为true，则默认创建的Executor为CachingExecutor，并且其内部包裹着SimpleExecutor。
代码@4：使用InterceptorChain.pluginAll为executor创建代理对象，即Mybatis的拆件机制，将在该系列文章中详细介绍。

2、StatementHandler

在学习StatementHandler之前，我们先来回顾一下JDBC相关的知识。JDBC与语句执行的两大主流对象：java.sql.Statement、java.sql.PrepareStatement对象大家应该不会陌生，该对象的execute方法就是执行SQL语句的入口，通过java.sql.Connection对象创建Statement对象。Mybatis的StatementHandler，是Mybatis创建Statement对象的处理器，即StatementHandler会接管Statement对象的创建。

2.1 StatementHandler类图

StatementHandler
根接口，我们重点关注一下其定义的方法：
- Statement prepare(Connection connection)
  创建Statement对象，即该方法会通过Connection对象创建Statement对象。
- void parameterize(Statement statement)
  对Statement对象参数化，特别是PreapreStatement对象。
- void batch(Statement statement)
  批量执行SQL。
- int update(Statement statement)
  更新操作。
- < E> List< E> query(Statement statement, ResultHandler resultHandler)
  查询操作。
- BoundSql getBoundSql()
  获取SQL语句。
- ParameterHandler getParameterHandler()
  获取对应的参数处理器。
BaseStatementHandler
StatementHandler的抽象实现类，SimpleStatementHandler、PrepareStatementHandler、CallableStatementHandler是其子类。

我们来一一看一下其示例变量：

- Configuration configuration

Mybatis全局配置对象。

- ObjectFactory objectFactory

对象工厂。

- TypeHandlerRegistry typeHandlerRegistry

类型注册器。

- ResultSetHandler resultSetHandler

结果集Handler。

- ParameterHandler parameterHandler

参数处理器Handler。

- Executor executor

SQL执行器。

- MappedStatement mappedStatement

SQL映射语句（Mapper.xml文件每一个方法对应一个MappedStatement对象）

- RowBounds rowBounds

行边界，主要值分页参数limit、offset。

- BoundSql boundSql

可以通过该对象获取SQL语句。

SimpleStatementHandler
具体的StatementHandler实现器，java.sql.Statement对象创建处理器。
PrepareStatementHandler
java.sql.PrepareStatement对象的创建处理器。
CallableStatementHandler
java.sql.CallableStatement对象的创建处理器，可用来执行存储过程调用的Statement。
RoutingStatementHandler
StatementHandler路由器，我们看一下其构造方法后，就会对该类了然于胸。

public RoutingStatementHandler(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {

  switch (ms.getStatementType()) { // @1
    case STATEMENT:
      delegate = new SimpleStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
      break;
    case PREPARED:
      delegate = new PreparedStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
      break;
    case CALLABLE:
      delegate = new CallableStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
      break;
    default:
      throw new ExecutorException("Unknown statement type: " + ms.getStatementType());
  }

}

原来是会根据MappedStatement对象的statementType创建对应的StatementHandler。

2.2 创建StatementHandler

Configuration#newStatementHandler

public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
  StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql); // @1
  statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler); // @2
  return statementHandler;
}

该方法的两个关键点如下：
代码@1：创建RoutingStatementHandler对象，在其内部再根据SQL语句的类型，创建对应的StatementHandler对象。
代码@2：对StatementHandler引入拆件机制，该部分将在该专题的后续文章中会详细介绍，这里暂时跳过。

3、ParameterHandler

参数处理器。同样我们先来看一下其类图。

3.1 ParameterHandler类图

这个比较简单，就是处理PreparedStatemet接口的参数化处理，也可以顺便看一下其调用链(该部分会在下一篇中详细介绍)。

3.2 创建ParameterHandler

Configuration#newParameterHandler

public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
  ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
  parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);  // @1
  return parameterHandler;
}

同样该接口也支持插件化机制。

4、ResultSetHandler

处理结果的Handler。我们同样看一下其类图。

4.1 ResultSetHandler类图

处理Jdbc ResultSet的处理器。

4.2 ResultSetHandler创建

Configuration#newResultSetHandler

public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,
    ResultHandler resultHandler, BoundSql boundSql) {
  ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
  resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
  return resultSetHandler;
}

同样支持插件化机制，我们也稍微再看一下其调用链：

可以看出其调用的入口为SQL执行时。

本文作为下一篇《源码分析Mybatis整合ShardingJdbc SQL执行流程》的前置篇，重点介绍Executor、StatementHandler、ParameterHandler、ResultSetHandler的具体职责，以类图为基础并详细介绍其核心方法的作用，然后详细介绍了这些对象是如何创建，并引出Mybatis拆件机制。

原文发布时间为：2019-05-21
本文作者：丁威，《RocketMQ技术内幕》作者。
本文来自中间件兴趣圈，了解相关信息可以关注中间件兴趣圈。

码农公寓