MyBatis 核心处理层:结果集映射

在 MyBatis 解析 mapper.xml 映射文件的过程中,会将 <resultMap> 标签解析成 ResultMap 对象,该对象定义了结果集与 Java 对象的映射规则,即一行数据记录如何映射成一个 Java 对象。这种映射机制是 MyBatis 作为 ORM 框架的核心功能之一。然而,ResultMap 只是定义了一个静态的映射规则,那么在运行时,MyBatis 是如何根据这些规则将 ResultSet 映射成 Java 对象的呢?答案就是通过 ResultSetHandler 进行处理。

ResultSetHandler 是一个接口,其中定义了三个方法,分别用来处理不同的查询返回值:

1
2
3
4
5
6
7
8
public interface ResultSetHandler {
  // 将 ResultSet 映射成 Java 对象
  <E> List<E> handleResultSets(Statement stmt) throws SQLException;
  // 将 ResultSet 映射成游标对象
  <E> Cursor<E> handleCursorResultSets(Statement stmt) throws SQLException;
  // 处理存储过程的输出参数
  void handleOutputParameters(CallableStatement cs) throws SQLException;
}

在 MyBatis 中只提供了一个 ResultSetHandler 接口实现,即 DefaultResultSetHandler。下面我们就以 DefaultResultSetHandler 为中心,介绍 MyBatis 中 ResultSet 映射的核心流程。

1 结果集处理入口

通常情况下我们执行一条 SELECT 语句只会拿到一个 ResultSet,其实数据库还支持同时返回多个 ResultSet,例如在存储过程中执行多条 SELECT 语句。MyBatis 作为一个通用的持久化框架,不仅要支持常用的基础功能,还要对其他使用场景进行全面的支持。

DefaultResultSetHandler 实现的 handleResultSets() 方法支持多个 ResultSet 的处理(单 ResultSet 的处理只是其中的特例),相关的代码片段如下:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
public List<Object> handleResultSets(Statement stmt) throws SQLException {
  ErrorContext.instance().activity("handling results").object(mappedStatement.getId());
  // 用于记录每个 ResultSet 映射出来的 Java 对象
  final List<Object> multipleResults = new ArrayList<>();
  int resultSetCount = 0;
  // 从 Statement 中获取第一个 ResultSet,其中对不同的数据库有兼容处理逻辑,
  // 这里拿到的 ResultSet 会被封装成 ResultSetWrapper 对象返回
  ResultSetWrapper rsw = getFirstResultSet(stmt);
  // 获取这条 SQL 语句关联的全部 ResultMap 规则。如果一条 SQL 语句能够产生多个 ResultSet,
  // 那么在编写 Mapper.xml 映射文件的时候,我们可以在 SQL 标签的 resultMap 属性中配置多个
  // <resultMap>标签的 id,它们之间通过","分隔,实现对多个结果集的映射
  List<ResultMap> resultMaps = mappedStatement.getResultMaps();
  int resultMapCount = resultMaps.size();
  // 验证结果映射计数
  validateResultMapsCount(rsw, resultMapCount);
  // 遍历 ResultMap 集合
  while (rsw != null && resultMapCount > resultSetCount) {
    // 根据 ResultMap 中定义的映射规则处理 ResultSet,并将映射得到的 Java 对象添加到
    // multipleResults 集合中保存
    ResultMap resultMap = resultMaps.get(resultSetCount);
    handleResultSet(rsw, resultMap, multipleResults, null);
    // 获取下一个 ResultSet
    rsw = getNextResultSet(stmt);
    // 清理 nestedResultObjects 集合,这个集合是用来存储中间数据的
    cleanUpAfterHandlingResultSet();
    // 递增 ResultSet 编号
    resultSetCount++;
  }
  // 根据 ResultSet 的名称处理嵌套映射,下文再介绍,这里先省略
  //...
  // 返回全部映射得到的 Java 对象
  return collapseSingleResultList(multipleResults);
}

这里我们先来看一下遍历多结果集时使用到的 getFirstResultSet() 方法和 getNextResultSet() 方法,这两个方法底层都是依赖 java.sql.Statement 中的的 getMoreResults() 方法和 getUpdateCount() 方法检测是否存在后续的 ResultSet 对象,检测成功之后,会通过 getResultSet() 方法获取下一个 ResultSet 对象。

这里获取到的 ResultSet 对象,会被包装成 ResultSetWrapper 对象返回。

ResultSetWrapper 主要用于封装 ResultSet 的一些元数据,其中记录了 ResultSet 中每列的名称、对应的 Java 类型、JdbcType 类型以及每列对应的 TypeHandler

另外,ResultSetWrapper 可以将底层 ResultSet 的列与一个 ResultMap 映射的列进行交集,得到参与映射的列和未被映射的列,分别记录到 mappedColumnNamesMap 集合和 unMappedColumnNamesMap 集合中。这两个集合都是 Map<String, List<String>> 类型,其中最外层的 Key 是 ResultMapid,Value 分别是参与映射的列名集合和未被映射的列名集合。

