从Mapper到JavaBean源码层面解析ResultMap是怎么映射的

关忆北.

发布于 2022-05-30 09:11:24

5630

发布于 2022-05-30 09:11:24

文章被收录于专栏：关忆北.关忆北.

起点：

源码下载：

本文以3.3.x分支版本源码为例。

在源码工程的test中以NestedQueryCacheTest测试类下的testThatNestedQueryItemsAreRetrievedFromCache为例：

该方法中调的Mapper为：

<resultMap id="selectAuthor" type="org.apache.ibatis.domain.blog.Author">
  <id column="id" property="id" />
  <result property="username" column="username" />
  <result property="password" column="password" />
  <result property="email" column="email" />
  <result property="bio" column="bio" />
  <result property="favouriteSection" column="favourite_section" />
</resultMap>

<select id="selectAuthor" resultMap="selectAuthor">
  select id, username, password, email, bio, favourite_section
  from author where id = #{id}
</select>

resultMap工作原理

MyBatis中的标签主要用于返回javaType列和自定义列以及配合、标签实现一对一、一对多查询映射关系。MyBatis通过ResultMapElement类实现对的解析，解析过程中实质上是构造ResultMapping对象，记录结果集中某一列与JavaBean中一个属性的对应关系

启动测试，在XMLMapperBuilder第108行打断点，通过XNode类型的context参数可获取到目标Mapper的包路径及名称，然后缓存下来，这样就保证了在多次访问时，Mapper文件我们只需要加载一次。

private void configurationElement(XNode context) {
  try {
    String namespace = context.getStringAttribute("namespace");
    if (namespace == null || namespace.equals("")) {
      throw new BuilderException("Mapper's namespace cannot be empty");
    }
    builderAssistant.setCurrentNamespace(namespace);
    cacheRefElement(context.evalNode("cache-ref"));
    cacheElement(context.evalNode("cache"));
    parameterMapElement(context.evalNodes("/mapper/parameterMap"));
    resultMapElements(context.evalNodes("/mapper/resultMap"));
    sqlElement(context.evalNodes("/mapper/sql"));
    buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
  } catch (Exception e) {
    throw new BuilderException("Error parsing Mapper XML. Cause: " + e, e);
  }
}

在ResultMapElement中，resultMapElements中定义了resulteMap xml文件的解析方法。在该方法中，入参是XNode类型的List列表。xml是一种数据展现和存储的方式，为获取xml中的数据，我们需要Java-XML中间做一层转化，XNode就是MyBatis定义解析XML节点中属性和对应值的工具。

private void resultMapElements(List<XNode> list) throws Exception {
  for (XNode resultMapNode : list) {
    try {
      resultMapElement(resultMapNode);
    } catch (IncompleteElementException e) {
      // ignore, it will be retried
    }
  }
}

在XMLMapperBuilder第242行断点,查看List的值：

可见，MyBatis已经通过XNode获取到了xml文件中的resultMap编写的代码，接下来就是要在for循环中解析resultMap中每一行的数据。

解析resultMap每一行的映射关系

第一步获取id，默认拼装所有父节点的Id或property(唯一标识)

第二步，获取类型

type是resultMap标签的，ofType是collection标签的，resultType是select、insert、update、delete标签的。标签允许多个type，优先级为： 【type】>【ofType】>【resultType】>【javaType】

第三步，判断该resultMap是否继承自其它resultMap，是否开启了自动映射配置。

autoMapping:自动映射：自动根据大小写实现SQL column <—>JavaBean(POJO) field转换

第四步，根据type找到对应类

第五步，将从XNode中获取到的全部节点，将每一行数据都放入到List中，经buildResultMappingFromContext()完成映射。

private ResultMapping buildResultMappingFromContext(XNode context, Class<?> resultType, List<ResultFlag> flags) throws Exception {
  // 列和字段对应关系
  String property = context.getStringAttribute("property");
  // 列和字段对应关系
  String column = context.getStringAttribute("column");
  // 列和字段对应关系
  String javaType = context.getStringAttribute("javaType");
  // 列和字段对应关系
  String jdbcType = context.getStringAttribute("jdbcType");
  String nestedSelect = context.getStringAttribute("select");
  //判断该标签中是否嵌套ResultMap
  String nestedResultMap = context.getStringAttribute("resultMap",
      processNestedResultMappings(context, Collections.<ResultMapping> emptyList()));
  String notNullColumn = context.getStringAttribute("notNullColumn");
  String columnPrefix = context.getStringAttribute("columnPrefix");
  String typeHandler = context.getStringAttribute("typeHandler");
  String resulSet = context.getStringAttribute("resultSet");
  String foreignColumn = context.getStringAttribute("foreignColumn");
  boolean lazy = "lazy".equals(context.getStringAttribute("fetchType", configuration.isLazyLoadingEnabled() ? "lazy" : "eager"));
  Class<?> javaTypeClass = resolveClass(javaType);
  @SuppressWarnings("unchecked")
  Class<? extends TypeHandler<?>> typeHandlerClass = (Class<? extends TypeHandler<?>>) resolveClass(typeHandler);
  JdbcType jdbcTypeEnum = resolveJdbcType(jdbcType);
  //返回构造参数映射
  return builderAssistant.buildResultMapping(resultType, property, column, javaTypeClass, jdbcTypeEnum, nestedSelect, nestedResultMap, notNullColumn, columnPrefix, typeHandlerClass, flags, resulSet, foreignColumn, lazy);
}

构造参数映射（普通对象）

构造参数映射（嵌套对象）

private String processNestedResultMappings(XNode context, List<ResultMapping> resultMappings) throws Exception {
  if ("association".equals(context.getName())
      || "collection".equals(context.getName())
      || "case".equals(context.getName())) {
    if (context.getStringAttribute("select") == null) {
      //递归调用解析元素方法
      ResultMap resultMap = resultMapElement(context, resultMappings);
      return resultMap.getId();
    }
  }
  return null;
}

当解析到的Mapper中的方法中嵌套了另一个、的resultMap时，那么会递归调用映射方法，并将返回值做为本Map的一个参数返回。