mybatis源码分析：ResultSetHandler结果映射器

ResultMap结果映射集

resultMap的作用是定义映射规则、级联的更新、定制类型化转换等。

resultMap元素的构成

<resultMap>
    <constructor>
      <idArg/>
      <arg/>
    </constructor>
    <id/>
    <result/>
    <association/>
    <collection/>
    <discriminator>
      <case/>
    </discriminator>
</resultMap>

其中construct元素用于配置构造方法。一个POJO可能不存在没有参数的构造方法。
id元素是表示哪个列是主键，允许多个主键，多个主键则成为联合主键。result是配置POJO到SQL列名的映射关系。

result元素和id元素的属性

元素名称	说明	备注
property	映射到列结果的字段或属性。如果POJO的属性匹配的是存在的，和给定SQL列名（column元素）相同的，那么Mybatis就会映射到POJO上	可以使用导航式的字段，比如访问一个学生对象（student）需要访问学生证（selfcard）的发证日期（issueDate），那么我们可以写成selfcard.issueDate
column	这里对应的是SQL的列	-
javaType	配置Java类型	可以是特定的类完全限定名或者Mybatis上下文别名
jdbcType	配置数据库类型	这是一个JDBC的类型，Mybatis已经为我们做了限定，基本支持所有常用的数据库类型
typeHandler	类型处理器	允许使用特定的处理器来覆盖Mybatis默认的处理器。这就要指定jdbcType到JavaType的相互转化规则

级联

在数据库中包含着一对多、一对一的关系，在Mybatis中级联分为3种：association、collection和discriminator，下面分别介绍下。

association，代表一对一关系。
collection，代表一对多关系。
discriminator，是鉴别器，它可以根据实际选择采用哪个类作为实例，允许你根据特定的条件去关联不同的结果集。

性能分析和N+1级联

级联的优势是能够方便快捷地获取数据。
在mybatis的配置中有两个全局的参数lazyLoadingEnabled和aggressiveLazyLoading。lazyLoadingEnabled的含义是是否开启延迟加载功能。aggressiveLazyLoading的含义是对任意延迟属性的调用会使带有延迟加载属性的对象完整加载；反之，每种属性都将按需加载。
Mybatis中局部延迟加载是通过association及collection元素的fetchType就可以了。

概述

Mybatis会将结果集映射配置文件中定义的映射规则，例如resultMap节点、resultType属性等，映射成相应的结果对象，这种映射机制是Mybatis的核心功能之一，可以避免重复的JDBC代码。
在StatementHandler接口在执行完指定的select语句之后，会将查询到的结果集交给ResultSetHandler完成映射处理。ResultSetHandler除了负责映射select语句查询到的结果集，还会处理存储过程执行后的输出参数。
ResultSetHandler接口定义如下：

public interface ResultSetHandler {
  // 处理结果集，生成相应的结果对象集合
  <E> List<E> handleResultSets(Statement stmt) throws SQLException;
  // 处理结果集，返回相应的游标对象
  <E> Cursor<E> handleCursorResultSets(Statement stmt) throws SQLException;
  // 处理存储过程的输出参数
  void handleOutputParameters(CallableStatement cs) throws SQLException;
}

DefaultResultSetHandler是Mybatis提供的ResultSetHandler接口的唯一实现。DefaultResultSetHandler中的核心字段的含义如下，这些字段是在DefaultResultSetHandler中多个方法中使用的公共字段。

private final Executor executor;
private final Configuration configuration;
private final MappedStatement mappedStatement;
private final RowBounds rowBounds;
private final ParameterHandler parameterHandler;
private final ResultHandler<?> resultHandler;
private final BoundSql boundSql;
private final TypeHandlerRegistry typeHandlerRegistry;
private final ObjectFactory objectFactory;
private final ReflectorFactory reflectorFactory;

handleResultSets()方法

通过select语句查询数据库得到的结果集由DefaultResultSetHandler.handleResultSets()方法进行处理，该方法不仅可以处理Statement、PreparedStatement产生的结果集，还可以处理CallableStatement调用存储过程产生的多结果集。
handleResultSets()方法具体实现如下：

//
// HANDLE RESULT SETS
//
@Override
public List<Object> handleResultSets(Statement stmt) throws SQLException {
    ErrorContext.instance().activity("handling results").object(mappedStatement.getId());
    // 该集合用于保存映射结果集得到的结果对象
    final List<Object> multipleResults = new ArrayList<>();
    
    int resultSetCount = 0;
    ResultSetWrapper rsw = getFirstResultSet(stmt);
    // 获取MappedStatement的ResultMaps
    List<ResultMap> resultMaps = mappedStatement.getResultMaps();
    int resultMapCount = resultMaps.size();
    validateResultMapsCount(rsw, resultMapCount);
     
    while (rsw != null && resultMapCount > resultSetCount) {
      // 获取mapper中的ResultMap标签数据
      ResultMap resultMap = resultMaps.get(resultSetCount);
      // 创建对象并将ResultSetWrapper中的数据按照ResultMap的映射规则填充。
      // 并将对象存储到multipleResults中
      handleResultSet(rsw, resultMap, multipleResults, null);
      rsw = getNextResultSet(stmt);
      cleanUpAfterHandlingResultSet();
      resultSetCount++;
    }
    
    String[] resultSets = mappedStatement.getResultSets();
    if (resultSets != null) {
      while (rsw != null && resultSetCount < resultSets.length) {
        ResultMapping parentMapping = nextResultMaps.get(resultSets[resultSetCount]);
        if (parentMapping != null) {
          String nestedResultMapId = parentMapping.getNestedResultMapId();
          ResultMap resultMap = configuration.getResultMap(nestedResultMapId);
          handleResultSet(rsw, resultMap, null, parentMapping);
        }
        rsw = getNextResultSet(stmt);
        cleanUpAfterHandlingResultSet();
        resultSetCount++;
      }
    }
    
    return collapseSingleResultList(multipleResults);
}