除了记录上述元数据以外,ResultSetWrapper 还封装了一套查询上述元数据的方法,例如,我们可以通过 getMappedColumnNames() 方法查询一个 ResultMap 映射了当前 ResultSet 的哪些列,还可以通过 getJdbcType()getTypeHandler() 等方法查询指定列对应的 JdbcTypeTypeHandler 等。

2 简单映射

了解了处理 ResultSet 的入口逻辑之后,下面我们继续来深入了解一下 DefaultResultSetHandler 是如何处理单个结果集的,这部分逻辑的入口是 handleResultSet() 方法,其中会根据第四个参数,也就是 parentMapping,判断当前要处理的 ResultSet 是嵌套映射,还是外层映射。

无论是处理外层映射还是嵌套映射,都会依赖 handleRowValues() 方法完成结果集的处理(通过方法名也可以看出,handleRowValues() 方法是处理多行记录的,也就是一个结果集)。至于 handleRowValues() 方法,其中会通过 handleRowValuesForNestedResultMap() 方法处理包含嵌套映射的 ResultMap,通过 handleRowValuesForSimpleResultMap() 方法处理不包含嵌套映射的简单 ResultMap,如下所示:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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() 方法如何映射一个 ResultSet 的,该方法的核心步骤如下:

handleRowValuesForSimpleResultMap
  1. 执行 skipRows() 方法跳过多余的记录,定位到指定的行。
  2. 通过 shouldProcessMoreRows() 方法,检测是否还有需要映射的数据记录。
  3. 如果存在需要映射的记录,则先通过 resolveDiscriminatedResultMap() 方法处理映射中用到的 Discriminator,决定此次映射实际使用的 ResultMap
  4. 通过 getRowValue() 方法对 ResultSet 中的一行记录进行映射,映射规则使用的就是步骤 3 中确定的 ResultMap
  5. 执行 storeObject() 方法记录步骤 4 中返回的、映射好的 Java 对象。

在开始详细介绍上述映射流程中的每一步之前,我们先来看一下贯穿整个映射过程的两个辅助对象:DefaultResultHandlerDefaultResultContext

  • DefaultResultSetHandler 中维护了一个 ResultHandler resultHandler 字段指向一个 DefaultResultHandler 对象,其核心作用是存储多个结果集映射得到的 Java 对象。

    ResultHandler 有两个默认实现:DefaultResultHandlerDefaultMapResultHandlerResultHandler 接口继承图

    • DefaultResultHandler 实现的底层使用 ArrayList<Object> 存储映射得到的 Java 对象;
    • DefaultMapResultHandler 实现的底层使用 Map<K, V> 存储映射得到的 Java 对象,其中 Key 是从结果对象中获取的指定属性的值,Value 就是映射得到的 Java 对象。
  • 至于 DefaultResultContext 对象,它的生命周期与一个 ResultSet 相同,每从 ResultSet 映射得到一个 Java 对象都会暂存到 DefaultResultContext 中的 resultObject 字段,等待后续使用,同时 DefaultResultContext 还可以计算从一个 ResultSet 映射出来的对象个数(依靠 resultCount 字段统计)。

了解了 handleRowValuesForSimpleResultMap() 方法的核心步骤以及全部贯穿整个映射流程的辅助对象之后,下面我们开始深入每个步骤进行详细分析。

2.1 1. ResultSet 的预处理

MyBatis 支持将所有数据请求到内存以后,再通过 RowBounds 指定 offsetlimit 参数实现分页(性能很差不推荐使用,仅作为了解)。这里的 skipRows() 方法便会根据 RowBounds 移动 ResultSet 的指针到指定的数据行,这样后续的映射操作就可以从这一行开始。

skipRows() 方法会检查 ResultSet 的属性,如果是 TYPE_FORWARD_ONLY 类型,则只能通过循环 + ResultSet.next() 方法(指针的逐行前移)定位到指定的数据行;反之,可以通过 ResultSet.absolute() 方法直接移动指针。

处理 RowBounds 的另一个方法是 shouldProcessMoreRows() 方法,其中会检查当前已经映射的行是否达到了 RowBounds.limit 字段指定的行数上限,如果达到,则返回 false,停止后续操作。当然,控制是否进行后续映射操作的条件还有 ResultSet.next() 方法(即结果集中是否还有数据)。

以上便是 ResultSet 的预处理工作,即完成“假分页”。

2.2 2. 确定 ResultMap

在完成 ResultSet 的预处理之后,接下来会通过 resolveDiscriminatedResultMap() 方法处理 <discriminator> 标签,确定此次映射操作最终使用的 ResultMap 对象。实现如下:

resolveDiscriminatedResultMap

为了更加方便和完整地描述 resolveDiscriminatedResultMap() 方法的核心流程,这里我们结合一个简单示例进行分析,比如,现在有一个 ResultSet 包含 idnameclassifysubClassify 四列,并且由 animalMap 来映射该 ResultSet,具体如下图所示:

discriminator

