association 标签

本文将介绍 <association> 标签的用法，该标签用来实现一对一映射。

关联（association）元素处理“有一个”类型的关系。 比如，在我们的示例中，一个博客有一个用户。关联结果映射和其它类型的映射工作方式差不多。 你需要指定目标属性名以及属性的javaType（很多时候 MyBatis 可以自己推断出来），在必要的情况下你还可以设置 JDBC 类型，如果你想覆盖获取结果值的过程，还可以设置类型处理器。

关联的不同之处是，你需要告诉 MyBatis 如何加载关联。MyBatis 有两种不同的方式加载关联：

（1）嵌套 Select 查询：通过执行另外一个 SQL 映射语句来加载期望的复杂类型。

（2）嵌套结果映射：使用嵌套的结果映射来处理连接结果的重复子集。

<association> 标签的属性：

嵌套 Select 查询

下面通过用户和联系方式的关系，在 user 的结果映射中使用 association 标签的 select 属性引用其他 select 标签来实现关联，如下：

<!-- 联系方式对象映射 -->
<resultMap id="CONTACT_RESULT_MAP" type="com.hxstrive.mybatis.resultmap.demo9.ContactBean">
    <id column="id" jdbcType="INTEGER" property="id" />
    <result column="user_id" jdbcType="INTEGER" property="userId" />
    <result column="usage" jdbcType="VARCHAR" property="usage" />
    <result column="number" jdbcType="VARCHAR" property="number" />
</resultMap>

<!-- 利用 association 的 select 属性关联另一个 select 标签 -->
<resultMap id="USER_RESULT_MAP" type="com.hxstrive.mybatis.resultmap.demo9.UserBean">
    <id column="user_id" jdbcType="INTEGER" property="userId" />
    <result column="name" jdbcType="VARCHAR" property="name" />
    <result column="sex" jdbcType="VARCHAR" property="sex" />
    <result column="age" jdbcType="INTEGER" property="age" />
    <!-- 使用 select 关联 findContact -->
    <association property="contactBean" column="user_id" select="findContact"
                 javaType="com.hxstrive.mybatis.resultmap.demo9.ContactBean" />
</resultMap>

<select id="findAll" resultMap="USER_RESULT_MAP">
    select `user_id`, `name`, `sex`, `age` from `user`
</select>

<select id="findContact" resultMap="CONTACT_RESULT_MAP">
    select `id`, `user_id`, `usage`, `number`
    from user_contact
    where `user_id`=#{userId}
</select>

Mapper 接口定义如下：

public interface UserMapper {

   /** 查询所有用户信息 */
   List<UserBean> findAll();

   /** 根据用户ID获取联系方式 */
   List<ContactBean> findContact(@Param("userId") int userId);

}

mybatis广告位

嵌套结果映射

下面通过用户书籍的关系来介绍嵌套结果映射。其中，一个用户拥有一本书（实际上一个用户可以有多本书，这里只是演示 <association> 标签的用法）。

（1）假设我们有如下一个稍微复杂的SQL语句，用来查询用户拥有的书籍。如下：

select u.`user_id`, u.`name`, u.`sex`, u.`age`,
    b.book_id, b.book_name, b.price, b.content
from `user` u
join `user_book` ub on u.user_id=ub.user_id
join `book` b on b.book_id=ub.book_id

其中，user_book 表是一张中间表，保存书籍和用户的关系。

（2）我们根据上面 SQL 定义了如下 UserBean 和 BookBean，代码如下：

public class UserBean {
   private Integer userId;
   private String name;
   private String sex;
   private Integer age;
   // 这里引用了另一个JavaBean BookBean，实现用户拥有一本书的关联关系，需要使用 association 标签
   private BookBean bookBean;
   
   // 提供了一个接受用户ID和名称的构造方法，需要使用 constructor 标签
   public UserBean(Integer userId, String name) {
      this.userId = userId;
      this.name = name;
   }
   // 忽略了 getter 和 setter 方法
}

BookBean 代码如下：

public class BookBean {
   private Integer bookId;
   private String bookName;
   private Float price;
   private String content;
   // 忽略了 getter 和 setter 方法
}

（3）接下来我们就需要使用 XML Mapper 文件来映射 JavaBean 和数据库表的关系。代码如下：

<resultMap id="RESULT_MAP" type="com.hxstrive.mybatis.resultmap.demo6.UserBean">
    <constructor>
        <idArg column="user_id" javaType="int" />
        <arg column="name" javaType="String" />
    </constructor>
    <result column="sex" jdbcType="VARCHAR" property="sex" />
    <result column="age" jdbcType="INTEGER" property="age" />
    <association property="bookBean" javaType="com.hxstrive.mybatis.resultmap.demo6.BookBean">
        <id column="book_id" jdbcType="INTEGER" property="bookId" />
        <result column="book_name" jdbcType="VARCHAR" property="bookName" />
        <result column="price" jdbcType="FLOAT" property="price" />
        <result column="content" jdbcType="VARCHAR" property="content" />
    </association>