handleResultSet()方法代码如下：

private void handleResultSet(ResultSetWrapper rsw, ResultMap resultMap, List<Object> multipleResults, ResultMapping parentMapping) throws SQLException {
    try {
      if (parentMapping != null) {
        handleRowValues(rsw, resultMap, null, RowBounds.DEFAULT, parentMapping);
      } else {
        if (resultHandler == null) {
          // 持有解析完成后的结果对象
          DefaultResultHandler defaultResultHandler = new DefaultResultHandler(objectFactory);
          // 解析映射对象
          handleRowValues(rsw, resultMap, defaultResultHandler, rowBounds, null);
          // 存储解析结果
          multipleResults.add(defaultResultHandler.getResultList());
        } else {
          handleRowValues(rsw, resultMap, resultHandler, rowBounds, null);
        }
      }
    } finally {
      // issue #228 (close resultsets)
      closeResultSet(rsw.getResultSet());
    }
}

handleRowValues()方法如下：

public void handleRowValues(ResultSetWrapper rsw, ResultMap resultMap, ResultHandler<?> resultHandler, RowBounds rowBounds, ResultMapping parentMapping) throws SQLException {
    if (resultMap.hasNestedResultMaps()) {
      ensureNoRowBounds();
      checkResultHandler();
      // 处理映射
      handleRowValuesForNestedResultMap(rsw, resultMap, resultHandler, rowBounds, parentMapping);
    } else {
      handleRowValuesForSimpleResultMap(rsw, resultMap, resultHandler, rowBounds, parentMapping);
    }
}

handleRowValuesForSimpleResultMap()方法如下：

private void handleRowValuesForSimpleResultMap(ResultSetWrapper rsw, ResultMap resultMap, ResultHandler<?> resultHandler, RowBounds rowBounds, ResultMapping parentMapping)
  throws SQLException {
    DefaultResultContext<Object> resultContext = new DefaultResultContext<Object>();
    skipRows(rsw.getResultSet(), rowBounds);
    while (shouldProcessMoreRows(resultContext, rowBounds) && rsw.getResultSet().next()) {
      ResultMap discriminatedResultMap = resolveDiscriminatedResultMap(rsw.getResultSet(), resultMap, null);
      Object rowValue = getRowValue(rsw, discriminatedResultMap);
      storeObject(resultHandler, resultContext, rowValue, parentMapping, rsw.getResultSet());
    }
}

//
// GET VALUE FROM ROW FOR SIMPLE RESULT MAP
//

private Object getRowValue(ResultSetWrapper rsw, ResultMap resultMap) throws SQLException {
    final ResultLoaderMap lazyLoader = new ResultLoaderMap();
    Object rowValue = createResultObject(rsw, resultMap, lazyLoader, null);
    if (rowValue != null && !hasTypeHandlerForResultObject(rsw, resultMap.getType())) {
      final MetaObject metaObject = configuration.newMetaObject(rowValue);
      boolean foundValues = this.useConstructorMappings;
      if (shouldApplyAutomaticMappings(resultMap, false)) {
        foundValues = applyAutomaticMappings(rsw, resultMap, metaObject, null) || foundValues;
      }
      foundValues = applyPropertyMappings(rsw, resultMap, metaObject, lazyLoader, null) || foundValues;
      foundValues = lazyLoader.size() > 0 || foundValues;
      rowValue = foundValues || configuration.isReturnInstanceForEmptyRow() ? rowValue : null;
    }
    return rowValue;
}

//
// PROPERTY MAPPINGS
//

private boolean applyPropertyMappings(ResultSetWrapper rsw, ResultMap resultMap, MetaObject metaObject, ResultLoaderMap lazyLoader, String columnPrefix)
  throws SQLException {
    final List<String> mappedColumnNames = rsw.getMappedColumnNames(resultMap, columnPrefix);
    boolean foundValues = false;
    final List<ResultMapping> propertyMappings = resultMap.getPropertyResultMappings();
    for (ResultMapping propertyMapping : propertyMappings) {
      String column = prependPrefix(propertyMapping.getColumn(), columnPrefix);
      if (propertyMapping.getNestedResultMapId() != null) {
        // the user added a column attribute to a nested result map, ignore it
        column = null;
      }
      if (propertyMapping.isCompositeResult()
          || (column != null && mappedColumnNames.contains(column.toUpperCase(Locale.ENGLISH)))
          || propertyMapping.getResultSet() != null) {
        Object value = getPropertyMappingValue(rsw.getResultSet(), metaObject, propertyMapping, lazyLoader, columnPrefix);
        // issue #541 make property optional
        final String property = propertyMapping.getProperty();
        if (property == null) {
          continue;
        } else if (value == DEFERED) {
          foundValues = true;
          continue;
        }
        if (value != null) {
          foundValues = true;
        }
        if (value != null || (configuration.isCallSettersOnNulls() && !metaObject.getSetterType(property).isPrimitive())) {
          // gcode issue #377, call setter on nulls (value is not 'found')
          metaObject.setValue(property, value);
        }
      }
    }
    return foundValues;
}