Mybatis源码(七)：SQL执行流程

　　SQL执行通过接口代理对象调用接口方法完成的。在Mybatis中所有Mapper接口代理对象都是JDK动态代理生成的，最终都会调用MapperProxy中的invoke方法。Mapper接口代理对象执行接口方法，MapperProxy#invoke() 核心代码：

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  try {
    // 如果目标方法为Object中的方法(toString hashCode equals getClass...),则直接调用目标方法
    if (Object.class.equals(method.getDeclaringClass())) {
      return method.invoke(this, args);
    // 接口中默认实现的方法
    } else if (isDefaultMethod(method)) {
      return invokeDefaultMethod(proxy, method, args);
    }
  } catch (Throwable t) {
    throw ExceptionUtil.unwrapThrowable(t);
  }
  // 普通方法的处理
  // 获取缓存中的MapperMethod -> 获取映射方法详情：1、目标方法全限定名；2、目标方法sql类型；3、目标方法的参数及返回值处理
  final MapperMethod mapperMethod = cachedMapperMethod(method);
  // 根据sql命令类型，执行sql
  return mapperMethod.execute(sqlSession, args);
}

　　若要执行的方法为Object中的方法(toString hashCode equals getClass...), 直接执行目标方法；若要执行的方法为接口实现的方法，通过反射获取对象实例，绑定代理对象，执行目标方法。Mybatis中Mapper接口定义的预数据库相关的方法都是普通方法，无法满足上述条件，我们接着往下看普通方法的处理：

1、MapperProxy#cachedMapperMethod()

　　获取映射方法，MapperProxy#cachedMapperMethod() 核心代码：

// 用于缓存MapperMethod对象，key是mapper接口中方法对应的Method对象，value是对应的MapperMethod对象,MapperMethod对象会完成参数转换
// 以及SQL语句的执行功能，MapperMethod中未记录状态相关的信息，可以在多个代理对象之间共享
private final Map<Method, MapperMethod> methodCache;

// 获取MapperMethod对象
private MapperMethod cachedMapperMethod(Method method) {
  return methodCache.computeIfAbsent(method, k -> new MapperMethod(mapperInterface, method, sqlSession.getConfiguration()));
}

　　MapperMethod中有两个关键属性，SqlCommand和MethodSignature。SqlCommand存储SQL语句相关信息；MethodSignature存储Mapper接口中方法相关信息。MapperMethod的构造函数详情：

// Mapper接口方法
public class MapperMethod {

  // 记录了SQL语句的名称和类型
  private final SqlCommand command;
  // mapper接口中对应方法的相关信息
  private final MethodSignature method;

  public MapperMethod(Class<?> mapperInterface, Method method, Configuration config) {
    this.command = new SqlCommand(config, mapperInterface, method); // 获取唯一标识(类限定名+方法名称)、获取sql命令类型
    this.method = new MethodSignature(config, mapperInterface, method);
  }
  // ...
}

1、SqlCommand

　　SqlCommand为MapperMethod的静态内部类，主要包含了目标执行方法的全限定名、目标执行方法对应sql的类型(增/删/改/查)，持有两个关键属性，name和type。name为 全限定接口 + 方法名；type为 当前SQL语句类型，用于辨别增删改查语句。

// 方法的全限定名 -> 全限定类名 + 方法名
private final String name;
// SQL语句类型 insert|update|delete|select
private final SqlCommandType type;

　　下面来看看SqlCommand的构造函数，这两个属性是在哪获取的，构造函数详情：

public SqlCommand(Configuration configuration, Class<?> mapperInterface, Method method) {
  // 获取执行方法名称
  final String methodName = method.getName(); 
  // 获取接口的Class
  final Class<?> declaringClass = method.getDeclaringClass();
  // 获取MappedStatement对象，包含xml配置文件、全限定名+方法名、返回结果类型、sqlCommand
  MappedStatement ms = resolveMappedStatement(mapperInterface, methodName, declaringClass,
      configuration);
  // ...
  // 初始化name和type
  name = ms.getId();
  // sql命令类型, SqlCommandType
  type = ms.getSqlCommandType(); 
  if (type == SqlCommandType.UNKNOWN) {
    throw new BindingException("Unknown execution method for: " + name);
  }
  // ...
}

