MyBatis從入門到精通(九)：MyBatis高階結果對映之一對一對映

申城異鄉人發表於2019-07-11
MyBatis

最近在讀劉增輝老師所著的《MyBatis從入門到精通》一書，很有收穫，於是將自己學習的過程以部落格形式輸出，如有錯誤，歡迎指正，如幫助到你，不勝榮幸！

本篇部落格主要講解MyBatis中實現查詢結果一對一對映的3種方式：

  1. 使用別名實現自動對映
  2. 使用resultMap配置
  3. 使用resultMap的association標籤配置

1. 使用別名實現自動對映

假設有這樣1個需求：根據使用者id查詢使用者資訊的同時獲取使用者擁有的角色，為了舉例，我們假設一個使用者只能擁有一個角色(實際情況肯定不是這樣的)。

一般情況下，不建議直接修改資料庫表對應的實體類，所以這裡我們新建類SysUserExtend，讓它繼承自SysUser類，並新增SysRole型別的欄位，如下所示：

package com.zwwhnly.mybatisaction.model;

import java.util.List;

public class SysUserExtend extends SysUser {
    /**
     * 使用者角色
     */
    private SysRole sysRole;

    public SysRole getSysRole() {
        return sysRole;
    }

    public void setSysRole(SysRole sysRole) {
        this.sysRole = sysRole;
    }
}

然後，我們在介面SysUserMapper中新增如下方法：

/**
 * 根據使用者id獲取使用者資訊和使用者的角色資訊
 *
 * @param id
 * @return
 */
SysUserExtend selectUserAndRoleById(Long id);

接著，在對應的SysUserMapper.xml中新增如下程式碼：

<select id="selectUserAndRoleById" resultType="com.zwwhnly.mybatisaction.model.SysUserExtend">
    SELECT u.id,
           u.user_name userName,
           u.user_password userPassword,
           u.user_email userEmail,
           u.create_time createTime,
           r.id "sysRole.id",
           r.role_name   "sysRole.roleName",
           r.enabled "sysRole.enabled",
           r.create_by   "sysRole.createBy",
           r.create_time "sysRole.createTime"
    FROM sys_user u
    INNER JOIN sys_user_role ur ON u.id = ur.user_id
    INNER JOIN sys_role r ON ur.role_id = r.id
    WHERE u.id = #{id}
</select>

這裡要注意兩點，第一點是這裡的resultType，要設定成剛剛新建的SysUserExtend類，第二點是列的別名要設定成"sysRole.id"這樣的格式，其中sysRole要和SysUserExtend類中的欄位名保持一致，id要和SysRole類中的欄位名保持一致。

最後，在SysUserMapperTest測試類中新增如下測試方法：

@Test
public void testSelectUserAndRoleById() {
    SqlSession sqlSession = getSqlSession();

    try {
        SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);

        // 注意這裡使用1001這個使用者，因為這個使用者只有1個角色
        SysUserExtend sysUserExtend = sysUserMapper.selectUserAndRoleById(1001L);

        Assert.assertNotNull(sysUserExtend);
        Assert.assertNotNull(sysUserExtend.getSysRole());
    } finally {
        sqlSession.close();
    }
}

執行測試程式碼，測試通過，輸出日誌如下：

DEBUG [main] - ==> Preparing: SELECT u.id, u.user_name userName, u.user_password userPassword, u.user_email userEmail, u.create_time createTime, r.id "sysRole.id", r.role_name "sysRole.roleName", r.enabled "sysRole.enabled", r.create_by "sysRole.createBy", r.create_time "sysRole.createTime" FROM sys_user u INNER JOIN sys_user_role ur ON u.id = ur.user_id INNER JOIN sys_role r ON ur.role_id = r.id WHERE u.id = ?

DEBUG [main] - ==> Parameters: 1001(Long)

TRACE [main] - <== Columns: id, userName, userPassword, userEmail, createTime, sysRole.id, sysRole.roleName, sysRole.enabled, sysRole.createBy, sysRole.createTime

TRACE [main] - <== Row: 1001, test, 123456, test@mybatis.tk, 2019-06-27 18:21:07.0, 2, 普通使用者, 1, 1, 2019-06-27 18:21:12.0

DEBUG [main] - <== Total: 1

2. 使用resultMap配置

延用上面的需求，不過換成resultMap來配置對映。

首先，我們在介面SysUserMapper中新增如下方法：

/**
 * 根據使用者id獲取使用者資訊和使用者的角色資訊
 *
 * @param id
 * @return
 */
SysUserExtend selectUserAndRoleByIdResultMap(Long id);

然後在對應的SysUserMapper.xml中先新增如下resultMap：