</resultMap>

上面 XML 代码是一个完整的结果映射，将 com.hxstrive.mybatis.resultmap.demo6.UserBean 映射成 RESULT_MAP，这样我们就可以在 <select> 标签的 resultMap 属性中使用。<association> 标签实现用户和书籍之间的关联映射，其中：

• property：用于指定需要映射的 UserBean 的属性名

• javaType：指定 property 属性指定的 JavaBean 属性的 Java 类型。

<association> 标签内部的 <id>、<result> 标签用法和 <resultMap> 下面的  <id>、<result> 标签一样，这里将不再赘述。

注意：如果一个用户拥有多本书籍，此时使用 <association> 实现一对一映射，MyBatis 将最后一条书籍数据和用户数据进行关联。如下：

用户      书籍

---------------------

 A         AB1

            AB2

            AB3

 B         BB

 C         CB

最终映射结果：

用户      书籍

---------------------

 A         AB3

 B         BB

 C         CB

完整示例

（1）MyBatis 配置文件 mybatis-cfg.xml 内容如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <properties resource="database.properties"/>
    <environments default="MySqlDatabase" >
        <environment id="MySqlDatabase" >
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com\hxstrive\mybatis\resultmap\demo6\UserMapper.xml" />
    </mappers>
</configuration>

（2）UserBean 和 BookBean 代码如下：

a、UserBean.java

package com.hxstrive.mybatis.resultmap.demo6;
public class UserBean {
   private Integer userId;
   private String name;
   private String sex;
   private Integer age;
   private BookBean bookBean;
   public UserBean(Integer userId, String name) {
      this.userId = userId;
      this.name = name;
   }
   // 忽略 getter 和 setter
   @Override
   public String toString() {
      return "UserBean{" +
            "userId=" + userId +
            ", name='" + name + '\'' +
            ", sex='" + sex + '\'' +
            ", age=" + age +
            "} \n\t" + bookBean;
   }
}

b、BookBean.java

package com.hxstrive.mybatis.resultmap.demo6;
public class BookBean {
   private Integer bookId;
   private String bookName;
   private Float price;
   private String content;
   // 忽略 getter 和 setter
   @Override
   public String toString() {
      return "BookBean{" +
            "bookId=" + bookId +
            ", bookName='" + bookName + '\'' +
            ", price=" + price +
            ", content='" + content + '\'' +
            '}';
   }
}

（3）Mapper 接口文件 UserMapper.java 代码如下：

package com.hxstrive.mybatis.resultmap.demo6;

import java.util.List;

public interface UserMapper {
   /** 查询所有用户信息 */
   List<UserBean> findAll();
}

（4）Mapper XML 文件 UserMapper.xml 代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
   "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.hxstrive.mybatis.resultmap.demo6.UserMapper">

   <resultMap id="RESULT_MAP" type="com.hxstrive.mybatis.resultmap.demo6.UserBean">
      <constructor>
         <idArg column="user_id" javaType="int" />
         <arg column="name" javaType="String" />
      </constructor>
      <result column="sex" jdbcType="VARCHAR" property="sex" />
      <result column="age" jdbcType="INTEGER" property="age" />
      <association property="bookBean" javaType="com.hxstrive.mybatis.resultmap.demo6.BookBean">
         <id column="book_id" jdbcType="INTEGER" property="bookId" />
         <result column="book_name" jdbcType="VARCHAR" property="bookName" />
         <result column="price" jdbcType="FLOAT" property="price" />
         <result column="content" jdbcType="VARCHAR" property="content" />
      </association>
   </resultMap>
   
   <select id="findAll" resultMap="RESULT_MAP">
      select u.`user_id`, u.`name`, u.`sex`, u.`age`,
         b.book_id, b.book_name, b.price, b.content
      from `user` u
      join `user_book` ub on u.user_id=ub.user_id
      join `book` b on b.book_id=ub.book_id
   </select>
   
</mapper>

（5）客户端代码如下：

package com.hxstrive.mybatis.resultmap.demo6;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.InputStream;
import java.util.List;

public class ResultMapDemo6 {

   public static void main(String[] args) throws Exception {
      // 获取 Mapper 对象
      String cfgName = "com/hxstrive/mybatis/resultmap/demo6/mybatis-cfg.xml";
      InputStream input = Resources.getResourceAsStream(cfgName);
      SqlSessionFactoryBuilder factoryBuilder = new SqlSessionFactoryBuilder();
      SqlSessionFactory sqlFactory = factoryBuilder.build(input);
      SqlSession sqlSession = sqlFactory.openSession(true);
      UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
      List<UserBean> userBeanList = userMapper.findAll();
      for(UserBean userBean : userBeanList) {
         System.out.println("结果：" + userBean);
      }
   }
   
}