官方文档:http://www.mybatis.org/mybatis-3/zh/sqlmap-xml.html#Result_Maps
一、<association>标签
关联元素处理“有一个”类型的关系,如一对一、多对一的情况。例如一个博客有一个作者,关联映射工作于这种结果之上。示例:
<association property="author" column="blog_author_id" javaType="Author">
<id property="id" column="author_id"/>
<result property="username" column="author_username"/>
</association>
关联中需要告诉 MyBatis 如何加载关联。两种不同的方式可以实现:
- 嵌套查询:通过执行另外一个 SQL 映射语句来返回预期的复杂类型(可以执行本命名空间或其他命名空间的SQL映射语句)
- 嵌套结果:使用嵌套结果映射来处理重复的联合结果的子集
<association>标签属性:
属性 | 描述 |
---|---|
column | 来自数据库的列名,或重命名的列标签。这和通常传递给 resultSet.getString(columnName)方法的字符串是相同的。 column 注 意 : 要 处 理 复 合 主 键 , 你 可 以 指 定 多 个 列 名 通 过 column= ” {prop1=col1,prop2=col2} ” 这种语法来传递给嵌套查询语 句。这会引起 prop1 和 prop2 以参数对象形式来设置给目标嵌套查询语句。 |
select | 另外一个映射语句的 ID,可以加载这个属性映射需要的复杂类型。获取的 在列属性中指定的列的值将被传递给目标 select 语句作为参数。表格后面 有一个详细的示例。 select 注 意 : 要 处 理 复 合 主 键 , 你 可 以 指 定 多 个 列 名 通 过 column= ” {prop1=col1,prop2=col2} ” 这种语法来传递给嵌套查询语 句。这会引起 prop1 和 prop2 以参数对象形式来设置给目标嵌套查询语句。 |
fetchType | 可选的。有效值为 lazy和eager。 如果使用了,它将取代全局配置参数lazyLoadingEnabled |
resultMap | 这是结果映射的 ID,可以映射关联的嵌套结果到一个合适的对象图中。这 是一种替代方法来调用另外一个查询语句。这允许你联合多个表来合成到 resultMap 一个单独的结果集。这样的结果集可能包含重复,数据的重复组需要被分 解,合理映射到一个嵌套的对象图。为了使它变得容易,MyBatis 让你“链 接”结果映射,来处理嵌套结果。一个例子会很容易来仿照,这个表格后 面也有一个示例。 |
columnPrefix | 当连接多表时,你将不得不使用列别名来避免ResultSet中的重复列名。指定columnPrefix允许你映射列名到一个外部的结果集中。 请看后面的例子。 |
notNullColumn | 默认情况下,子对象仅在至少一个列映射到其属性非空时才创建。 通过对这个属性指定非空的列将改变默认行为,这样做之后Mybatis将仅在这些列非空时才创建一个子对象。 可以指定多个列名,使用逗号分隔。默认值:未设置(unset)。 |
autoMapping | 如果使用了,当映射结果到当前属性时,Mybatis将启用或者禁用自动映射。 该属性覆盖全局的自动映射行为。 注意它对外部结果集无影响,所以在select or resultMap属性中这个是毫无意义的。 默认值:未设置(unset)。 |
以用户和身份证为例,一名用户只有一张身份证,一张身份证只属于一名用户;用户表t_user、身份证表t_card。PS:以懒加载方式查询关联的实体并测试,MyBatis版本3.4.6。
一. SQL
用户表t_user
create table t_user
(
id bigint(20) not null auto_increment comment 'id',
user_name varchar(100) comment '姓名',
card_id bigint(20) comment '身份证id',
primary key (id)
);
alter table t_user comment '用户表';
alter table t_user add constraint FK_Reference_2 foreign key (card_id)
references t_card (id) on delete restrict on update restrict;
身份证表t_card
create table t_card
(
id bigint(20) not null auto_increment comment 'id',
card_code varchar(50) comment '卡号',
primary key (id)
);
alter table t_card comment '身份证表';
二. pojo类
用户User
public class User {
private Long id;
private String userName;
private Card card;//身份证,一对一
// getter、setter略
}
身份证Card
public class Card {
private Long id;
private String cardCode;
// getter、setter略
}
三. MyBatis配置
1. mybatis配置文件
<!-- 打开延迟加载的开关 -->
<setting name="lazyLoadingEnabled" value="true"/>
<!-- 将积极加载改为消息加载即按需加载 -->
<setting name="aggressiveLazyLoading" value="false"/>
方式一:嵌套查询
在UserMapper的XML文件中,通过<association>标签关联Card,属性说明:
- property:映射到列结果的字段或属性
- javaType:一个 Java 类的完全限定名,或一个类型别名。可以映射到JavaBean或HashMap
- column、select:column属性指定数据库的列名,select指定映射语句的id。这种情况下,column指定列的值作为参数传递给select指定的映射语句,用于嵌套查询使用。
UserMapper.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.my.mybatis.mapper.UserMapper">
<resultMap type="com.my.mybatis.pojo.User" id="userMap">
<id property="id" column="user_id"/>
<result property="userName" column="user_name"/>
<!-- 关联身份证,借助select实现 -->
<association property="card" javaType="com.my.mybatis.pojo.Card" column="card_id" select="com.my.mybatis.mapper.CardMapper.findById" />
</resultMap>
<sql id="Base_Column_List">
id, user_name, card_id
</sql>
<select id="findById" parameterType="int" resultMap="userMap">
select
<include refid="Base_Column_List"/>
from t_user
where id = #{id}
</select>
</mapper>
CardMapper.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.my.mybatis.mapper.CardMapper">
<resultMap type="com.my.mybatis.pojo.Card" id="cardMap">
<id property="id" column="card_id"/>
<result property="cardCode" column="card_code"/>
</resultMap>
<sql id="Base_Column_List" >
id, card_code
</sql>
<select id="findById" parameterType="int" resultMap="cardMap">
select
<include refid="Base_Column_List"/>
from t_card
where id = #{id}
</select>
</mapper>
这种方式会造成N+1查询问题,概括地讲,N+1 查询问题可以是这样引起的:
- 执行了一个单独的 SQL 语句来获取结果列表(就是“+1”)。
- 对返回的每条记录,又执行了一个查询语句来为每个加载细节(就是“N”)。
这个问题会导致成百上千的 SQL 语句被执行。MyBatis的懒加载(延迟加载)可以避免这种情况发生,但是在查询出的列表里面我们仍要使用关联的数据,那么还会造成多次查询的情况。
方式二:嵌套结果
(1)直接嵌套
通过多表查询的方式查询关联信息,可在某些场景下代替方式一,属性如下:
- property:映射到列结果的字段或属性
- javaType:一个 Java 类的完全限定名,或一个类型别名。可以映射到JavaBean或HashMap
- columnPrefix:指定列前缀。多表连接时,通过列别名ResultSet避免重复。在此处,将带有指定前缀的列与关联的属性进行映射,如columnPrefix="c_",那么只会将带有c_前缀的列与card进行映射。
- 嵌套的结果映射直接写在<association>标签内,不可重复使用
示例:
UserMapper.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.my.mybatis.mapper.UserMapper">
<resultMap type="com.momo.mybatis_xmlmapper.assocation.pojo.User" id="userMap">
<id property="id" column="id"/>
<result property="userName" column="user_name"/>
<!-- 关联Card -->
<!-- 嵌套结果-直接映射 -->
<association property="card" javaType="com.momo.mybatis_xmlmapper.assocation.pojo.Card" columnPrefix="c_">
<id property="id" column="id"/>
<result property="cardCode" column="card_code"/>
</association>
</resultMap>
<select id="findUserById" parameterType="int" resultMap="userMap">
select
t.id,
t.user_name,
t.card_id,
c.id as c_id,
c.card_code as c_card_code
from t_user_assocation t left join t_card_assocation c on t.card_id = c.id
where t.id = #{id}
</select>
</mapper>
(2)嵌套结果使用resultMap
属性同上,resultMap属性:将查询的结果与CardMapper命名空间的resultMap进行映射
示例:
UserMapper.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.my.mybatis.mapper.UserMapper">
<resultMap type="com.momo.mybatis.pojo.User" id="userMap">
<id property="id" column="id"/>
<result property="userName" column="user_name"/>
<!-- 关联Card -->
<association property="card" javaType="com.my.mybatis.pojo.Card" resultMap="com.my.mybatis.mapper.CardMapper.cardMap" columnPrefix="c_"/>
</resultMap>
<select id="findUserById" parameterType="int" resultMap="userMap">
select
t.id,
t.user_name,
t.card_id,
c.id as c_id,
c.card_code as c_card_code
from t_user_assocation t left join t_card_assocation c on t.card_id = c.id
where t.id = #{id}
</select>
</mapper>
CardMapper.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.my.mybatis.mapper.CardMapper">
<resultMap type="com.my.mybatis.pojo.Card" id="cardMap">
<id property="id" column="card_id"/>
<result property="cardCode" column="card_code"/>
</resultMap>
</mapper>
四.测试
1.UserMapper.java
public User findById(Integer id);
2.CardMapper.java
public Card findById(Integer id);
3.测试
public void testOneToOne() throws Exception {
InputStream inputStream = org.apache.ibatis.io.Resources.getResourceAsStream("mybatis.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession session = sqlSessionFactory.openSession();
UserMapper userMapper = session.getMapper(UserMapper.class);
User user = userMapper.findById(1);
System.out.println(user.getUserName());
System.out.println(user.getCard().getCardCode());
session.commit();
session.close();
}
五.注
1. 设置懒加载方式查询关联的实体,可以在mybatis.xml进行全局配置,如
<!-- 打开延迟加载的开关 -->
<setting name="lazyLoadingEnabled" value="true"/>
<!-- 将积极加载改为消息加载即按需加载 -->
<setting name="aggressiveLazyLoading" value="false"/>
也可以在assocation、collection等标签中设置fetchType属性
fetchType="lazy" <!-- 懒加载 -->
fetchType="eager" <!-- 立即加载 -->
2. 测试结果:
(1)嵌套查询
首先查询出用户信息,之后在执行user.getCard().getCardCode()时再查询出身份证信息;如果不执行该语句,则不会查询身份证信息
DEBUG - ==> Preparing: select id, user_name from t_user where id = ?
DEBUG - ==> Parameters: 1(Integer)
DEBUG - <== Total: 1
小明
DEBUG - ==> Preparing: select id , card_code from t_card where id = ?
DEBUG - ==> Parameters: 1(Integer)
DEBUG - <== Total: 1
201706240001
(2)嵌套结果
多表查询出所有数据,在进行结果映射