MyBatis 是一款优秀的持久层框架,它通过映射文件(Mapper XML 文件)或注解方式将 SQL 语句与 Java 对象关联起来。本文将详细介绍 MyBatis 的结果映射(Result Mapping)机制,帮助你理解和应用这一强大功能,提高开发效率和代码的可维护性。
1. 什么是结果映射
在 MyBatis 中,结果映射是指将 SQL 查询结果集中的列值映射到 Java 对象的属性中。通过配置结果映射,可以轻松地将复杂的查询结果转换为便于操作的 Java 对象。
2. 基本结果映射
MyBatis 提供了两种主要的结果映射方式:通过 XML 配置文件和注解。以下是这两种方式的详细介绍。
2.1 通过 XML 配置文件进行结果映射
假设有一个 User 类:
1
2
3
4
5
6
7
|
public class User {
private int id;
private String name;
private String email;
// getters and setters
}
|
对应的数据库表结构如下:
1
2
3
4
5
|
CREATE TABLE users (
id INT PRIMARY KEY,
name VARCHAR(50),
email VARCHAR(50)
);
|
首先,在 MyBatis 的映射文件(如 UserMapper.xml)中定义 SQL 查询和结果映射:
1
2
3
4
5
|
<mapper namespace="com.example.mapper.UserMapper">
<select id="getUserById" resultType="com.example.model.User">
SELECT id, name, email FROM users WHERE id = #{id}
</select>
</mapper>
|
在这里,resultType 属性指定了查询结果将映射到的 Java 类。MyBatis 会自动将查询结果的列名与 User 类的属性名进行映射。
2.2 通过注解进行结果映射
MyBatis 也支持使用注解来配置 SQL 查询和结果映射:
1
2
3
4
5
6
|
import org.apache.ibatis.annotations.Select;
public interface UserMapper {
@Select("SELECT id, name, email FROM users WHERE id = #{id}")
User getUserById(int id);
}
|
3. 复杂结果映射
在实际应用中,查询结果往往不仅仅是简单的平面数据,还可能包含嵌套对象或集合。这时,需要使用更复杂的结果映射配置。
3.1 嵌套对象映射
假设有一个 Order 类,其中包含一个 User 对象:
1
2
3
4
5
6
7
|
public class Order {
private int id;
private User user;
private Date orderDate;
// getters and setters
}
|
对应的数据库表结构如下:
1
2
3
4
5
6
|
CREATE TABLE orders (
id INT PRIMARY KEY,
user_id INT,
order_date DATE,
FOREIGN KEY (user_id) REFERENCES users(id)
);
|
在 MyBatis 的映射文件中配置嵌套对象映射:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
<mapper namespace="com.example.mapper.OrderMapper">
<resultMap id="OrderResultMap" type="com.example.model.Order">
<id property="id" column="id" />
<result property="orderDate" column="order_date" />
<association property="user" javaType="com.example.model.User">
<id property="id" column="user_id" />
<result property="name" column="user_name" />
<result property="email" column="user_email" />
</association>
</resultMap>
<select id="getOrderById" resultMap="OrderResultMap">
SELECT o.id, o.order_date, u.id AS user_id, u.name AS user_name, u.email AS user_email
FROM orders o
JOIN users u ON o.user_id = u.id
WHERE o.id = #{id}
</select>
</mapper>
|
在这里,association 元素用于定义与嵌套对象(User 对象)的映射关系。
3.2 集合映射
假设有一个 User 类,其中包含一个订单列表:
1
2
3
4
5
6
7
8
|
public class User {
private int id;
private String name;
private String email;
private List<Order> orders;
// getters and setters
}
|
在 MyBatis 的映射文件中配置集合映射:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
<mapper namespace="com.example.mapper.UserMapper">
<resultMap id="UserResultMap" type="com.example.model.User">
<id property="id" column="id" />
<result property="name" column="name" />
<result property="email" column="email" />
<collection property="orders" ofType="com.example.model.Order">
<id property="id" column="order_id" />
<result property="orderDate" column="order_date" />
</collection>
</resultMap>
<select id="getUserWithOrdersById" resultMap="UserResultMap">
SELECT u.id, u.name, u.email, o.id AS order_id, o.order_date
FROM users u
LEFT JOIN orders o ON u.id = o.user_id
WHERE u.id = #{id}
</select>
</mapper>
|
在这里,collection 元素用于定义与集合(orders 列表)的映射关系。
4. 动态结果映射
MyBatis 支持动态结果映射,通过 <resultMap> 元素可以动态定义结果映射的结构:
1
2
3
4
5
6
7
8
9
|
<resultMap id="DynamicResultMap" type="java.util.HashMap">
<id property="id" column="id" />
<result property="name" column="name" />
<result property="email" column="email" />
</resultMap>
<select id="getDynamicResult" resultMap="DynamicResultMap">
SELECT id, name, email FROM users WHERE id = #{id}
</select>
|
在这里,查询结果会映射到 HashMap 对象中,键为列名,值为相应的列值。
5. 延迟加载(Lazy Loading)
MyBatis 支持延迟加载,只有在真正使用嵌套对象或集合时才进行查询:
在 MyBatis 配置文件(mybatis-config.xml)中启用延迟加载:
1
2
3
4
5
6
|
<configuration>
<settings>
<setting name="lazyLoadingEnabled" value="true"/>
<setting name="aggressiveLazyLoading" value="false"/>
</settings>
</configuration>
|
配置完成后,只有在访问嵌套对象或集合时才会触发相应的查询,提高性能。
6. 总结
MyBatis 的结果映射机制极大地方便了复杂查询结果与 Java 对象之间的转换。通过合理配置结果映射,可以轻松处理嵌套对象、集合等复杂结构,提高代码的可读性和可维护性。本文介绍了 MyBatis 中基本和复杂结果映射的配置方法,希望能帮助你更好地掌握 MyBatis 的使用。
|