通过 resolveDiscriminatedResultMap() 方法确定 ResultMap 的流程大致是这样的:

  • 首先按照 animalMap 这个 ResultMap 映射这行记录,该行记录中的 classify 列值为 mammalia,根据其中定义的 <discriminator> 标签的配置,会选择使用 mammaliaMap 这个 ResultMap 对当前这条记录进行映射;
  • 接下来看 mammaliaMap 这个 ResultMap,其中的 <discriminator> 标签检查的是 subClassify 的列值,当前记录的 subClassify 列值为 human,所以会选择 humanMap 这个 ResultMap 映射当前这条记录,得到一个 Human 对象。

了解了上述基本流程之后,下面我们来看 resolveDiscriminatedResultMap() 方法的具体实现:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
public ResultMap resolveDiscriminatedResultMap(ResultSet rs, ResultMap resultMap, String columnPrefix) throws SQLException {
  // 用于维护处理过的 ResultMap 唯一标识
  Set<String> pastDiscriminators = new HashSet<>();
  // 获取 ResultMap 中的 Discriminator 对象,这是通过<resultMap>标签中的<discriminator>标签解析得到的
  Discriminator discriminator = resultMap.getDiscriminator();
  while (discriminator != null) {
    // 获取当前待映射的记录中 Discriminator 要检测的列的值
    final Object value = getDiscriminatorValue(rs, discriminator, columnPrefix);
    // 根据上述列值确定要使用的 ResultMap 的唯一标识
    final String discriminatedMapId = discriminator.getMapIdFor(String.valueOf(value));
    if (configuration.hasResultMap(discriminatedMapId)) {
      // 从全局配置对象 Configuration 中获取 ResultMap 对象
      resultMap = configuration.getResultMap(discriminatedMapId);
      // 记录当前 Discriminator 对象
      Discriminator lastDiscriminator = discriminator;
      // 获取 ResultMap 对象中的 Discriminator
      discriminator = resultMap.getDiscriminator();
      // 检测 Discriminator 是否出现了环形引用
      if (discriminator == lastDiscriminator || !pastDiscriminators.add(discriminatedMapId)) {
        break;
      }
    } else {
      break;
    }
  }
  // 返回最终要使用的 ResultMap
  return resultMap;
}

2.3 3. 创建映射结果对象

经过 resolveDiscriminatedResultMap() 方法解析,我们最终确定了当前记录使用哪个 ResultMap 进行映射。

接下来要做的就是按照 ResultMap 规则进行各个列的映射,得到最终的 Java 对象,这部分逻辑是在下面要介绍的 getRowValue() 方法完成的,其核心步骤如下:

  • 首先根据 ResultMaptype 属性值创建映射的结果对象;
  • 然后根据 ResultMap 的配置以及全局信息,决定是否自动映射 ResultMap 中未明确映射的列;
  • 接着根据 ResultMap 映射规则,将 ResultSet 中的列值与结果对象中的属性值进行映射;
  • 最后返回映射的结果对象,如果没有映射任何属性,则需要根据全局配置决定如何返回这个结果值,这里不同场景和配置,可能返回完整的结果对象、空结果对象或是 null。

下面是 getRowValue() 方法的核心实现:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
private Object getRowValue(ResultSetWrapper rsw, ResultMap resultMap, String columnPrefix) throws SQLException {
  final ResultLoaderMap lazyLoader = new ResultLoaderMap();
  // 根据 ResultMap 的 type 属性值创建映射的结果对象
  Object rowValue = createResultObject(rsw, resultMap, lazyLoader, columnPrefix);
  if (rowValue != null && !hasTypeHandlerForResultObject(rsw, resultMap.getType())) {
    final MetaObject metaObject = configuration.newMetaObject(rowValue);
    boolean foundValues = this.useConstructorMappings;
    // 根据 ResultMap 的配置以及全局信息,决定是否自动映射 ResultMap 中未明确映射的列
    if (shouldApplyAutomaticMappings(resultMap, false)) {
      foundValues = applyAutomaticMappings(rsw, resultMap, metaObject, columnPrefix) || foundValues;
    }
    // 根据 ResultMap 映射规则,将 ResultSet 中的列值与结果对象中的属性值进行映射
    foundValues = applyPropertyMappings(rsw, resultMap, metaObject, lazyLoader, columnPrefix) || foundValues;
    // 如果没有映射任何属性,需要根据全局配置决定如何返回这个结果值,
    // 这里不同场景和配置,可能返回完整的结果对象、空结果对象或是 null
    foundValues = lazyLoader.size() > 0 || foundValues;
    rowValue = foundValues || configuration.isReturnInstanceForEmptyRow() ? rowValue : null;
  }
  return rowValue;
}

可以看到这里的第一步,也就是创建映射的结果对象,这部分逻辑位于 createResultObject() 方法中。这个方法中有两个关键步骤:

  • 一个是调用另一个 createResultObject() 重载方法来创建结果对象;
  • 另一个是通过 ProxyFactory 创建代理对象来处理延迟加载的属性。

由于我们重点分析的是简单 ResultSet 的映射流程,所以接下来我们重点看 createResultObject() 重载方法是如何创建映射结果对象的:

createResultObject

该方法首先做了一些准备工作:

  • 获取 ResultMaptype 属性指定的结果对象的类型,并创建该类型对应的 MetaClass 对象;
  • 获取 ResultMap 中配置的 <constructor> 标签信息。

    也就是对应的 ResultMapping 对象集合,如果该信息不为空,则可以确定结果类型中的唯一构造函数。