　　解析接口、方法名称获取MappedStatement，MapperMethod#resolveMappedStatement() 核心伪代码：

// 解析接口信息获取MappedStatement对象
private MappedStatement resolveMappedStatement(Class<?> mapperInterface, String methodName,
      Class<?> declaringClass, Configuration configuration) {
    // sql标识id， SQL语句的名称是由Mapper接口的全限定名 + 目标方法名称
    String statementId = mapperInterface.getName() + "." + methodName;
    // 全局配置类是否包含该sql标识di
    if (configuration.hasStatement(statementId)) {
      // 从configuration.mappedStatements集合中查找对应的MappedStatement对象，MappedStatement对象中封装了SQL语句相关的信息，在mybatis初始化时创建
      return configuration.getMappedStatement(statementId);
    } 
    // ...
}

　　组装sql标识id,sql标识id为 Mapper接口的全限定名 + 目标方法名称，判断此sql标识id在全局配置对象configuration中mappedStatements属性中是否存在，存在则从configuration中获取在解析阶段创建好的mappedStatement对象。sqlCommand中的name对应mappedStatement对象的id,sqlCommand中的type对应mappedStatement中的getSqlCommandType。

　　有关sql标识id与mappedStatement的映射关系添加至mappedStatements属性，详见：Mybatis 源码(四)：Mapper的解析工作。

　　sqlCommand中包含了目标执行方法的全限定名、目标执行方法对应的SQL类型。详情如下：

 

2、MethodSignature

　　MethodSignature为MapperMethod的静态内部类，主要包含了方法返回值信息、参数名称解析器。构造函数详情如下：

// 返回值类型是否为Collection类型或者数组类型
private final boolean returnsMany;
// 返回值类型是否为map类型
private final boolean returnsMap;
// 返回值类型是否为void
private final boolean returnsVoid;
// 返回值是否为Cursor类型
private final boolean returnsCursor;
private final boolean returnsOptional;
// 返回值类型
private final Class<?> returnType;
// 如果返回值类型是map，则该字段记录了作为key的列名
private final String mapKey;
// 用来标记该方法参数列表中ResultHandler类型参数的位置
private final Integer resultHandlerIndex;
// 用来标记该方法参数列表中RowBounds类型参数的位置
private final Integer rowBoundsIndex;
// 该方法对应的ParamNameResolver对象
private final ParamNameResolver paramNameResolver;

// 构造函数
public MethodSignature(Configuration configuration, Class<?> mapperInterface, Method method) {
  // 解析方法的返回值类型
  Type resolvedReturnType = TypeParameterResolver.resolveReturnType(method, mapperInterface); 
  if (resolvedReturnType instanceof Class<?>) {
    this.returnType = (Class<?>) resolvedReturnType;
  } else if (resolvedReturnType instanceof ParameterizedType) {
    this.returnType = (Class<?>) ((ParameterizedType) resolvedReturnType).getRawType();
  } else {
    this.returnType = method.getReturnType();
  }
  // 初始化returnsVoid、returnsMany、returnsCursor、returnsOptional等参数
  this.returnsVoid = void.class.equals(this.returnType);
  this.returnsMany = configuration.getObjectFactory().isCollection(this.returnType) || this.returnType.isArray();
  this.returnsCursor = Cursor.class.equals(this.returnType);
  this.returnsOptional = Optional.class.equals(this.returnType);
  // 若MethodSignature对应方法的返回值是Map且制定了@MapKey注解，则使用getMapKey方法处理
  this.mapKey = getMapKey(method);
  this.returnsMap = this.mapKey != null;
  // 初始化rowBoundsIndex、resultHandlerIndex字段
  this.rowBoundsIndex = getUniqueParamIndex(method, RowBounds.class);
  this.resultHandlerIndex = getUniqueParamIndex(method, ResultHandler.class);
  // 创建ParamNameResolver对象
  this.paramNameResolver = new ParamNameResolver(configuration, method);
}

