转:MyBatis ResultMap详解
前言
MyBatis是基于"数据库结构不可控"的思想建立的,也就是我们希望数据库遵循第三范式或BCNF,但实际事与原愿违,那么结果集映射就是Mybatis为我们提供这种理想与现实间转换的手段了,而resultMap就是结果集映射的配置标签了。
从SQL查询结果到领域模型实体
在深入ResultMap标签前,我们需要了解从SQL查询结果集到JavaBean或POJO实体的过程。
- 通过JDBC查询得到ResultSet对象
- 遍历ResultSet对象并将每行数据暂存到HashMap实例中,以结果集的字段名或字段别名为键,以字段值为值
- 根据ResultMap标签的type属性通过反射实例化领域模型
- 根据ResultMap标签的type属性和id、result等标签信息将HashMap中的键值对,填充到领域模型实例中并返回
ResultMap标签
1. 属性说明
id
属性,resultMap标签的标识。
type
属性,返回值的全限定类型,或类型别名
autoMapping
属性,值范围true(默认值) | false,设置是否启动自动映射功能,自动映射功能就是自动查找与字段名小写同名的属性名,并调用setter方法。而设置false后,则需要在resultMap
内明确注明映射关系才会调用对应的setter方法。
extends
没有说明
- 基本作用:建立SQL查询结果字段与实体属性的映射关系信息 示例1: 通过setter构造领域模型
public class EStudent{
private long id;
private String name;
private int age;
// getter,setter方法
/**
* 必须提供一个无参数的构造函数
*/
public EStudent(){}
}
<select id="getStudent" resultMap="getStudentRM">
SELECT ID, Name, Age
FROM TStudent
</select>
<resultMap id="getStudentRM" type="EStudnet">
<id property="id" column="ID"/>
<result property="studentName" column="Name"/>
<result property="studentAge" column="Age"/>
</resultMap>
子元素说明
id元素
,用于设置主键字段与领域模型属性的映射关系
result元素
,用于设置普通字段与领域模型属性的映射关系
示例2:通过构造函数构造领域模型
public class EStudent{
private long id;
private String name;
private int age;
// getter方法
public EStudent(long id, String name, int age){
this.id = id;
this.name = name;
this.age = age;
}
}
<select id="getStudent" resultMap="getStudentRM">
SELECT ID, Name, Age
FROM TStudent
</select>
<resultMap id="getStudentRM" type="EStudnet">
<constructor>
<idArg column="ID" javaType="_long"/>
<arg column="Name" javaType="String"/>
<arg column="Age" javaType="_int"/>
</constructor>
</resultMap>
子元素说明:
constructor元素
,指定使用指定参数列表的构造函数来实例化领域模型。注意:其子元素顺序必须与参数顺序对应
idArg子元素
,标记该入参为主键
arg子元素
,标记该入参为普通字段(主键使用该子元素设置也是可以的)
3. 一对一关系、一对多关系查询请参考《MyBatis魔法堂:即学即用篇》
注意:在采用嵌套结果的方式查询一对一,一对多关系时,必须要通过resultMap下的id或result标签来显示设置属性/字符映射关系,否则在查询多条记录会仅仅返回最后一条记录的情况。
4. 动态映射关系信息
通过discriminator子元素
(鉴别器)可以实现动态映射关系信息的设置。具体示例如下:
public class EStudent{
private long id;
private String name;
private String juniorHighSchool;
private String seniorHighSchool;
private int during; // 在本校就读时间
// getter,setter方法
/**
* 必须提供一个无参数的构造函数
*/
public EStudent(){}
}
情景:查询学生信息的seniorHighSchool信息,若就读时间during字段值为4、5、6时,则以juniorHighSchool字段作所为seniorHighSchool信息。
<select id="getStundent" resultMap="rm">
SELECT ID, Name, JuniorHighSchool, SeniorHighSchool, during
FROM TStudent
</select>
<resultMap id="rm" type="EStudent">
// 若不加这句,则当将juniorHighSchool赋予给seniorHighSchool属性时,juniorHighSchool属性将为null
<result column="juniorHighSchool" property="juniorHighSchool"/>
<discriminator column="during" javaType="_int">
// 形式1:通过resultType设置动态映射信息
<case value="4" resultType="EStudent">
<result column="juniorHighSchool" property="seniorHighSchool"/>
</case>
// 形式2: 通过resultMap设置动态映射信息
<case value="5" resultMap="dynamicRM"/>
<case value="6" resultMap="dynamicRM"/>
</discriminator>
</resultMap>
<resultMap id="dynamicRM" type="EStudent">
<result column="juniorHighSchool" property="seniorHighSchool"/>
</resultMap>
注意:上面关于 discriminator子元素
的 case元素
的 resultType属性
和 resultMap元素
的 type属性
,均不是直指返回的领域模型类型,而是指定根据判断条件后得到映射关系,可通过 id子元素
和 result子元素
重写映射关系。
5. id元素,result元素,idArg元素,arg元素,discriminator元素的共同属性
javaType属性
:Java类的全限定名,或别名
jdbcType属性
:JDBC类型,JDBC类型为CUD操作时列可能为空时进行处理
typeHandler属性
:指定类型处理器的全限定类名或类型别名
column属性
:指定SQL查询结果的字段名或字段别名。将用于JDBC的resultSet.getString(columnName)