然后再根据四种不同的场景,使用不同的方式创建结果对象,下面就是这四种场景的核心逻辑:

  • 场景一:ResultSet 中只有一列,并且能够找到一个 TypeHandler 完成该列到目标结果类型的映射,此时可以直接读取 ResultSet 中的列值并通过 TypeHandler 转换得到结果对象。

    这部分逻辑是在 createPrimitiveResultObject() 方法中实现的,该场景多用于 Java 原始类型的处理。

  • 场景二:如果 ResultMap 中配置了 <constructor> 标签,就会先解析 <constructor> 标签中指定的构造方法参数的类型,并从待映射的数据行中获取对应的实参值,然后通过反射方式调用对应的构造方法来创建结果对象。

    这部分逻辑在 createParameterizedResultObject() 方法中实现。

  • 场景三,如果不满足上述两个场景,则尝试查找默认构造方法来创建结果对象。

    这里使用前面介绍的 ObjectFactory.create() 方法实现,底层原理还是 Java 的反射机制。

  • 场景四,最后会检测是否已经开启了自动映射功能,如果开启了,会尝试查找合适的构造方法创建结果对象。这里首先会查找 @AutomapConstructor 注解标注的构造方法,查找失败之后,则会尝试查找每个参数都有 TypeHandler 能与 ResultSet 列进行映射的构造方法,确定要使用的构造方法之后,也是通过 ObjectFactory 完成对象创建的。

    这部分逻辑在 createByConstructorSignature() 方法中实现。

2.4 4. 自动映射

创建完结果对象之后,下面就可以开始映射各个字段了。