　　MethodSignature包含了方法返回值信息：返回值类型、返回值是否为void标识、返回结果是否为集合标识、返回结果是否为游标标识等；

　　参数解析器ParamNameResolver对象的初始化。

3、总结

　　sqlCommand主要用于锁定目标执行方法及目标执行方法要做的数据操作(增/删/改/查);MethodSignature主要用于对方法的参数、返回值的信息处理。用创建好的sqlCommand、MethodSignature创建MapperMethod对象。

2、MapperMethod#execute()

　　根据不同的SQL类型执行不同的sqlSession方法，MapperMethod#execute() 核心代码：

public Object execute(SqlSession sqlSession, Object[] args) {
  Object result;
  // 根据SQL语句的类型调用SqlSession对应的方法
  switch (command.getType()) {
    // 新增
    case INSERT: {
      // 使用ParamNameResolver处理args数组，将用户传入的实参与指定参数名称关联起来
      Object param = method.convertArgsToSqlCommandParam(args);
      // 调用sqlSession.insert方法，rowCountResult方法会根据method字段中记录的方法的返回值类型对结果进行转换
      result = rowCountResult(sqlSession.insert(command.getName(), param));
      break;
    }
    // 更新
    case UPDATE: {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.update(command.getName(), param));
      break;
    }
    // 删除
    case DELETE: {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.delete(command.getName(), param));
      break;
    }
    // 查询
    case SELECT:
      // 处理返回值为void是ResultSet通过ResultHandler处理的方法
      if (method.returnsVoid() && method.hasResultHandler()) {
        // 如果有结果处理器
        executeWithResultHandler(sqlSession, args);
        result = null;
      // 如果结果有多条记录
      } else if (method.returnsMany()) {
        result = executeForMany(sqlSession, args);
      // 处理返回值为map的方法
      } else if (method.returnsMap()) {
        result = executeForMap(sqlSession, args);
      // 处理返回值为cursor的方法
      } else if (method.returnsCursor()) {
        result = executeForCursor(sqlSession, args);
      } else {
        // 处理返回值为单一对象的方法
        Object param = method.convertArgsToSqlCommandParam(args); // 获取方法参数值
        result = sqlSession.selectOne(command.getName(), param);  // 根据 类全限定名 + 方法名、方法参数，执行sql
        if (method.returnsOptional() &&
            (result == null || !method.getReturnType().equals(result.getClass()))) {
          result = Optional.ofNullable(result);
        }
      }
      break;
    case FLUSH:
      result = sqlSession.flushStatements();
      break;
    default:
      throw new BindingException("Unknown execution method for: " + command.getName());
  }
  if (result == null && method.getReturnType().isPrimitive() && !method.returnsVoid()) {
    throw new BindingException("Mapper method '" + command.getName()
        + " attempted to return null from a method with a primitive return type (" + method.getReturnType() + ").");
  }
  return result;
}

　　根据不同的sqlCommandType和返回类型执行不同sqlSession方法。以查询为例，进行SQL执行流程分析：

UserMapper mapper = sqlSession.getMapper(UserMapper.class);
// 查询流程
User user02 = mapper.selectUserById("101");

2.1、方法参数解析成SQL参数

　　方法参数args数组转换成SQL语句对应的参数列表，MapperMethod#convertArgsToSqlCommandParam() 核心方法：

public Object convertArgsToSqlCommandParam(Object[] args) {
  return paramNameResolver.getNamedParams(args);
}

　　通过参数名称解析器paramNameResolver解析方法参数，paramNameResolver对象在创建MethodSignature时被初始化赋值的。

2.2、执行SQL

1、查询

　　后续查询流程，详见Mybatis源码(八)：查询执行流程。

2、新增|更新|删除

　　后续增删改流程，详见：Mybtais源码(九)：增删改执行流程。

3、核心流程图

　　以查询为例，核心流程图如下：