MyBatis 中如何使用结果映射

MyBatis 中如何使用结果映射

MyBatis 是一个开源的 Java 持久化框架，它可以将数据库中的数据映射到 Java 对象中，并且使得 Java 对象可以非常方便地存储到数据库中。在 MyBatis 中，结果映射是一个非常重要的概念，它可以将 SQL 查询结果映射到 Java 对象中，并且可以配置关联映射、继承映射和集合映射等高级映射关系。本文将介绍 MyBatis 中结果映射的使用方法。

结果映射的基本使用

在 MyBatis 中，结果映射可以通过以下两种方式进行配置：

使用 resultMap 标签

在 SQL 映射文件中，我们可以使用 resultMap 标签来定义一个结果映射。例如，假设我们有一个 User 类，其中包含一个 id 属性和一个 name 属性：

public class User {
    private int id;
    private String name;

    // 省略 getter 和 setter 方法
}

我们可以在 SQL 映射文件中使用 resultMap 标签来定义一个 userResultMap 结果映射：

<resultMap id="userResultMap" type="User">
    <id property="id" column="user_id" />
    <result property="name" column="username" />
</resultMap>

在这个 resultMap 标签中，我们使用 id 标签来定义 id 属性的映射关系，使用 result 标签来定义 name 属性的映射关系。这些标签中的 property 属性指定了 Java 对象的属性名称，而 column 属性指定了 SQL 查询结果的列名。

然后，我们可以在 SQL 映射文件中使用这个 userResultMap 结果映射：

<select id="getUserById" resultMap="userResultMap">
    SELECT user_id, username FROM users WHERE user_id = #{id}
</select>

在这个 SQL 映射文件中，我们使用 resultMap 属性来指定结果映射的名称。MyBatis 会自动将查询结果映射到 User 类对象中。

使用 @Results 和 @Result 注解

除了使用 resultMap 标签之外，我们还可以使用 @Results 和 @Result 注解来定义结果映射。例如，假设我们有一个 User 类，其中包含一个 id 属性和一个 name 属性：

public class User {
    private int id;
    private String name;

    // 省略 getter 和 setter 方法
}

我们可以在 UserMapper 接口中使用 @Results 和 @Result 注解来定义一个 userResultMap 结果映射：

public interface UserMapper {
    @Select("SELECT user_id, username FROM users WHERE user_id = #{id}")
    @Results(id = "userResultMap", value = {
        @Result(property = "id", column = "user_id"),
        @Result(property = "name", column = "username")
    })
    User getUserById(int id);
}

在这个示例代码中，我们使用 @Results 注解来定义一个 userResultMap 结果映射。这个注解包含一个 id 属性和一个 value 属性。id 属性指定了结果映射的名称，value 属性指定了结果映射的映射关系。

然后，我们在 getUserById 方法上使用 @Result 注解来指定 id 和 name 属性的映射关系。这个注解包含一个 property 属性和一个 column 属性。property 属性指定了 Java 对象的属性名称，column 属性指定了 SQL 查询结果的列名。

高级结果映射

在 MyBatis 中，结果映射不仅可以映射基本类型和对象类型，还可以配置关联映射、继承映射和集合映射等高级映射关系。

关联映射

在 MyBatis 中，我们可以使用 association 标签来配置关联映射。例如，假设我们有一个 Order 类，其中包含一个 id 属性和一个 user属性，而 User 类已经在上面的示例中定义过了：

public class Order {
    private int id;
    private User user;

    // 省略 getter 和 setter 方法
}

我们可以在 SQL 映射文件中使用 association 标签来定义一个 orderResultMap 结果映射：

<resultMap id="orderResultMap" type="Order">
    <id property="id" column="order_id" />
    <association property="user" resultMap="userResultMap" />
</resultMap>

