Mybatis一對(duì)多查詢列表屬性處理示例詳解

更新時(shí)間：2023年05月13日 11:15:11 作者：金丹期CV攻城獅

使用MyBatis進(jìn)行多表聯(lián)查的關(guān)鍵是構(gòu)建數(shù)據(jù)庫(kù)中表的字段和java中對(duì)象的屬性的映射關(guān)系,下面這篇文章主要給大家介紹了關(guān)于Mybatis一對(duì)多查詢列表屬性處理的相關(guān)資料,需要的朋友可以參考下

一、說明

1.<collection>標(biāo)簽屬性說明

property：指定主對(duì)象中的集合屬性名稱。
ofType：指定集合元素的類型。默認(rèn)值為java.lang.Object?？梢酝ㄟ^指定 ofType 屬性來指定集合元素的類型。
column：指定集合元素所用的列名，用于匹配結(jié)果集中的列。（內(nèi)層select關(guān)聯(lián)字段，若不指定則默認(rèn)使用外鍵對(duì)應(yīng)的主鍵作為column屬性的值）
columnPrefix: 指定集合元素所用的列名前綴，用于匹配結(jié)果集中的列。（用于平鋪查詢方式下內(nèi)層列映射自動(dòng)匹配）
select：指定獲取集合元素的 SQL 查詢語句。
resultSetType：指定 SQL 查詢結(jié)果集的類型，默認(rèn)值為FORWARD_ONLY，還可以設(shè)置為SCROLL_SENSITIVE和SCROLL_INSENSITIVE，具體的用法可以參考JDBC文檔。
fetchType：指定集合的加載方式，默認(rèn)值為“lazy”，可選值為“eager”，當(dāng) fetchType 屬性設(shè)置為“eager”時(shí)，MyBatis會(huì)在執(zhí)行 SQL 語句返回結(jié)果集后，立即加載集合元素。
javaType: 指定集合的 Java 類型，通常不需要指定，MyBatis會(huì)根據(jù)集合屬性的類型自動(dòng)推斷。
jdbcType: 指定集合屬性在數(shù)據(jù)庫(kù)中的類型，可以參考 JDBC 中的類型定義。如果不指定，MyBatis會(huì)自動(dòng)推斷。
notNullColumn：指定一個(gè)或多個(gè)屬性列的名稱，這些列不能為空。當(dāng)這些屬性列為空時(shí)，MyBatis會(huì)拋出異常。notNullColumn 屬性可以使用逗號(hào)(,)分隔，以指定多個(gè)屬性列。
columnOverride：指定一個(gè)或多個(gè)元素屬性與結(jié)果集中列的映射關(guān)系。
typeHandler：指定一個(gè)元素屬性的類型處理器。
ofTypeHandler：指定集合元素的類型處理器。
resultMap：指定集合元素的映射器，通常是通過嵌套 result 標(biāo)簽來定義，并使用該 resultMap 的 id 來指定。
orderBy：指定升序或降序。多個(gè)排序條件時(shí)，用空格分開。例如orderBy="id desc,create_time asc"表示先按id降序，再按createTime升序排列。（不推薦使用，建議在SQL中手動(dòng)指定排序方式）
notNullColumn：指定一個(gè)或多個(gè)屬性列的名稱，這些列不能為空。當(dāng)這些屬性列為空時(shí)，MyBatis會(huì)拋出異常。notNullColumn 屬性可以使用逗號(hào)(,)分隔，以指定多個(gè)屬性列。
statementType：指定操作執(zhí)行的SQL類型，有STATEMENT，PREPARED和CALLABLE三種，分別代表簡(jiǎn)單語句、預(yù)處理語句和調(diào)用存儲(chǔ)過程。默認(rèn)值為PREPARED。

columnPrefix用法

如果使用了 columnPrefix 屬性，可以省略 result 標(biāo)簽中的 column 屬性，并且 MyBatis 會(huì)自動(dòng)完成屬性與列名之間的映射。

<resultMap id="userResultMap" type="User">
  <id column="user_id" property="id"/>
  <result column="user_name" property="name"/>
  <collection property="roles" ofType="Role">
    <id column="role_id" property="id"/>
    <result column="role_name" property="name"/>
  </collection>
</resultMap>

改用columnPrefix前綴寫法簡(jiǎn)化代碼,使用使用時(shí)，多使用表別名作為列前綴，例如columnPrefix="r."

<resultMap id="userResultMap" type="User">
  <id column="user_id" property="id"/>
  <result column="user_name" property="name"/>
  <collection property="roles" ofType="Role" columnPrefix="role_">
    <id column="role_id" property="id"/>
    <result property="name"/>
  </collection>
</resultMap>

mybatis 官方文檔

2. 示例代碼

實(shí)體類

public class User {
    private Integer id;
    private String name;
    private Integer age;
    private List<Order> orders;

