MyBatis Collection標籤使用指南

一、為什麼需要使用MyBatis Collection標籤

MyBatis Collection標籤是MyBatis提供的一種映射關係，用於處理集合類型的對象。在實際開發過程中，我們經常會遇到將一個List、Set或Map對象映射到資料庫中的情況，這時就需要使用MyBatis Collection標籤。

MyBatis Collection標籤相比於其他映射標籤，具有更強的靈活性和可擴展性。它可以用於處理基本類型、自定義對象、關聯對象和嵌套集合對象等複雜場景。

下面是一個簡單的使用示例：

<select id="getUserOrders" resultMap="userResult">
  SELECT * FROM user u, orders o WHERE u.id = #{id} and u.id = o.user_id
</select>

<resultMap id="userResult" type="User">
  <id property="id" column="id"/>
  <result property="username" column="username"/>
  <collection property="orders" ofType="Order" resultMap="orderResult"/>
</resultMap>

<resultMap id="orderResult" type="Order">
  <id property="id" column="id"/>
  <result property="orderNo" column="order_no"/>
  <result property="amount" column="amount"/>
</resultMap>

在這個示例中，我們通過Collection標籤將用戶對象的訂單屬性映射到資料庫中的orders表。在resultMap中聲明collection標籤可以表明該結果集為List類型。

二、MyBatis Collection標籤的基本用法

集合類型的對象可以分為兩種：一種是基本類型的集合對象，例如List<Integer>、Set<String>等；另一種是複雜類型的集合對象，例如List<User>、Set<Order>等。

2.1 針對基本類型的集合對象

針對基本類型的集合對象，可以使用MyBatis提供的forEach標籤：

<select id="getUserIds" resultType="java.lang.Integer">
  SELECT id FROM user
</select>

<select id="getUserByIdList" parameterType="java.util.List">
  SELECT * FROM user WHERE id in
  <foreach collection="list" item="id" open="(" separator="," close=")">
    #{id}
  </foreach>
</select>

//調用getUserByIdList方法
List<Integer> ids = sqlSession.selectList("getUserIds");
List<User> users = sqlSession.selectList("getUserByIdList", ids);

示例中getUserIds方法返回了所有用戶的id列表。在getUserByIdList方法中，forEach標籤用於將id列表作為參數傳遞給SQL語句。注意open、separator、close屬性的作用，open屬性表示生成的SQL語句的開頭，separator屬性表示集合元素之間的分隔符，close屬性表示生成的SQL語句的結尾。

2.2 針對複雜類型的集合對象

針對複雜類型的集合對象，可以在resultMap中使用collection標籤，聲明集合類型的屬性，使用ofType屬性指定集合元素的類型，並指定關聯的resultMap。

<resultMap id="userResult" type="User">
  <id property="id" column="id"/>
  <result property="username" column="username"/>
  <collection property="orders" ofType="Order" resultMap="orderResult"/>
</resultMap>

<resultMap id="orderResult" type="Order">
  <id property="id" column="id"/>
  <result property="orderNo" column="order_no"/>
  <result property="amount" column="amount"/>
</resultMap>

<select id="getUserOrders" resultMap="userResult">
  SELECT * FROM user u, orders o WHERE u.id = #{id} and u.id = o.user_id
</select>

示例中，User對象包含一個屬性orders，它是一個List類型的集合，其中元素類型為Order對象。在resultMap中，collection標籤定義了orders屬性，並使用ofType指定了元素類型。同時，resultMap中還指定了該屬性關聯的resultMap為orderResult。

三、MyBatis Collection標籤的高級用法

MyBatis Collection標籤還提供了一些高級用法，用於處理更加複雜的場景。

3.1 使用association標籤映射關聯對象

在前面的示例中，我們使用collection標籤將訂單對象映射到用戶對象中。如果我們還需要將訂單對象中的用戶對象也映射到結果集中呢？可以使用MyBatis提供的association標籤。

<resultMap id="userResult" type="User">
  <id property="id" column="id"/>
  <result property="username" column="username"/>
  <collection property="orders" ofType="Order">
    <id property="id" column="order_id"/>
    <result property="orderNo" column="order_no"/>
    <result property="amount" column="amount"/>
    <association property="user" javaType="User">
      <id property="id" column="id"/>
      <result property="username" column="username"/>
    </association>
  </collection>
</resultMap>

<select id="getUserOrders" resultMap="userResult">
  SELECT u.id, u.username, o.id as order_id, o.order_no, o.amount
  FROM user u, orders o
  WHERE u.id = #{id} AND u.id = o.user_id
</select>

在示例中，我們使用association標籤將Order對象中的User對象映射到結果集中。可以看到，association標籤跟collection標籤有些類似，都是通過ofType屬性指定關聯對象的類型，並使用id和result標籤映射關聯對象的屬性。

3.2 使用嵌套的collection標籤映射嵌套集合對象

有些實際的業務場景中，我們需要將一個List<User>對象映射到資料庫中的多張表中。這時，就需要使用嵌套的collection標籤。

<resultMap id="userResult" type="User">
  <id property="id" column="id"/>
  <result property="username" column="username"/>
  <collection property="orders" ofType="Order">
    <id property="id" column="order_id"/>
    <result property="orderNo" column="order_no"/>
    <result property="amount" column="amount"/>
    <collection property="orderItems" ofType="OrderItem">
      <id property="id" column="order_item_id"/>
      <result property="name" column="name"/>
      <result property="price" column="price"/>
      <result property="count" column="count"/>
    </collection>
  </collection>
</resultMap>

<select id="getUserOrders" resultMap="userResult">
  SELECT u.id, u.username, o.id as order_id, o.order_no, o.amount, oi.id as order_item_id, oi.name, oi.price, oi.count
  FROM user u, orders o, order_item oi
  WHERE u.id = #{id} AND u.id = o.user_id AND o.id = oi.order_id
</select>

在示例中，我們使用嵌套的collection標籤將Order對象中的List<OrderItem>對象映射到結果集中。可以看到，嵌套的collection標籤的用法與普通的collection標籤類似，只是需要在collection標籤中再套一個collection標籤，以此類推。

四、總結

MyBatis Collection標籤是MyBatis中用於處理集合類型的映射標籤。它可以用於處理基本類型、自定義對象、關聯對象和嵌套集合對象等複雜場景，具有強大的靈活性和擴展性。在使用過程中，我們需要結合具體的業務場景，選擇適合的標籤和屬性，以便實現高效的數據映射。

原創文章，作者：YEQV，如若轉載，請註明出處：https://www.506064.com/zh-tw/n/143899.html