MyBatis 3手册 MyBatis 3 结果映射-基本方法

resultMap ​元素是 MyBatis 中最重要最强大的元素。它可以让你从 90% 的 ​JDBC ResultSets​ 数据提取代码中解放出来，并在一些情形下允许你进行一些 ​JDBC ​不支持的操作。实际上，在为一些比如连接的复杂语句编写映射代码的时候，一份 ​resultMap ​能够代替实现同等功能的数千行代码。​ResultMap ​的设计思想是，对简单的语句做到零配置，对于复杂一点的语句，只需要描述语句之间的关系就行了。

之前你已经见过简单映射语句的示例，它们没有显式指定 ​resultMap​。比如：

<select id="selectUsers" resultType="map">
  select id, username, hashedPassword
  from some_table
  where id = #{id}
</select>

上述语句只是简单地将所有的列映射到 ​HashMap ​的键上，这由 ​resultType ​属性指定。虽然在大部分情况下都够用，但是 ​HashMap ​并不是一个很好的领域模型。你的程序更可能会使用 ​JavaBean ​或 ​POJO​（​Plain Old Java Objects​，普通老式 Java 对象）作为领域模型。MyBatis 对两者都提供了支持。看看下面这个 ​JavaBean​：

package com.someapp.model;
public class User {
  private int id;
  private String username;
  private String hashedPassword;
  public int getId() {
    return id;
  }
  public void setId(int id) {
    this.id = id;
  }
  public String getUsername() {
    return username;
  }
  public void setUsername(String username) {
    this.username = username;
  }
  public String getHashedPassword() {
    return hashedPassword;
  }
  public void setHashedPassword(String hashedPassword) {
    this.hashedPassword = hashedPassword;
  }
}

基于 ​JavaBean ​的规范，上面这个类有 3 个属性：​id​，​username ​和 ​hashedPassword​。这些属性会对应到 ​select ​语句中的列名。

这样的一个 ​JavaBean ​可以被映射到 ​ResultSet​，就像映射到 ​HashMap ​一样简单。

<select id="selectUsers" resultType="com.someapp.model.User">
  select id, username, hashedPassword
  from some_table
  where id = #{id}
</select>

类型别名是你的好帮手。使用它们，你就可以不用输入类的全限定名了。比如：

<!-- mybatis-config.xml 中 -->
<typeAlias type="com.someapp.model.User" alias="User"/>
<!-- SQL 映射 XML 中 -->
<select id="selectUsers" resultType="User">
  select id, username, hashedPassword
  from some_table
  where id = #{id}
</select>

在这些情况下，MyBatis 会在幕后自动创建一个 ​ResultMap​，再根据属性名来映射列到 ​JavaBean ​的属性上。如果列名和属性名不能匹配上，可以在 ​SELECT ​语句中设置列别名（这是一个基本的 SQL 特性）来完成匹配。比如：

<select id="selectUsers" resultType="User">
  select
    user_id             as "id",
    user_name           as "userName",
    hashed_password     as "hashedPassword"
  from some_table
  where id = #{id}
</select>

在学习了上面的知识后，你会发现上面的例子没有一个需要显式配置 ​ResultMap​，这就是 ​ResultMap ​的优秀之处——你完全可以不用显式地配置它们。 虽然上面的例子不用显式配置 ​ResultMap​。 但为了讲解，我们来看看如果在刚刚的示例中，显式使用外部的 ​resultMap ​会怎样，这也是解决列名不匹配的另外一种方式。

<resultMap id="userResultMap" type="User">
  <id property="id" column="user_id" />
  <result property="username" column="user_name"/>
  <result property="password" column="hashed_password"/>
</resultMap>

然后在引用它的语句中设置 ​resultMap ​属性就行了（注意我们去掉了 ​resultType ​属性）。比如:

<select id="selectUsers" resultMap="userResultMap">
  select user_id, user_name, hashed_password
  from some_table
  where id = #{id}
</select>

高级结果映射

MyBatis 创建时的一个思想是：数据库不可能永远是你所想或所需的那个样子。 我们希望每个数据库都具备良好的第三范式或 ​BCNF ​范式，可惜它们并不都是那样。 如果能有一种数据库映射模式，完美适配所有的应用程序，那就太好了，但可惜也没有。 而 ​ResultMap ​就是 MyBatis 对这个问题的答案。

比如，我们如何映射下面这个语句？

<!-- 非常复杂的语句 -->
<select id="selectBlogDetails" resultMap="detailedBlogResultMap">
  select
       B.id as blog_id,
       B.title as blog_title,
       B.author_id as blog_author_id,
       A.id as author_id,
       A.username as author_username,
       A.password as author_password,
       A.email as author_email,
       A.bio as author_bio,
       A.favourite_section as author_favourite_section,
       P.id as post_id,
       P.blog_id as post_blog_id,
       P.author_id as post_author_id,
       P.created_on as post_created_on,
       P.section as post_section,
       P.subject as post_subject,
       P.draft as draft,
       P.body as post_body,
       C.id as comment_id,
       C.post_id as comment_post_id,
       C.name as comment_name,
       C.comment as comment_text,
       T.id as tag_id,
       T.name as tag_name
  from Blog B
       left outer join Author A on B.author_id = A.id
       left outer join Post P on B.id = P.blog_id
       left outer join Comment C on P.id = C.post_id
       left outer join Post_Tag PT on PT.post_id = P.id
       left outer join Tag T on PT.tag_id = T.id
  where B.id = #{id}
</select>

