Mybatis一对多查询列表属性处理示例详解

来源：jb51　　时间：2023/5/15 9:00:28　　对本文有异议

一、说明

1.<collection>标签属性说明

property：指定主对象中的集合属性名称。
ofType：指定集合元素的类型。默认值为java.lang.Object。可以通过指定 ofType 属性来指定集合元素的类型。
column：指定集合元素所用的列名，用于匹配结果集中的列。（内层select关联字段，若不指定则默认使用外键对应的主键作为column属性的值）
columnPrefix: 指定集合元素所用的列名前缀，用于匹配结果集中的列。（用于平铺查询方式下内层列映射自动匹配）
select：指定获取集合元素的 SQL 查询语句。
resultSetType：指定 SQL 查询结果集的类型，默认值为FORWARD_ONLY，还可以设置为SCROLL_SENSITIVE和SCROLL_INSENSITIVE，具体的用法可以参考JDBC文档。
fetchType：指定集合的加载方式，默认值为“lazy”，可选值为“eager”，当 fetchType 属性设置为“eager”时，MyBatis会在执行 SQL 语句返回结果集后，立即加载集合元素。
javaType: 指定集合的 Java 类型，通常不需要指定，MyBatis会根据集合属性的类型自动推断。
jdbcType: 指定集合属性在数据库中的类型，可以参考 JDBC 中的类型定义。如果不指定，MyBatis会自动推断。
notNullColumn：指定一个或多个属性列的名称，这些列不能为空。当这些属性列为空时，MyBatis会抛出异常。notNullColumn 属性可以使用逗号(,)分隔，以指定多个属性列。
columnOverride：指定一个或多个元素属性与结果集中列的映射关系。
typeHandler：指定一个元素属性的类型处理器。
ofTypeHandler：指定集合元素的类型处理器。
resultMap：指定集合元素的映射器，通常是通过嵌套 result 标签来定义，并使用该 resultMap 的 id 来指定。
orderBy：指定升序或降序。多个排序条件时，用空格分开。例如orderBy="id desc,create_time asc"表示先按id降序，再按createTime升序排列。（不推荐使用，建议在SQL中手动指定排序方式）
notNullColumn：指定一个或多个属性列的名称，这些列不能为空。当这些属性列为空时，MyBatis会抛出异常。notNullColumn 属性可以使用逗号(,)分隔，以指定多个属性列。
statementType：指定操作执行的SQL类型，有STATEMENT，PREPARED和CALLABLE三种，分别代表简单语句、预处理语句和调用存储过程。默认值为PREPARED。

columnPrefix用法

如果使用了 columnPrefix 属性，可以省略 result 标签中的 column 属性，并且 MyBatis 会自动完成属性与列名之间的映射。

<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前缀写法简化代码,使用使用时，多使用表别名作为列前缀，例如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. 示例代码

实体类

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 方法
}

二、平铺查询

可结合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）

嵌套查询支持惰性加载，可通过设置fetchType调整集合加载方式，默认值为“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"，指定了内层 select 语句的参数值为外层查询语句结果集中的 id 属性值(即用户ID) -->
  </collection>
</resultMap>

3.2 select传入多个参数

上面讲到指定select嵌套sql时，需要指定column="id"，如果内层SQL需要传入多个参数时，可采用如下方式

public class OrderQuery {
    private Long userId; // 用户id
    private Integer status; // 订单状态
    // 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标签的select属性使用了OrderQuery对象的属性 -->
    <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"/> <!-- 这里传递的是固定值，也可以替换为动态的表达式 -->
        </association>
    </result>
</resultMap>

association一对一属性处理

上面介绍一对多查询列表属性处理，其实association更常用于一对一属性的处理上

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>

在这个例子中，Order类有一个Customer属性，我们使用Association关联对象将query出的Customer映射到Order对象的Customer属性上。
需要注意的是，Association也可以嵌套使用，我们可以通过多层Association实现多个对象之间的关联。此外，需要注意的是，在映射关联对象Association时要确保SQL语句中的JOIN操作正确无误。