    // 省略 getter 和 setter 方法
}

public class Order {
    private Integer id;
    private String orderNo;
    private Date createTime;

    // 省略 getter 和 setter 方法
}

二、平鋪查詢

可結(jié)合columnPrefix、resultMap使用

Mybatis XML

<select id="getUserOrdersById" resultMap="userResultMap">
  SELECT u.id, u.name, u.age, o.id AS order_id, o.order_no, o.create_time
  FROM user u
  INNER JOIN `order` o ON u.id = o.user_id
  WHERE u.id = #{id}
</select>
<resultMap id="userResultMap" type="com.example.User">
  <id property="id" column="id" />
  <result property="name" column="name" />
  <result property="age" column="age" />
  <collection property="orders" ofType="com.example.Order" resultMap="orderResultMap" />
</resultMap>
<resultMap id="orderResultMap" type="com.example.Order">
  <id property="id" column="order_id" />
  <result property="orderNo" column="order_no" />
  <result property="createTime" column="create_time" />
</resultMap>

三、嵌套查詢（Nested Select for Collection）

嵌套查詢支持惰性加載，可通過設(shè)置fetchType調(diào)整集合加載方式，默認(rèn)值為“lazy”，可選值為“eager”。

3.1 外鍵查詢

<select id="getUserOrdersById" resultMap="userResultMap">
  SELECT u.id, u.name, u.age
  FROM user u
  WHERE u.id = #{id}
</select>
<select id="getOrderByUserId" resultMap="orderResultMap">
  SELECT o.id, o.order_no, o.create_time
  FROM `order` o
  WHERE o.user_id = #{userId}
</select>
<resultMap id="orderResultMap" type="com.example.Order">
  <id property="id" column="order_id" />
  <result property="orderNo" column="order_no" />
  <result property="createTime" column="create_time" />
</resultMap>
<resultMap id="userResultMap" type="com.example.User">
  <id property="id" column="id" />
  <result property="name" column="name" />
  <result property="age" column="age" />
  <collection property="orders" ofType="com.example.Order" resultMap="orderResultMap" select="getOrderByUserId" column="id">
      <!-- 這里使用 column="id"，指定了內(nèi)層 select 語句的參數(shù)值為外層查詢語句結(jié)果集中的 id 屬性值(即用戶ID) -->
  </collection>
</resultMap>

3.2 select傳入多個(gè)參數(shù)

上面講到指定select嵌套sql時(shí)，需要指定column="id"，如果內(nèi)層SQL需要傳入多個(gè)參數(shù)時(shí)，可采用如下方式

public class OrderQuery {
    private Long userId; // 用戶id
    private Integer status; // 訂單狀態(tài)
    // getter和setter方法
}

<select id="getOrdersByUserId" resultType="Order">
    SELECT *
    FROM `order`
    WHERE user_id = #{userId}
    AND status = #{status}
</select>
<resultMap id="userMap" type="User">
    <id property="id" column="id"/>
    <result property="name" column="name"/>
    <result property="age" column="age"/>
    <!-- 注意這里的association標(biāo)簽的select屬性使用了OrderQuery對(duì)象的屬性 -->
    <result property="orders" column="id" 
            select="com.example.mapper.OrderMapper.getOrdersByUserId">
        <association property="param" javaType="OrderQuery">
            <result property="userId" column="id"/>
            <result property="status" value="1"/> <!-- 這里傳遞的是固定值，也可以替換為動(dòng)態(tài)的表達(dá)式 -->
        </association>
    </result>
</resultMap>

association一對(duì)一屬性處理

上面介紹一對(duì)多查詢列表屬性處理，其實(shí)association更常用于一對(duì)一屬性的處理上

package com.example;

public class Order {
  private int orderId;
  private String orderName;
  private Customer customer;

  // getters and setters for orderId, orderName, customer
}

package com.example;

public class Customer {
  private int customerId;
  private String customerName;

  // getters and setters for customerId, customerName
}

<resultMap id="orderMap" type="com.example.Order">
  <id property="orderId" column="order_id"/>
  <result property="orderName" column="order_name"/>
  <association property="customer" javaType="com.example.Customer">
    <id property="customerId" column="customer_id"/>
    <result property="customerName" column="customer_name"/>
  </association>
</resultMap>

在這個(gè)例子中，Order類有一個(gè)Customer屬性，我們使用Association關(guān)聯(lián)對(duì)象將query出的Customer映射到Order對(duì)象的Customer屬性上。
需要注意的是，Association也可以嵌套使用，我們可以通過多層Association實(shí)現(xiàn)多個(gè)對(duì)象之間的關(guān)聯(lián)。此外，需要注意的是，在映射關(guān)聯(lián)對(duì)象Association時(shí)要確保SQL語句中的JOIN操作正確無誤。