Mybatis3.3.x技術內幕（十一）：執行一個Sql命令的完整流程

Mybatis中的Sql命令，在枚舉類SqlCommandType中定義的。

public enum SqlCommandType {
  UNKNOWN, INSERT, UPDATE, DELETE, SELECT, FLUSH;
}

下面，咱們以Mapper接口中的一個方法做爲例子，看看Sql命令的執行完整流程。

public interface StudentMapper {
	List<Student> findAllStudents(Map<String, Object> map, RowBounds rowBounds, ResultSetHandler rh);	
}

參數RowBounds和ResultSetHandler是可選參數，表示分頁對象和自定義結果集處理器，通常不須要。

一個完整的Sql命令，其執行的完整流程圖以下：

（Made In Edrawmax）

對於上面的流程圖，若是看過前面的博文的話，大部分對象咱們都比較熟悉了。一個圖，就完整展現了其執行流程。

MapperProxy的功能：

1. 由於Mapper接口不能直接實例化，MapperProxy的做用，就是使用JDK動態代理功能，間接實例化Mapper的proxy對象。可參看系列博文的第二篇。

2. 緩存MapperMethod對象。

  private final Map<Method, MapperMethod> methodCache;
  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    if (Object.class.equals(method.getDeclaringClass())) {
      try {
        return method.invoke(this, args);
      } catch (Throwable t) {
        throw ExceptionUtil.unwrapThrowable(t);
      }
    }
    // 投鞭斷流
    final MapperMethod mapperMethod = cachedMapperMethod(method);
    return mapperMethod.execute(sqlSession, args);
  }

  // 緩存MapperMethod
  private MapperMethod cachedMapperMethod(Method method) {
    MapperMethod mapperMethod = methodCache.get(method);
    if (mapperMethod == null) {
      mapperMethod = new MapperMethod(mapperInterface, method, sqlSession.getConfiguration());
      methodCache.put(method, mapperMethod);
    }
    return mapperMethod;
  }

MapperMethod的功能：

1. 解析Mapper接口的方法，並封裝成MapperMethod對象。

2. 將Sql命令，正確路由到恰當的SqlSession的方法上。

public class MapperMethod {

  // 保存了Sql命令的類型和鍵id
  private final SqlCommand command;
  // 保存了Mapper接口方法的解析信息
  private final MethodSignature method;

  public MapperMethod(Class<?> mapperInterface, Method method, Configuration config) {
    this.command = new SqlCommand(config, mapperInterface, method);
    this.method = new MethodSignature(config, method);
  }

  // 根據解析結果，路由到恰當的SqlSession方法上
  public Object execute(SqlSession sqlSession, Object[] args) {
    Object result;
    if (SqlCommandType.INSERT == command.getType()) {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.insert(command.getName(), param));
    } else if (SqlCommandType.UPDATE == command.getType()) {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.update(command.getName(), param));
    } else if (SqlCommandType.DELETE == command.getType()) {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.delete(command.getName(), param));
    } else if (SqlCommandType.SELECT == command.getType()) {
      if (method.returnsVoid() && method.hasResultHandler()) {
        executeWithResultHandler(sqlSession, args);
        result = null;
      } else if (method.returnsMany()) {
        result = executeForMany(sqlSession, args);
      } else if (method.returnsMap()) {
        result = executeForMap(sqlSession, args);
      } else {
        Object param = method.convertArgsToSqlCommandParam(args);
        result = sqlSession.selectOne(command.getName(), param);
      }
    } else if (SqlCommandType.FLUSH == command.getType()) {
        result = sqlSession.flushStatements();
    } else {
      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;
  }
  // ...

org.apache.ibatis.binding.MapperMethod.SqlCommand。

public static class SqlCommand {
    // full id, 經過它能夠找到MappedStatement
    private final String name;
    private final SqlCommandType type;
// ...

org.apache.ibatis.binding.MapperMethod.MethodSignature。

  public static class MethodSignature {

    private final boolean returnsMany;
    private final boolean returnsMap;
    private final boolean returnsVoid;
    private final Class<?> returnType;
    private final String mapKey;
    private final Integer resultHandlerIndex;
    private final Integer rowBoundsIndex;
    private final SortedMap<Integer, String> params;
    private final boolean hasNamedParameters;

    public MethodSignature(Configuration configuration, Method method) {
      this.returnType = method.getReturnType();
      this.returnsVoid = void.class.equals(this.returnType);
      this.returnsMany = (configuration.getObjectFactory().isCollection(this.returnType) || this.returnType.isArray());
      this.mapKey = getMapKey(method);
      this.returnsMap = (this.mapKey != null);
      this.hasNamedParameters = hasNamedParams(method);
      // 分頁參數
      this.rowBoundsIndex = getUniqueParamIndex(method, RowBounds.class);
      // 自定義ResultHandler
      this.resultHandlerIndex = getUniqueParamIndex(method, ResultHandler.class);
      this.params = Collections.unmodifiableSortedMap(getParams(method, this.hasNamedParameters));
    }

以上是對MapperMethod的補充說明。

本節的重點，是上面的那個Sql命令完整執行流程圖。若是不是使用Mapper接口調用，而是直接調用SqlSession的方法，那麼，流程圖從SqlSession的地方開始便可，後續都是同樣的。

版權提示：文章出自開源中國社區，若對文章感興趣，可關注個人開源中國社區博客（http://my.oschina.net/zudajun）。（通過網絡爬蟲或轉載的文章，常常丟失流程圖、時序圖，格式錯亂等，仍是看原版的比較好）