Mybatis源码解析，一步一步从浅入深（七）：执行查询

一，前言

　　我们在文章：Mybatis源码解析，一步一步从浅入深（二）：按步骤解析源码的最后一步说到执行查询的关键代码：

result = sqlSession.selectOne(command.getName(), param);

　　selelectOne方法有两个参数：

　　第一个参数是：com.zcz.learnmybatis.dao.UserDao.findUserById

　　第二个参数是：1(Integer类型，就是我们传入的参数id：1，我们是期望通过这个id查询到我们想要的结果)

　　因为接下来的代码比较复杂，而且容易迷路。那么我们就定下来本片文章的目的：

　　1，sql语句是什么时候,在哪里执行的？

　　2，我们传入参数id是怎么参与执行的？

　　为了更情绪的分析这两个问题的答案，我将分析的过程分为三步：

　　1，在SqlSession中的执行过程

　　2，在Excutor中的执行过程

　　3，在Statement中的执行过程

二，在代码的执行过程中分析问题

　　1，代码在SqlSession中的执行过程

　　　　在文章：Mybatis源码解析，一步一步从浅入深（二）：按步骤解析源码中，我们已经知道了，使用的sqlSession是DefaultSqlSession，那显而易见，要首先看一下selectOne的源码了：

DefaultSqlSession implements SqlSession
public <T> T selectOne(String statement, Object parameter) {
    // Popular vote was to return null on 0 results and throw exception on too many.
    // 执行查询
    List<T> list = this.<T>selectList(statement, parameter);
    if (list.size() == 1) {
    //如果返回的list的大小是1，则返回第一个元素
      return list.get(0);
    } else if (list.size() > 1) {
    //如果大于1，则抛出异常
      throw new TooManyResultsException("Expected one result (or null) to be returned by selectOne(), but found: " + list.size());
    } else {
    // 如果小于1，则返回null
      return null;
    }
  }

　　到这里可以明白一件事情，原来selectOne是调用selectList执行查询的，只不过是取了返回值的第一个元素。　　

　　我们传入的参数id，就是第5行代码的第二个参数，继续分析第5行的源代码：

DefaultSqlSession implements SqlSession
public <E> List<E> selectList(String statement, Object parameter) {
    // 调用了另外一个三个参数的重载方法，
    return this.selectList(statement, parameter, RowBounds.DEFAULT);
}

　　　　继续跟踪：

 DefaultSqlSession implements SqlSession
 public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {
    try {
      //从configuration中取出解析userDao-mapping.xml文件是生成的MappedStatement
      MappedStatement ms = configuration.getMappedStatement(statement);
      // 这里的executor是CachingExecutor
      List<E> result = executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);
      return result;
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error querying database.  Cause: " + e, e);
    } finally {
      ErrorContext.instance().reset();
    }
  }

　　看源代码的第5行，还记得在文章：Mybatis源码解析，一步一步从浅入深（五）：mapper节点的解析中，mapper文件中的每一个select,insert,update,delete标签，都会解析成一个MappedStatement类的实例对象吗？而且这个实例对象是存放在configuration中的。然后执行第7行代码，这里的executor是CachingExecutor实例对象。到这里SqlSession中的代码流程就结束了，我们进入Executor中的执行过程。

　　2，代码在在Excutor中的执行过程

　　　　看看源代码：

  CachingExecutor implements Executor
  public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
    //取出sql语句
    BoundSql boundSql = ms.getBoundSql(parameterObject);
    CacheKey key = createCacheKey(ms, parameterObject, rowBounds, boundSql);
    return query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

　　同样的，查询参数id也是在这个方法的第二个参数，而且在取出sql语句的方法中，对查询参数进行了检查。继续跟踪这个方法中的第6行代码：

   CachingExecutor implements Executor
   public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
      throws SQLException {
    //使用缓存  
    Cache cache = ms.getCache();
    if (cache != null) {
      flushCacheIfRequired(ms);
      if (ms.isUseCache() && resultHandler == null) {
        ensureNoOutParams(ms, parameterObject, boundSql);
        @SuppressWarnings("unchecked")
        List<E> list = (List<E>) tcm.getObject(cache, key);
        if (list == null) {
          list = delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
          tcm.putObject(cache, key, list); // issue #578. Query must be not synchronized to prevent deadlocks
        }
        return list;
      }
    }
    
    return delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

　　继续跟踪第20行代码：

BaseExecutor implements Executor
  @SuppressWarnings("unchecked")
  public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    ErrorContext.instance().resource(ms.getResource()).activity("executing a query").object(ms.getId());
    if (closed) throw new ExecutorException("Executor was closed.");
    if (queryStack == 0 && ms.isFlushCacheRequired()) {
      clearLocalCache();
    }
    List<E> list;
    try {
      queryStack++;
      list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;
      if (list != null) {
        handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
      } else {
        list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
      }
    } finally {
      queryStack--;
    }
    if (queryStack == 0) {
      for (DeferredLoad deferredLoad : deferredLoads) {
        deferredLoad.load();
      }
      deferredLoads.clear(); // issue #601
      if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {
        clearLocalCache(); // issue #482
      }
    }
    return list;
  }