在这个 resultMap 标签中，我们使用 association 标签来定义 user 属性的映射关系。这个 association 标签中的 property 属性指定了 Java 对象的属性名称，而 resultMap 属性指定了关联的结果映射。

然后，我们可以在 SQL 映射文件中使用这个 orderResultMap 结果映射：

<select id="getOrderById" resultMap="orderResultMap">
    SELECT order_id, user_id FROM orders WHERE order_id = #{id}
</select>

在这个 SQL 映射文件中，我们使用 resultMap 属性来指定结果映射的名称。MyBatis 会自动将查询结果映射到 Order 类对象中，并且自动将 user_id 列的值映射到 User 类对象中。

继承映射

在 MyBatis 中，我们可以使用 标签和 标签来配置继承映射。例如，假设我们有一个 Animal 类，其中包含一个 id 属性和一个 name 属性，而 Dog 类和 Cat 类都继承自 Animal 类：

public class Animal {
    private int id;
    private String name;

    // 省略 getter 和 setter 方法
}

public class Dog extends Animal {
    private String breed;

    // 省略 getter 和 setter 方法
}

public class Cat extends Animal {
    private int age;

    // 省略 getter 和 setter 方法
}

我们可以在 SQL 映射文件中使用 标签和 标签来定义一个 animalResultMap 结果映射：

<resultMap id="animalResultMap" type="Animal">
    <id property="id" column="animal_id" />
    <discriminator javaType="int" column="animal_type">
        <subclass javaType="Dog" discriminatorValue="1">
            <result property="breed" column="dog_breed" />
        </subclass>
        <subclass javaType="Cat" discriminatorValue="2">
            <result property="age" column="cat_age" />
        </subclass>
    </discriminator>
    <result property="name" column="animal_name" />
</resultMap>

在这个 resultMap 标签中，我们使用 标签来定义继承映射。这个 标签中的 javaType 属性指定了父类的 Java 类型，column 属性指定了用于区分不同子类的列名。

然后，我们使用 标签来定义每个子类的映射关系。这个 标签中的 javaType 属性指定了子类的 Java 类型，discriminatorValue 属性指定了用于区分不同子类的值。在每个 标签中，我们使用 标签来定义子类特有的属性映射关系。

最后，我们使用 标签来定义父类的属性映射关系。

集合映射

在 MyBatis 中，我们可以使用 collection 标签来配置集合映射。例如，假设我们有一个 User 类，其中包含一个 id 属性和一个 List 属性：

public class User {
    private int id;
    private List<Order> orders;

    // 省略 getter 和 setter 方法
}

public class Order {
    private int id;
    private int userId;

    // 省略 getter 和 setter 方法
}

我们可以在 SQL 映射文件中使用 collection 标签来定义一个 userResultMap 结果映射：

<resultMap id="userResultMap" type="User">
    <id property="id" column="user_id" />
    <collection property="orders" ofType="Order">
        <id property="id" column="order_id" />
        <result property="userId" column="user_id" />
    </collection>
</resultMap>

在这个 resultMap 标签中，我们使用 collection 标签来定义 orders 属性的映射关系。这个 collection 标签中的 property 属性指定了 Java 对象的属性名称，ofType 属性指定了集合中元素的 Java 类型。

然后，我们使用 标签和 标签来定义集合元素的属性映射关系。在这个示例代码中，我们使用 标签来定义 id 属性的映射关系，使用 标签来定义 userId 属性的映射关系。

总结

本文介绍了 MyBatis 中结果映射的基本使用和高级用法。在 MyBatis 中，我们可以使用 resultMap 标签和 @Results 注解来定义结果映射，并且可以配置关联映射、继承映射和集合映射等高级映射关系。结果映射是 MyBatis 中非常重要的一个概念，它可以帮助我们将 SQL 查询结果映射到 Java 对象中，使得 Java 对象可以非常方便地存储到数据库中。如果你正在学习 MyBatis，那么结果映射是一个非常重要的知识点，务必要掌握好。