MyBatis從入門到精通(九)：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"/>

不然會報以下錯誤。

4. 源碼及參考

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

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

5. 最後

打個小廣告，歡迎掃碼關注微信公衆號：「申城異鄉人」，按期分享Java技術乾貨，讓咱們一塊兒進步。