　　继续跟踪第16行代码：　　　

 BaseExecutor implements Executor
   private <E> List<E> queryFromDatabase(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    List<E> list;
    localCache.putObject(key, EXECUTION_PLACEHOLDER);
    try {
      list = doQuery(ms, parameter, rowBounds, resultHandler, boundSql);
    } finally {
      localCache.removeObject(key);
    }
    localCache.putObject(key, list);
    if (ms.getStatementType() == StatementType.CALLABLE) {
      localOutputParameterCache.putObject(key, parameter);
    }
    return list;
  }

　　继续跟踪第6行代码：

  SimpleExecutor extends BaseExecutor 
   public <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
    Statement stmt = null;
    try {
      Configuration configuration = ms.getConfiguration();
      StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, resultHandler, boundSql);
      //准备预处理语句
      stmt = prepareStatement(handler, ms.getStatementLog());
      return handler.<E>query(stmt, resultHandler);
    } finally {
      closeStatement(stmt);
    }
  }

　　看到第3行了吗？这里声明了一个Statement，是不是很熟悉？是的，这就是我们在使用原始的JDBC进行查询的时候，用到的，那么我们的问题是不是在这里就有了答案了呢？这里先留一个标记。

　　代码执行到这里之后呢，Executor部分的流程就结束了，接下来是在Statement中的执行过程。

　　3，代码在Statement中的执行过程

　　　　继续看源码：

 //第一段源码
  RoutingStatementHandler implements StatementHandler
   public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
    return delegate.<E>query(statement, resultHandler);
  }
  //第二段源码
  PreparedStatementHandler extends BaseStatementHandler
   public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
    PreparedStatement ps = (PreparedStatement) statement;
    ps.execute();
    return resultSetHandler.<E> handleResultSets(ps);
  }

　　在源代码的第10行，是不是也很熟悉？同样也是使用了JDBC进行的查询。似乎这一段的源代码很简单，但其实不是的resultSetHandler中也是做了一部分工作的，这里就不详细描述了。代码到这里就结束了，似乎我们没有看到文章开头的两个问题的答案。看来应该就是在上面标记的地方了。

　　4，问题的答案

　　　　关键代码：stmt = prepareStatement(handler, ms.getStatementLog());

　　　　prepareStatement源码：

private Statement prepareStatement(StatementHandler handler, Log statementLog) throws SQLException {
    Statement stmt;
    //从事务中获取数据库连接
    Connection connection = getConnection(statementLog);
    // 获取Statement
    stmt = handler.prepare(connection);
    // 为Statement设置查询参数
    handler.parameterize(stmt);
    return stmt;
  }

public Statement prepare(Connection connection) throws SQLException {
    ErrorContext.instance().sql(boundSql.getSql());
    Statement statement = null;
    try {
      //初始化Statement
      statement = instantiateStatement(connection);
      //设置查询超时时间
      setStatementTimeout(statement);
      setFetchSize(statement);
      return statement;
    } catch (SQLException e) {
      closeStatement(statement);
      throw e;
    } catch (Exception e) {
      closeStatement(statement);
      throw new ExecutorException("Error preparing statement.  Cause: " + e, e);
    }
  }

protected Statement instantiateStatement(Connection connection) throws SQLException {
    String sql = boundSql.getSql();
    if (mappedStatement.getKeyGenerator() instanceof Jdbc3KeyGenerator) {
      String[] keyColumnNames = mappedStatement.getKeyColumns();
      if (keyColumnNames == null) {
        return connection.prepareStatement(sql, PreparedStatement.RETURN_GENERATED_KEYS);
      } else {
        return connection.prepareStatement(sql, keyColumnNames);
      }
    } else if (mappedStatement.getResultSetType() != null) {
      return connection.prepareStatement(sql, mappedStatement.getResultSetType().getValue(), ResultSet.CONCUR_READ_ONLY);
    } else {
        //从数据库连接中获取statement
      return connection.prepareStatement(sql);
    }
  }

　　看到第14行，哈哈这里就是我们要的答案了。这样一来我们的两个问题，就都有答案了。

　　因为执行查询的这个过程比较复杂，如果真的要详细的全部解释清楚的话，估计还得10几篇文章要写。鉴于作者能力和时间，就大概的展示一下这个过程吧。

 

---

 远程不易，转载请声明出处:https://www.cnblogs.com/zhangchengzi/p/9712446.html