引言
<resultMap>
是 MyBatis 中最核心的映射配置元素,用于解決數據庫字段與 Java 對象屬性之間的復雜映射問題,尤其是字段名不一致、嵌套對象關聯、集合映射等場景。ResultMap 的設計思想是,對簡單的語句做到零配置,對于復雜一點的語句,只需要描述語句之間的關系就行了。以下是 <resultMap>
的詳細解析和用法說明。
一、<resultMap>
基礎結構
1. 核心屬性
id
:唯一標識符,用于其他操作引用此映射。type
:映射的目標 Java 對象類型(全限定類名或別名)。autoMapping
:是否啟用自動映射(默認false
,建議部分場景開啟)。
2. 基礎示例
場景:數據庫字段為 user_id
,Java 對象屬性為 userId
。
<!--
用戶結果映射(基礎版本)
功能:將數據庫查詢結果映射到com.example.User對象
說明:1. id="BaseUserMap":標識這個結果映射的唯一名稱。2. type="com.example.User":指定目標Java對象的完整類路徑。3. <id property="userId" column="user_id">:定義主鍵屬性userId與數據庫列user_id的映射關系。4. <result property="userName" column="user_name">:定義普通屬性userName與數據庫列user_name的映射關系。5. <result property="age" column="age">:定義普通屬性age與數據庫列age的映射關系。
用法:在需要復雜映射的場景下,可復用此結果映射。-->
<resultMap id="BaseUserMap" type="com.example.User"><id property="userId" column="user_id" /><result property="userName" column="user_name" /><result property="age" column="age" />
</resultMap><!--
查詢用戶基本信息
功能:從users表中查詢user_id、user_name和age列,并使用BaseUserMap結果映射轉換為Java對象
說明:1. id="getUser":標識這個查詢操作的唯一名稱。2. resultMap="BaseUserMap":指定使用BaseUserMap結果映射來處理查詢結果。3. SELECT user_id, user_name, age FROM users:從users表中查詢指定列。
用法:在Mapper接口中定義對應的方法,例如:User getUser();返回一個包含用戶基本信息的User對象。-->
<select id="getUser" resultMap="BaseUserMap">SELECT user_id, user_name, age FROM users
</select>
二、字段映射詳解
1. <id>
與 <result>
的區別
<id>
:標記主鍵字段,影響緩存和性能優化(必須配置)。<result>
:普通字段映射。
2. 顯式映射 vs 自動映射
- 顯式映射:手動配置所有字段(推薦復雜場景)。
- 自動映射:開啟
autoMapping="true"
后,未配置的字段按名稱自動映射。
<!--
自動映射主鍵的用戶結果映射
功能:使用MyBatis的自動映射功能,將數據庫查詢結果映射到User對象
特別說明:1. autoMapping="true":表示開啟MyBatis的自動映射功能。- MyBatis會自動將查詢結果中與User對象屬性名匹配的列映射到對應的屬性上。2. <id property="userId" column="user_id">:手動配置主鍵映射,確保主鍵列與User對象的userId屬性正確對應。- 通常主鍵列需要顯式定義,其他非主鍵列可以依賴自動映射完成。-->
<resultMap id="AutoUserMap" type="User" autoMapping="true"><id property="userId" column="user_id" /> <!-- 只需配置主鍵 -->
</resultMap><!--
查詢用戶信息(使用自動映射)
功能:從users表中查詢所有用戶信息,并通過AutoUserMap結果映射轉換為User對象。
特別說明:- 該查詢語句只需簡單地從表中選擇所有列(SELECT *),因為開啟了自動映射,MyBatis會自動處理列名與User對象屬性的映射。- 如果某些列名與User對象屬性名不一致,可以手動在resultMap中配置對應的映射關系。-->
<select id="getUser" parameterType="String" resultMap="AutoUserMap">SELECT * FROM users
</select>
三、關聯關系映射
1. 一對一關聯 <association>
場景:用戶(User)與身份證(IDCard)一對一關聯。
Java 對象:
public class User {private Integer userId;private String userName;private IDCard idCard; // 一對一對象
}
映射配置:
<!--
用戶與身份證信息的結果映射
功能:將用戶信息和其關聯的身份證信息映射到User對象
說明:1. id="UserWithIDCardMap":標識這個結果映射的唯一名稱。2. type="User":指定目標Java對象類型為User。3. <id property="userId" column="user_id">:定義User對象的userId屬性與數據庫表的user_id列對應,作為主鍵。4. <result property="userName" column="user_name">:定義User對象的userName屬性與數據庫表的user_name列對應。5. <association property="idCard" javaType="IDCard">- property="idCard":User對象中的idCard屬性,表示用戶的身份證信息。- javaType="IDCard":指定關聯對象的Java類型為IDCard。- <id property="cardId" column="card_id">:定義IDCard對象的cardId屬性與數據庫表的card_id列對應,作為主鍵。- <result property="cardNumber" column="card_number">:定義IDCard對象的cardNumber屬性與數據庫表的card_number列對應。- 通過這個關聯映射,可以將用戶的身份證信息嵌套到User對象中。-->
<resultMap id="UserWithIDCardMap" type="User"><id property="userId" column="user_id"/><result property="userName" column="user_name"/><!-- 嵌套對象映射 --><association property="idCard" javaType="IDCard"><id property="cardId" column="card_id"/><result property="cardNumber" column="card_number"/></association>
</resultMap><!--
查詢用戶及其身份證信息
功能:從users和id_card表中查詢用戶及身份證數據,并通過UserWithIDCardMap結果映射轉換為Java對象
說明:1. id="getUserWithIDCard":標識這個查詢操作的唯一名稱。2. resultMap="UserWithIDCardMap":指定使用UserWithIDCardMap結果映射來處理查詢結果。3. SELECT u.user_id, u.user_name, c.card_id, c.card_number FROM users u LEFT JOIN id_card c ON u.user_id = c.user_id:- 查詢users表和id_card表的聯合數據。- LEFT JOIN將users表和id_card表連接,連接條件為用戶ID(u.user_id = c.user_id)。- 查詢結果將包含用戶的基本信息和其關聯的身份證信息。
用法:在Mapper接口中定義對應的方法,例如:User getUserWithIDCard();返回一個包含用戶及其身份證信息的User對象。-->
<select id="getUserWithIDCard" resultMap="UserWithIDCardMap">SELECT u.user_id, u.user_name, c.card_id, c.card_numberFROM users uLEFT JOIN id_card c ON u.user_id = c.user_id
</select>
2. 一對多關聯 <collection>
場景:用戶(User)與訂單(Order)一對多關聯。
Java 對象:
public class User {private Integer userId;private String userName;private List<Order> orders; // 一對多集合
}
映射配置:
<!--
用戶與訂單的結果映射
功能:將用戶信息及其關聯的訂單信息映射到User對象
說明:1. id="UserWithOrdersMap":標識這個結果映射的唯一名稱。2. type="User":指定目標Java對象類型為User。3. <id property="userId" column="user_id">:定義User對象的userId屬性與數據庫表的user_id列對應,作為主鍵。4. <result property="userName" column="user_name">:定義User對象的userName屬性與數據庫表的user_name列對應。5. <collection property="orders" ofType="Order">- property="orders":User對象中的orders屬性,表示用戶的訂單集合。- ofType="Order":指定集合中元素的類型為Order。- <id property="orderId" column="order_id">:定義Order對象的orderId屬性與數據庫表的order_id列對應,作為主鍵。- <result property="orderNo" column="order_no">:定義Order對象的orderNo屬性與數據庫表的order_no列對應。- <result property="amount" column="amount">:定義Order對象的amount屬性與數據庫表的amount列對應。- 通過這個集合映射,可以將用戶的訂單信息作為嵌套集合封裝到User對象中。-->
<resultMap id="UserWithOrdersMap" type="User"><id property="userId" column="user_id"/><result property="userName" column="user_name"/><!-- 集合映射 --><collection property="orders" ofType="Order"><id property="orderId" column="order_id"/><result property="orderNo" column="order_no"/><result property="amount" column="amount"/></collection>
</resultMap><!--
查詢用戶及其訂單信息
功能:從users和orders表中查詢用戶及訂單數據,并通過UserWithOrdersMap結果映射轉換為Java對象
說明:1. id="getUserWithOrders":標識這個查詢操作的唯一名稱。2. resultMap="UserWithOrdersMap":指定使用UserWithOrdersMap結果映射來處理查詢結果。3. SELECT u.user_id, u.user_name, o.order_id, o.order_no, o.amount FROM users u LEFT JOIN orders o ON u.user_id = o.user_id:- 查詢users表和orders表的聯合數據。- LEFT JOIN將users表和orders表連接,連接條件為用戶ID(u.user_id = o.user_id)。- 查詢結果將包含用戶的基本信息和其關聯的訂單信息。
用法:在Mapper接口中定義對應的方法,例如:User getUserWithOrders();返回一個包含用戶及其訂單信息的User對象。-->
<select id="getUserWithOrders" resultMap="UserWithOrdersMap">SELECT u.user_id, u.user_name,o.order_id, o.order_no, o.amountFROM users uLEFT JOIN orders o ON u.user_id = o.user_id
</select>
四、高級用法
1. 繼承映射 (extends
)
復用已有的 resultMap
,避免重復配置。
<!--
基礎用戶結果映射
功能:定義了一個基礎的結果映射,包含用戶的基本字段(user_id 和 user_name)
說明:1. id="BaseUserMap":標識這個結果映射的唯一名稱。2. type="User":指定目標Java對象類型為User。3. <id property="userId" column="user_id">:定義User對象的userId屬性與數據庫表的user_id列對應,作為主鍵。4. <result property="userName" column="user_name">:定義User對象的userName屬性與數據庫表的user_name列對應。5. 這個基礎映射可以被其他映射繼承和擴展,避免重復定義公共字段。-->
<resultMap id="BaseUserMap" type="User"><id property="userId" column="user_id"/><result property="userName" column="user_name"/>
</resultMap><!--
擴展基礎用戶結果映射,添加新字段
功能:在基礎用戶映射的基礎上,添加一個新的字段(email)
說明:1. id="ExtendedUserMap":標識這個結果映射的唯一名稱。2. extends="BaseUserMap":表示繼承BaseUserMap中的所有字段和配置。3. type="User":指定目標Java對象類型為User。4. <result property="email" column="email">:新增字段,定義User對象的email屬性與數據庫表的email列對應。5. 通過繼承基礎映射,可以避免重復定義公共字段,簡化配置。-->
<resultMap id="ExtendedUserMap" extends="BaseUserMap" type="User"><result property="email" column="email"/>
</resultMap>
2. 構造函數映射 <constructor>
通過構造方法注入字段(適合不可變對象)。
Java 對象:
public class User {private final Integer userId;private final String userName;public User(Integer userId, String userName) {this.userId = userId;this.userName = userName;}
}
映射配置:
<!--
用戶結果映射(基于構造函數)
功能:將數據庫查詢結果通過構造函數映射到User對象
說明:1. id="UserConstructorMap":標識這個結果映射的唯一名稱。2. type="User":指定目標Java對象類型為User。3. <constructor>:表示將通過User類的構造函數來初始化對象。4. <arg column="user_id" javaType="int">:- 定義構造函數的第一個參數,對應數據庫列user_id,Java類型為int。5. <arg column="user_name" javaType="String">:- 定義構造函數的第二個參數,對應數據庫列user_name,Java類型為String。6. 這個結果映射要求User類有一個接受兩個參數(int user_id, String user_name)的構造函數。
用法:在需要使用構造函數映射的場景下,通過這個resultMap將查詢結果轉換為User對象。-->
<resultMap id="UserConstructorMap" type="User"><constructor><arg column="user_id" javaType="int"/><arg column="user_name" javaType="String"/></constructor>
</resultMap>
3. 嵌套查詢(分步查詢)
解決關聯查詢的 N+1 性能問題,通過分步加載數據。
<!--
用戶與訂單的延遲加載映射 先查用戶,再通過 user_id 查訂單
功能:定義了一個結果映射,用于將用戶信息和其關聯的訂單信息進行映射。在查詢用戶時,不會立即加載訂單信息,而是通過延遲加載的方式在需要時再加載。
說明:1. id="UserWithLazyOrdersMap":標識這個結果映射的唯一名稱。2. type="User":指定目標Java對象類型為User。3. <id property="userId" column="user_id">:定義User對象的userId屬性與數據庫表的user_id列對應,作為主鍵。4. <result property="userName" column="user_name">:定義User對象的userName屬性與數據庫表的user_name列對應。5. <collection property="orders" ofType="Order" select="com.example.OrderMapper.getOrdersByUserId" column="user_id">- property="orders":User對象中的orders屬性,表示用戶關聯的訂單集合。- ofType="Order":指定集合中元素的類型為Order。- select="com.example.OrderMapper.getOrdersByUserId":指定一個單獨的SQL查詢語句,用于根據用戶ID查詢訂單信息。- column="user_id":將查詢結果中的user_id列作為參數傳遞給子查詢。-->
<resultMap id="UserWithLazyOrdersMap" type="User"><id property="userId" column="user_id"/><result property="userName" column="user_name"/><collection property="orders" ofType="Order"select="com.example.OrderMapper.getOrdersByUserId"column="user_id"/> <!-- 將 user_id 作為參數傳遞給子查詢 -->
</resultMap><!--
查詢用戶信息(延遲加載訂單)
功能:根據用戶ID查詢用戶的基本信息,并通過延遲加載的方式獲取其關聯的訂單信息。
說明:1. id="getUser":標識這個查詢操作的唯一名稱。2. resultMap="UserWithLazyOrdersMap":指定使用UserWithLazyOrdersMap結果映射來處理查詢結果。3. SELECT user_id, user_name FROM users WHERE user_id = #{id}:- 查詢users表中的user_id和user_name列。- WHERE user_id = #{id}:根據傳入的用戶ID進行查詢。
用法:在Mapper接口中定義對應的方法,例如:User getUser(int id);返回一個包含用戶基本信息的User對象,其orders屬性在需要時才會加載。-->
<select id="getUser" resultMap="UserWithLazyOrdersMap">SELECT user_id, user_name FROM users WHERE user_id = #{id}
</select>
OrderMapper.xml:
<!--
根據用戶ID查詢訂單信息
功能:從orders表中查詢指定用戶的所有訂單
參數:userId(用戶ID)
返回:Order對象的列表,包含該用戶的所有訂單信息
說明:1. id="getOrdersByUserId":標識這個查詢操作的唯一名稱。2. resultType="Order":指定查詢結果的類型為Order對象。3. SELECT * FROM orders WHERE user_id = #{userId}:- 查詢orders表中所有列的數據。- WHERE user_id = #{userId}:條件是訂單的user_id等于傳入的userId參數。
用法:在Mapper接口中定義對應的方法,例如:List<Order> getOrdersByUserId(int userId);調用時傳入用戶ID,返回該用戶的所有訂單信息。-->
<select id="getOrdersByUserId" resultType="Order">SELECT * FROM orders WHERE user_id = #{userId}
</select>
五、常見問題與最佳實踐
- 主鍵必須配置:
<id>
影響緩存機制,未配置可能導致性能下降。 - 避免過度嵌套:復雜關聯建議使用分步查詢(嵌套查詢)減少單次 SQL 復雜度。
- 自動映射的取舍:簡單場景可開啟
autoMapping
,復雜字段仍需顯式配置。 - 性能優化:一對多關聯使用懶加載(
fetchType="lazy"
),按需加載數據。
六、總結
拓展閱讀:MyBatis映射文件常用元素詳解與示例
官方文檔:MyBatis | XML 映射文件