你可能想把它映射到一个智能的对象模型，这个对象表示了一篇博客，它由某位作者所写，有很多的博文，每篇博文有零或多条的评论和标签。 我们先来看看下面这个完整的例子，它是一个非常复杂的结果映射（假设作者，博客，博文，评论和标签都是类型别名）。 不用紧张，我们会一步一步地来说明。虽然它看起来令人望而生畏，但其实非常简单。

<!-- 非常复杂的结果映射 -->
<resultMap id="detailedBlogResultMap" type="Blog">
  <constructor>
    <idArg column="blog_id" javaType="int"/>
  </constructor>
  <result property="title" column="blog_title"/>
  <association property="author" javaType="Author">
    <id property="id" column="author_id"/>
    <result property="username" column="author_username"/>
    <result property="password" column="author_password"/>
    <result property="email" column="author_email"/>
    <result property="bio" column="author_bio"/>
    <result property="favouriteSection" column="author_favourite_section"/>
  </association>
  <collection property="posts" ofType="Post">
    <id property="id" column="post_id"/>
    <result property="subject" column="post_subject"/>
    <association property="author" javaType="Author"/>
    <collection property="comments" ofType="Comment">
      <id property="id" column="comment_id"/>
    </collection>
    <collection property="tags" ofType="Tag" >
      <id property="id" column="tag_id"/>
    </collection>
    <discriminator javaType="int" column="draft">
      <case value="1" resultType="DraftPost"/>
    </discriminator>
  </collection>
</resultMap>

​​resultMap ​​元素有很多子元素和一个值得深入探讨的结构。 下面是​resultMap ​元素的概念视图。

结果映射（resultMap）

• ​constructor ​- 用于在实例化类时，注入结果到构造方法中
• ​idArg ​- ID 参数；标记出作为 ID 的结果可以帮助提高整体性能​arg ​- 将被注入到构造方法的一个普通结果
• ​id ​– 一个 ID 结果；标记出作为 ID 的结果可以帮助提高整体性能
• ​result ​– 注入到字段或 ​JavaBean ​属性的普通结果
• ​association ​– 一个复杂类型的关联；许多结果将包装成这种类型
• 嵌套结果映射 – 关联可以是 ​resultMap ​元素，或是对其它结果映射的引用
• ​collection ​– 一个复杂类型的集合
• 嵌套结果映射 – 集合可以是 ​resultMap ​元素，或是对其它结果映射的引用
• ​discriminator ​– 使用结果值来决定使用哪个 ​resultMap​
• ​case ​– 基于某些值的结果映射嵌套结果映射 – ​case ​也是一个结果映射，因此具有相同的结构和元素；或者引用其它的结果映射

最好逐步建立结果映射。单元测试可以在这个过程中起到很大帮助。 如果你尝试一次性创建像上面示例那么巨大的结果映射，不仅容易出错，难度也会直线上升。 所以，从最简单的形态开始，逐步迭代。而且别忘了单元测试！ 有时候，框架的行为像是一个黑盒子（无论是否开源）。因此，为了确保实现的行为与你的期望相一致，最好编写单元测试。 并且单元测试在提交 bug 时也能起到很大的作用。

下一部分将详细说明每个元素。

id & result

<id property="id" column="post_id"/>
<result property="subject" column="post_subject"/>

这些元素是结果映射的基础。id 和 result 元素都将一个列的值映射到一个简单数据类型（String, int, double, Date 等）的属性或字段。

这两者之间的唯一不同是，id 元素对应的属性会被标记为对象的标识符，在比较对象实例时使用。 这样可以提高整体的性能，尤其是进行缓存和嵌套结果映射（也就是连接映射）的时候。

两个元素都有一些属性：

支持的 JDBC 类型

为了以后可能的使用场景，MyBatis 通过内置的 ​jdbcType ​枚举类型支持下面的 ​JDBC ​类型。

构造方法

通过修改对象属性的方式，可以满足大多数的数据传输对象（​Data Transfer Object​, ​DTO​）以及绝大部分领域模型的要求。但有些情况下你想使用不可变类。 一般来说，很少改变或基本不变的包含引用或数据的表，很适合使用不可变类。 构造方法注入允许你在初始化时为类设置属性的值，而不用暴露出公有方法。MyBatis 也支持私有属性和私有 ​JavaBean ​属性来完成注入，但有一些人更青睐于通过构造方法进行注入。 ​constructor ​元素就是为此而生的。

看看下面这个构造方法:

public class User {
   //...
   public User(Integer id, String username, int age) {
     //...
  }
//...
}

为了将结果注入构造方法，MyBatis 需要通过某种方式定位相应的构造方法。 在下面的例子中，MyBatis 搜索一个声明了三个形参的构造方法，参数类型以 ​java.lang.Integer​, ​java.lang.String​ 和 ​int ​的顺序给出。

<constructor>
   <idArg column="id" javaType="int"/>
   <arg column="username" javaType="String"/>
   <arg column="age" javaType="_int"/>
</constructor>

当你在处理一个带有多个形参的构造方法时，很容易搞乱 ​arg ​元素的顺序。 从版本 3.4.3 开始，可以在指定参数名称的前提下，以任意顺序编写 ​arg ​元素。 为了通过名称来引用构造方法参数，你可以添加 ​@Param​ 注解，或者使用 '​-parameters​' 编译选项并启用 ​useActualParamName ​选项（默认开启）来编译项目。下面是一个等价的例子，尽管函数签名中第二和第三个形参的顺序与 ​constructor ​元素中参数声明的顺序不匹配。

<constructor>
   <idArg column="id" javaType="int" name="id" />
   <arg column="age" javaType="_int" name="age" />
   <arg column="username" javaType="String" name="username" />
</constructor>

如果存在名称和类型相同的属性，那么可以省略 ​javaType ​。

剩余的属性和规则和普通的 ​id ​和 ​result ​元素是一样的。