在简单映射流程中,会先通过 [shouldApplyAutomaticMappings() 方法检测是否开启了自动映射

shouldApplyAutomaticMappings

该方法主要检测以下两个地方:

  • 检测当前使用的 ResultMap 是否配置了 autoMapping 属性,如果是,则直接根据该 autoMapping 属性的值决定是否开启自动映射功能。
  • 检测核心配置文件的 <settings> 标签中配置的 autoMappingBehavior 值,决定是否开启自动映射功能。autoMappingBehavior 指定 MyBatis 框架如何进行自动映射,该属性有三个可选值:
    1. NONE,表示完全关闭自动映射功能;
    2. PARTIAL,表示只会自动映射没有定义嵌套映射的 ResultMap
    3. FULL,表示完全打开自动映射功能,这里会自动映射所有 ResultMap
    • autoMappingBehavior 的默认值是 PARTIAL

当确定当前 ResultMap 需要进行自动映射的时候,会通过 applyAutomaticMappings() 方法进行自动映射,其中的核心逻辑大致可描述为如下:

applyAutomaticMappings
  • 首先,从参数 ResultSetWrapper 中获取所有未映射的列名,然后逐个处理每个列名。通过列名获取对应的属性名称,这里会将列名转换为小写并截掉指定的前缀,得到相应的属性名称。
  • 然后,检测结果对象中是否有上面得到的属性。
    • 如果属性不存在,则通过全局配置的 AutoMappingUnknownColumnBehavior 进行处理。
    • 如果属性存在,则检测该属性是否有合适的 TypeHandler
      • 如果不存在合适的 TypeHandler,依旧是通过全局配置的 AutoMappingUnknownColumnBehavior 进行处理。
      • 经过上述检测之后,就可以创建 UnMappedColumnAutoMapping 对象将该列与对应的属性进行关联(在 UnMappedColumnAutoMapping 中记录了列名、属性名以及相关的 TypeHandler),并将该 UnMappedColumnAutoMapping 对象加入集合。
  • 最后,遍历上面得到 UnMappedColumnAutoMapping 集合,通过其中的 TypeHandler 读取列值并转换成相应的 Java 类型,再通过 MetaObject 设置到相应属性中。

这样就完成了自动映射的功能。

2.5 5. 正常映射

完成自动映射之后,MyBatis 会执行 applyPropertyMappings() 方法处理 ResultMap 中明确要映射的列,核心流程如下:

applyPropertyMappings
  • 首先从 ResultSetWrapper 中明确需要映射的列名集合,以及 ResultMap 中定义的 ResultMapping 对象集合。
  • 遍历全部 ResultMapping 集合,针对每个 ResultMapping 对象为 column 属性值添加指定的前缀,得到最终的列名,然后执行 getPropertyMappingValue() 方法完成映射,得到对应的属性值。
  • 如果成功获取到了属性值,则通过结果对象关联的 MetaObject 对象设置到对应属性中。

getPropertyMappingValue() 方法中,主要处理了三种场景的映射:

getPropertyMappingValue
  • 第一种是基本类型的映射,这种场景直接可以通过 TypeHandlerResultSet 中读取列值,并在转化之后返回;
  • 第二种和第三种场景分别是嵌套映射和多结果集的映射。

2.6 6. 存储对象

通过上述 5 个步骤,我们已经完成简单映射的处理,得到了一个完整的结果对象。接下来,我们就要通过 storeObject() 方法把这个结果对象保存到合适的位置。

这里处理的简单映射:

  • 如果是一个嵌套映射中的子映射,那么我们就需要将结果对象保存到外层对象的属性中;
  • 如果是一个普通映射或是外层映射的结果对象,那么我们就需要将结果对象保存到 ResultHandler 中。

明确了结果对象的存储位置之后,我们来看 storeObject() 方法的具体实现:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
private void storeObject(ResultHandler<?> resultHandler, DefaultResultContext<Object> resultContext, Object rowValue, ResultMapping parentMapping, ResultSet rs) throws SQLException {
  if (parentMapping != null) {
    // 嵌套查询或嵌套映射的场景,此时需要将结果对象保存到外层对象对应的属性中
    linkToParents(rs, parentMapping, rowValue);
  } else {
    // 普通映射(没有嵌套映射)或是嵌套映射中的外层映射的场景,
    // 此时需要将结果对象保存到 ResultHandler 中
    callResultHandler(resultHandler, resultContext, rowValue);
  }
}

3 嵌套映射

处理简单映射只是所有映射处理逻辑中的一个分支,handleRowValues() 方法还有另一条分支是用来处理嵌套映射的,也就是 handleRowValuesForNestedResultMap() 方法。

handleRowValuesForNestedResultMap() 方法处理嵌套映射的核心流程如下所示:

  1. 通过 skipRows() 方法将 ResultSet 的指针指向目标行。

  2. 执行 shouldProcessMoreRows() 方法检测 ResultSet 中是否包含能继续映射的数据行,如果包含,就开始映射一个具体的数据行。

  3. 通过 resolveDiscriminatedResultMap() 方法处理 ResultMap 中的 Discriminator 对象,确定最终使用的 ResultMap 映射规则。

  4. 为当前处理的数据行生成 CacheKey。除了作为缓存中的 key 值外,CacheKey 在嵌套映射中也作为唯一标识来标识结果对象。

  5. 根据步骤 4 生成的 CacheKeyDefaultResultSetHandler.nestedResultObjects 集合中查询中间结果。

    nestedResultObjects 是一个 HashMap 集合,在处理嵌套映射过程中产生的全部中间对象,都会记录到这个 Map 中,其中的 Key 就是 CacheKey

  6. 检测 <select> 标签中 resultOrdered 属性的配置,并根据 resultOrdered 的配置决定是否提前释放 nestedResultObjects 集合中的中间数据,避免在进行嵌套映射时出现内存不足的情况。

  7. 通过 getRowValue() 方法完成当前记录行的映射,得到最终的结果对象,其中还会将结果对象添加到 nestedResultObjects 集合中。

  8. 通过 storeObject() 方法将生成的结果对象保存到 ResultHandler 中。

3.1 1. 创建 CacheKey

创建 CacheKey核心逻辑在 createRowKey() 方法中,该方法构建 CacheKey 的过程是这样的:

  • 首先使用 resultMapid 组成 CacheKey 对象;
  • 根据 resultMap 获取 ResultMapping 集合:
    • 如果获取到了则使用 ResultMapping 的列名和值更新 CacheKey 对象;
    • 如果获取不到,则使用 ResultSetWrapper 中的已映射结果集和未映射结果集中的 列名和值更新 CacheKey 对象。

以上过程的目的是为了得到唯一的 CacheKey 来标识结果对象

3.2 2. 外层映射

完成 CacheKey 的创建之后,我们开始处理嵌套映射,整个处理过程的入口是 getRowValue() 方法。因为嵌套映射涉及多层映射,这里我们先来关注外层映射的处理流程:

  • 首先通过 createResultObject() 方法创建外层对象,再通过 shouldApplyAutomaticMappings() 方法检测是否开启自动映射来处理包含嵌套的映射。对于嵌套映射,只有 ResultMap 明确配置或是全局的 AutoMappingBehavior 配置为 FULL 的时候,才会开启自动映射。

  • 如果发现开启了自动映射,则会指定 applyAutomaticMappings() 方法,处理 ResultMap 中未明确映射的列。然后再通过 applyPropertyMappings() 方法处理 ResultMap 中明确需要进行映射的列。

    applyAutomaticMappings() 方法和 applyPropertyMappings() 方法我们在上文中已经详细分析过了,这里就不再赘述。

  • 到此为止,处理外层映射的步骤其实与处理简单映射的步骤基本一致,但不同的是:外层映射此时得到的并不是一个完整的对象,而是一个“部分映射”的对象,因为只填充了一部分属性,另一部分属性将由后面得到的嵌套映射的结果对象填充。

  • 接下来就是与简单映射不一样的步骤了。这里会先将“部分映射”的结果对象添加到 ancestorObjects 集合中暂存,ancestorObjects 是一个 HashMap<String, Object> 类型,key 是 ResultMap 的唯一标识(即 id 属性值),value 为外层的“部分映射”的结果对象。

  • 然后通过 applyNestedResultMappings() 方法处理嵌套映射,在处理过程中,会从 ancestorObjects 集合中获取外层对象,并将嵌套映射产生的结果对象设置到外层对象的属性中。

  • 处理完之后,就清理 ancestorObjects 集合,并将外层对象保存到 nestedResultObjects 集合中,等待后续的映射步骤继续使用。这里使用的 Key 就是前面创建的 CacheKey 对象。

了解了外层映射的核心步骤之后,下面我们一起来看一下 getRowValue() 方法的具体实现:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
private Object getRowValue(ResultSetWrapper rsw, 
    ResultMap resultMap, CacheKey combinedKey, 
    String columnPrefix, Object partialObject) throws SQLException {
  final String resultMapId = resultMap.getId();
  Object rowValue = partialObject;
  if (rowValue != null) {
    // 检测外层对象是否已经存在,如果存在,直接执行嵌套映射的逻辑
    final MetaObject metaObject = configuration.newMetaObject(rowValue);
    putAncestor(rowValue, resultMapId);
    applyNestedResultMappings(rsw, resultMap, metaObject, columnPrefix, combinedKey, false);
    ancestorObjects.remove(resultMapId);
  } else {
    // 外层对象不存在,先生成外层映射的对象
    final ResultLoaderMap lazyLoader = new ResultLoaderMap();
    // 首先通过 createResultObject() 方法创建外层对象,
    rowValue = createResultObject(rsw, resultMap, lazyLoader, columnPrefix);
    if (rowValue != null && !hasTypeHandlerForResultObject(rsw, resultMap.getType())) {
      // 创建外层对象关联的 MetaObject 对象
      final MetaObject metaObject = configuration.newMetaObject(rowValue);
      boolean foundValues = this.useConstructorMappings;
      // 再通过 shouldApplyAutomaticMappings() 方法检测是否开启自动映射来处理包含嵌套的映射。
      // 对于嵌套映射,只有 ResultMap 明确配置或是全局的 AutoMappingBehavior 配置为 FULL 的时候,才会开启自动映射
      if (shouldApplyAutomaticMappings(resultMap, true)) { // 自动映射
        // 处理 ResultMap 中未明确映射的列。
        foundValues = applyAutomaticMappings(rsw, resultMap, metaObject, columnPrefix) || foundValues;
      }
      // 处理 ResultMap 中明确需要进行映射的列。
      foundValues = applyPropertyMappings(rsw, resultMap, metaObject, lazyLoader, columnPrefix) || foundValues;
      // 这里先将“部分映射”的结果对象添加到 ancestorObjects 集合中暂存
      putAncestor(rowValue, resultMapId);
      // 处理嵌套映射,其中会从 ancestorObjects 集合中获取外层对象,并将嵌套映射的结果对象设置到外层对象的属性中
      foundValues = applyNestedResultMappings(rsw, resultMap, metaObject, columnPrefix, combinedKey, true) || foundValues;
      // 清理 ancestorObjects 集合,删除外层对象
      ancestorObjects.remove(resultMapId);
      foundValues = lazyLoader.size() > 0 || foundValues;
      rowValue = foundValues || configuration.isReturnInstanceForEmptyRow() ? rowValue : null;
    }
    if (combinedKey != CacheKey.NULL_CACHE_KEY) {
      // 将外层对象记录到 nestedResultObjects 集合中,等待后续使用
      nestedResultObjects.put(combinedKey, rowValue);
    }
  }
  return rowValue;
}

3.3 3. applyNestedResultMappings() 方法

通过对外层对象的处理我们可以知道,处理嵌套映射的核心在于 applyNestedResultMappings() 方法,其中会遍历 ResultMap 中的每个 ResultMapping 对象。

针对嵌套映射对应的 ResultMapping 对象进行特殊处理,其核心处理步骤如下:

  1. 确保 ResultMapping 对象的 nestedResultMapId 字段值不为空,该字段值保存了嵌套映射的 ResultMapId;同时还会检查 resultSet 字段是否为空,如果不为空,则是多结果集的映射,不是嵌套映射。
  2. 确定此次嵌套映射使用的 ResultMap 对象,这里依赖上文介绍的 resolveDiscriminatedResultMap() 方法。
  3. 处理循环引用的场景。如果存在循环引用的情况,则此次嵌套映射不会执行,直接重用已存在的嵌套对象即可。这里会先检查在 ancestorObjects 集合中是否已经存在嵌套对象,如果存在,就可以重用这个嵌套对象。
  4. 为嵌套对象创建 CacheKey。嵌套对象的 CacheKey 除了包含嵌套对象的信息,还会包含外层对象的 CacheKey 信息,这样才能得到一个全局唯一的 CacheKey 对象。
  5. 对外层对象的集合属性进行特殊处理。如果外层对象中用于记录当前嵌套对象的属性为 Collection 类型,且该属性未初始化,则这里会初始化该集合。
  6. 调用 getRowValue() 方法完成嵌套映射,得到嵌套对象。嵌套映射是支持嵌套多层的,所以需要递归 getRowValue() 方法。
  7. 通过 linkObjects() 方法,将步骤 6 中映射得到的嵌套对象保存到外层对象的对应属性中,底层会依赖外层对象的 MetaObject 实现属性的设置。

4 延迟加载

MyBatis 中的“延迟加载”是指在查询数据库的时候,MyBatis 不会立即将完整的对象加载到服务内存中,而是在业务逻辑真正需要使用这个对象或使用到对象中某些属性的时候,才真正执行数据库查询操作,将完整的对象加载到内存中。

MyBatis 实现延迟加载的底层原理是动态代理,但并不是使用的 JDK 动态代理,而是通过字节码生成方式实现的动态代理,底层依赖 CGLib 和 Javassist 两个库

之所以不用 JDK 动态代理是因为 JDK 动态代理在生成代理对象的时候,要求目标类必须实现接口,而通过 MyBatis 映射产生的结果对象基本都是 POJO 对象,没有实现任何接口,所以 JDK 动态代理并不适用。

4.1 辅助类

MyBatis 中与延迟加载相关的辅助类是 ResultLoaderResultLoaderMap

首先来看 ResultLoader 辅助类,它记录了一次延迟加载涉及的全部信息,其中包括延迟执行的 SQL 语句(boundSql 字段)、SQL 的实参(parameterObject 字段)、用于执行延迟 SQL 的线程池(executor 字段)以及延迟加载的对象类型(targetType 字段)等,这些信息在真正执行加载操作的时候,都是必要的信息。

ResultLoader 中核心的方法是 loadResult() 方法,其中会先通过 selectList() 方法执行 boundSql 这条延迟加载的 SQL 语句,得到的是一个 List<Object> 集合。在 selectList() 方法中会使用到 Executor 来执行 SQL 语句,接下来通过 ResultExtractor 从这个 List 集合中提取到延迟加载的真正对象,这里就涉及了 List 集合向 targetType 转换的一些逻辑:

  • 如果目标类型就是 List,那 ResultExtractor 无须进行任何转换,直接返回 List
  • 如果目标类型是 Collection 子类、数组类型,则 ResultExtractor 会创建一个元素为 targetType 类型的集合对象,并将 List<Object> 集合中元素项复制到其中;
  • 如果目标类型是一个普通 Java 对象,且上面得到的 List 长度为 1,则从 List 中获取到唯一的元素,并转换成 targetType 类型的对象并返回。

在一个 ResultMap 中,我们可以配置多个延迟加载的属性,这些属性与对应的 ResultLoader 的映射关系就记录在一个 ResultLoaderMap 对象中,ResultLoaderMap 中的 loaderMap 字段(HashMap<String, LoadPair> 类型)就用来维护这一关系,LoadPair 对象就是用来维护 ResultLoader 对象以及一些配置信息的。

ResultLoaderMap 提供了一个 load(String) 方法,参数是触发加载的属性名称,在执行这个方法的时候,会从 loaderMap 中获取(并删除)指定属性对应的 ResultLoader 对象,并调用其 load() 方法执行延迟 SQL,完成延迟加载。这个方法是在 cglibjavassist 生成的代理对象中被调用的(如下图所示),从而实现在使用某个属性时触发延迟加载的效果。调用点如下:

ResultLoaderMap.load() 方法的调用点

ResultLoaderMap 中还有一个 loadAll() 方法,这个方法会触发 loaderMap 中全部 ResultLoaderload() 方法,将所有延迟加载的对象都加载上来。

4.2 ProxyFactory

为了同时接入 CGLib 和 Javassist 两种生成动态代理的方式,MyBatis 提供了一个抽象的 ProxyFactory 接口来抽象动态生成代理类的基本行为,同时提供了下图中的两个实现类来接入上述两种生成方式:

ProxyFactory 的实现类图

CglibProxyFactory 从 3.5.10 版本开始弃用,新版的 MyBatis 以 Javassist 为核心。所以接下来我们只介绍 Javassist 代理细节。

ProxyFactory 接口中定义的核心方法是 createProxy() 方法,从名字也能看出这个方法是用来生成代理对象的。

JavassistProxyFactory 实现中,createProxy() 方法通过调用 EnhancedResultObjectProxyImpl 这个内部类的 createProxy() 方法来创建代理对象,其中先是创建 javassist.util.proxy.ProxyFactory 对象,然后设置父类以及 MethodHandler 等信息,最后通过 javassist.util.proxy.ProxyFactorycreate() 方法创建代理对象。

这里使用到 MethodHandler 实现就是 EnhancedResultObjectProxyImpl 本身,在其 invoke() 方法中首先会在 lazyLoader 集合上加锁防止并发,然后通过 lazyLoader 集合的长度,判断是否存在延迟加载的属性。

在存在延迟加载属性的时候,会执行如下延迟加载操作:

  • 优先检查全局的 aggressiveLazyLoading 配置和 lazyLoadTriggerMethods 配置。
    • 如果 aggressiveLazyLoading 配置为 true,或此次调用方法名称包含于 lazyLoadTriggerMethods 配置的方法名列表中,会立刻将该对象的全部延迟加载属性都加载上来,即触发 ResultLoaderMap.loadAll() 方法:
    • 否则检查此次调用的方法是否为属性对应的 setter 方法:
      • 如果是,则该属性已经被赋值,无须再执行延迟加载操作,可以从 ResultLoaderMap 集合中删除该属性以及对应的 ResultLoader 对象。
      • 否则检测此次调用的方法是否为属性对应的 getter 方法:
        • 如果是,触发对应的 ResultLoader.load() 方法,完成延迟加载。

完成上述延迟加载操作之后,会释放 lazyLoader 集合上的锁,然后调用目标对象的方法,完成真正的属性读写操作。

4.3 延迟加载实现细节

了解了 MyBatis 中延迟加载的底层原理和相关辅助类,我们回到 DefaultResultSetHandler 中,看一下映射处理流程中与延迟加载相关的实现细节。

DefaultResultSetHandler.getPropertyMappingValue() 方法处理单个 ResultMapping 映射规则时候,会调用 getNestedQueryMappingValue() 方法处理嵌套映射,其中会有这么一段逻辑:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// 创建 ResultLoader 对象
final ResultLoader resultLoader = new ResultLoader(configuration, executor, nestedQuery,
 nestedQueryParameterObject, targetType, key, nestedBoundSql);
// 根据是否延迟加载的配置决定 value 的值
if (propertyMapping.isLazy()) {
  lazyLoader.addLoader(property, metaResultObject, resultLoader);
  value = DEFERRED;
} else {
  value = resultLoader.loadResult();
}

我们可以清晰地看到,这里会检测该嵌套映射是否开启了延迟加载特性。

  • 如果开启了,则在 ResultLoaderMap 中记录延迟加载属性以及对应的 ResultLoader 对象,并返回 DEFERED 这个公共的占位符对象;
  • 如果未开启延迟加载特性,则直接执行嵌套查询,完成相应映射操作得到相应的结果对象。

另一个延迟加载的实现细节是在 createResultObject() 方法中,其中有如下代码片段:

1
2
3
4
5
6
7
8
for (ResultMapping propertyMapping : propertyMappings) {
  // 检测所有 ResultMapping 规则,是否开启了延迟加载特性
  if (propertyMapping.getNestedQueryId() != null && propertyMapping.isLazy()) {
    // 创建代理对象,处理延迟加载的属性
    resultObject = configuration.getProxyFactory().createProxy(resultObject, lazyLoader, configuration, objectFactory, constructorArgTypes, constructorArgs);
    break;
  }
}

从上面这段代码中我们可以看到,如果检测到了延迟加载的属性,则会通过前面介绍的 ProxyFactory 为结果对象创建代理对象,然后在真正使用到延迟加载属性(即调用其 getter 方法)的时候,触发代理对象完成该属性的真正加载。

5 多结果集处理

在了解了简单映射、嵌套映射以及延迟加载的处理逻辑之后,下面我们再来介绍一下 MyBatis 中多结果集的处理逻辑。

getPropertyMappingValue() 方法中处理某个属性的映射时,有下面这个代码片段:

1
2
3
4
5
else if (propertyMapping.getResultSet() != null) {
  // 指定了 resultSet 属性,则等待后续结果集解析
  addPendingChildRelation(rs, metaResultObject, propertyMapping);   // TODO is that OK?
  return DEFERRED;
}

这段代码的含义是:这个属性的值来自后续的结果集(对应的结果集名称通过 resultSet 指定),后续结果集在这一时刻还未处理,所以会通过 addPendingChildRelation() 方法将该映射信息添加到 nextResultMaps 集合以及 pendingRelations 集合中暂存。

pendingRelations 集合中维护了 CacheKeyPendingRelation 对象之间的映射,PendingRelation 中维护了当前 ResultMapping 以及外层结果对象,nextResultMaps 集合中维护了 ResultSet 名称与当前 ResultMapping 对象的映射。

处理 nextResultMaps 集合的地方在 handleResultSets() 方法中。在 handleResultSets() 方法完成全部 ResultMapping 映射之后,会开始遍历 nextResultMaps 集合,根据其中每个 ResultMapping 对象指定的 ResultMap 对后续的多个结果集进行映射,并将映射得到的结果对象设置到外层对象的相应属性中,相关的代码片段如下:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
while (rsw != null && resultSetCount < resultSets.length) {
  // 获取 nextResultMaps 中的 ResultMapping 对象
  ResultMapping parentMapping = nextResultMaps.get(resultSets[resultSetCount]);
  if (parentMapping != null) {
    // 获取 ResultMapping 中指定的 ResultMap 映射规则
    String nestedResultMapId = parentMapping.getNestedResultMapId();
    ResultMap resultMap = configuration.getResultMap(nestedResultMapId);
    // 进行结果集映射,得到的结果对象会添加到外层结果对象的相应属性中
    handleResultSet(rsw, resultMap, null, parentMapping);
  }
  // 继续获取下一个 ResultSet
  rsw = getNextResultSet(stmt);
  cleanUpAfterHandlingResultSet();
  resultSetCount++;
}

处理 pendingRelations 集合的地方是在 linkToParents() 方法中,该方法会从 pendingRelations 集合中获取结果对象所在外层对象,然后通过 linkObjects() 方法进行设置。

至此,MyBatis 中结果集映射的核心内容就介绍完了。


欢迎关注我的公众号,第一时间获取文章更新:

微信公众号

相关内容