<resultMap id="userRoleMap" type="com.zwwhnly.mybatisaction.model.SysUserExtend">
        <id property="id" column="id"/>
        <result property="userName" column="user_name"/>
        <result property="userPassword" column="user_password"/>
        <result property="userEmail" column="user_email"/>
        <result property="userInfo" column="user_info"/>
        <result property="headImg" column="head_img" jdbcType="BLOB"/>
        <result property="createTime" column="create_time" jdbcType="TIMESTAMP"/>
        <!--role相關屬性-->
        <result property="sysRole.id" column="role_id"/>
        <result property="sysRole.roleName" column="role_role_name"/>
        <result property="sysRole.enabled" column="role_enabled"/>
        <result property="sysRole.createBy" column="role_create_by"/>
        <result property="sysRole.createTime" column="role_create_time" jdbcType="TIMESTAMP"/>
</resultMap>

為了避免多張表有相同的列名，所以這裡配置role相關屬性時，統一加上了"role_"這樣的字首，這裡要和下方的查詢語句中設定的列的別名保持一致：

<select id="selectUserAndRoleByIdResultMap" resultMap="userRoleMap">
    SELECT  u.id,
            u.user_name,
            u.user_password,
            u.user_email,
            u.create_time,
            r.id role_id,
            r.role_name role_role_name,
            r.enabled role_enabled,
            r.create_by role_create_by,
            r.create_time role_create_time
    FROM sys_user u
    INNER JOIN sys_user_role ur ON u.id = ur.user_id
    INNER JOIN sys_role r ON ur.role_id = r.id
    WHERE u.id = #{id}
</select>

注意事項：這裡的查詢語句，我們使用的是resultMap而不是resultType。

由於測試程式碼和輸出日誌都和1中的幾乎一致，所以這裡不再列出。

可能有的同學還記得我們之前在SysUserMapper.xml中配置過這樣的一個resultMap：

<resultMap id="sysUserMap" type="com.zwwhnly.mybatisaction.model.SysUser">
    <id property="id" column="id"/>
    <result property="userName" column="user_name"/>
    <result property="userPassword" column="user_password"/>
    <result property="userEmail" column="user_email"/>
    <result property="userInfo" column="user_info"/>
    <result property="headImg" column="head_img" jdbcType="BLOB"/>
    <result property="createTime" column="create_time" jdbcType="TIMESTAMP"/>
</resultMap>

然後就會想，我們剛剛定義的userRoleMap，前半部分和這個配置都是一樣的，能複用這個sysUserMap的配置嗎？

答案當然是可以，MyBatis是支援resultMap對映繼承的。

所以，userRoleMap可以繼承自sysUserMap，省略掉重複的配置，優化後的配置如下所示：

<resultMap id="userRoleMap" type="com.zwwhnly.mybatisaction.model.SysUserExtend" extends="sysUserMap">
    <!--role相關屬性-->
    <result property="sysRole.id" column="role_id"/>
    <result property="sysRole.roleName" column="role_role_name"/>
    <result property="sysRole.enabled" column="role_enabled"/>
    <result property="sysRole.createBy" column="role_create_by"/>
    <result property="sysRole.createTime" column="role_create_time" jdbcType="TIMESTAMP"/>
</resultMap>

3. 使用resultMap的association標籤配置

上面的配置也可以用association標籤來配置，配置方式如下所示（實現的效果是一樣的）：

<resultMap id="userRoleMap" type="com.zwwhnly.mybatisaction.model.SysUserExtend" extends="sysUserMap">
    <association property="sysRole" columnPrefix="role_" javaType="com.zwwhnly.mybatisaction.model.SysRole">
        <result property="id" column="id"/>
        <result property="roleName" column="role_name"/>
        <result property="enabled" column="enabled"/>
        <result property="createBy" column="create_by"/>
        <result property="createTime" column="create_time" jdbcType="TIMESTAMP"/>
    </association>
</resultMap>

有想法的同學可能會覺得，角色表的對映配置完全可以獨立出來配置啊，比如這樣：

<resultMap id="roleMap" type="com.zwwhnly.mybatisaction.model.SysRole">
    <id property="id" column="id"/>
    <result property="roleName" column="role_name"/>
    <result property="enabled" column="enabled"/>
    <result property="createBy" column="create_by"/>
    <result property="createTime" column="create_time" jdbcType="TIMESTAMP"/>
</resultMap>

然後強大的MyBatis可以讓association標籤來直接使用roleMap，所以上面的association標籤配置可以優化為：

<resultMap id="userRoleMap" type="com.zwwhnly.mybatisaction.model.SysUserExtend" extends="sysUserMap">
    <association property="sysRole" columnPrefix="role_"
                     resultMap="roleMap"/>
</resultMap>

此時，roleMap我們是建在SysUserMapper.xml中的，不過實際使用中，這個roleMap放到SysRoleMapper.xml中會更合理一些。

不過要注意的是，將roleMap移動到SysRoleMapper.xml中後，引用roleMap時就要使用全名，如下所示：

<association property="sysRole" columnPrefix="role_"
             resultMap="com.zwwhnly.mybatisaction.mapper.SysRoleMapper.roleMap"/>

否則會報如下錯誤。

MyBatis從入門到精通(九)：MyBatis高階結果對映之一對一對映

4. 原始碼及參考

原始碼地址：https://github.com/zwwhnly/mybatis-action.git，歡迎下載。

劉增輝《MyBatis從入門到精通》

相關文章