AI专业者开发社区 1 号成员
  •  0 回帖  •  1 浏览  •  5 个月前
   

mybatis ResultMap详解

前言

MyBatis 是基于“数据库结构不可控”的思想建立的，也就是我们希望数据库遵循第三范式或 BCNF，但实际事与愿违，那么结果集映射就是 MyBatis 为我们提供这种理想与现实间转换的手段了，而 resultMap 就是结果集映射的配置标签了。 
在深入 ResultMap 标签前，我们需要了解从 SQL 查询结果集到 JavaBean 或 POJO 实体的过程。

从 SQL 查询结果到领域模型实体　

  1. 通过 JDBC 查询得到 ResultSet 对象
  2. 遍历 ResultSet 对象并将每行数据暂存到 HashMap 实例中，以结果集的字段名或字段别名为键，以字段值为值
  3. 根据 ResultMap 标签的 type 属性通过反射实例化领域模型
  4. 根据 ResultMap 标签的 type 属性和 id、result 等标签信息将 HashMap 中的键值对，填充到领域模型实例中并返回

一、resultMap

1、属性说明

  • id 属性 ，resultMap 标签的标识。
  • type 属性 ，返回值的全限定类名，或类型别名。
  • autoMapping 属性 ，值范围 true（默认值）|false, 设置是否启动自动映射功能，自动映射功能就是自动查找与字段名小写同名的属性名，并调用 setter 方法。而设置为 false 后，则需要在resultMap内明确注明映射关系才会调用对应的 setter 方法。

2、基本作用：建立 SQL 查询结果字段与实体属性的映射关系 
示例 1：通过 setter 构造领域模型

?
1
2
3
4
5
6
7
8
9
10
11
public class EStudent{
  private long id;
  private String name;
  private int age;
  // getter,setter方法
 
  /**
   * 必须提供一个无参数的构造函数
   */
  public EStudent(){}
}

　　

?
1
2
3
4
5
6
7
8
9
<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 元素 ，用于设置普通字段与领域模型属性的映射关系

id、result 语句属性配置细节：

 

属性描述
property 需要映射到 JavaBean 的属性名称。
column 数据表的列名或者标签别名。
javaType 一个完整的类名，或者是一个类型别名。如果你匹配的是一个 JavaBean，那 MyBatis 通常会自行检测到。然后，如果你是要映射到一个 HashMap，那你需要指定 javaType 要达到的目的。
jdbcType 数据表支持的类型列表。这个属性只在 insert,update 或 delete 的时候针对允许空的列有用。JDBC 需要这项，但 MyBatis 不需要。如果你是直接针对 JDBC 编码，且有允许空的列，而你要指定这项。
typeHandler 使用这个属性可以覆写类型处理器。这项值可以是一个完整的类名，也可以是一个类型别名。

示例 2：通过构造函数构造领域模型

 

?
1
2
3
4
5
6
7
8
9
10
11
<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、一对一关系、一对多关系查询

?
1
注意：在采用嵌套结果的方式查询一对一、一对多关系时，必须要通过resultMap下的id或result标签来显式设置属性/字段映射关系，否则在查询多条记录时会仅仅返回最后一条记录的情况。

　　

association 联合

联合元素用来处理“一对一”的关系。需要指定映射的 Java 实体类的属性，属性的 javaType（通常 MyBatis 自己会识别）。对应的数据库表的列名称。如果想覆写的话返回结果的值，需要指定 typeHandler。 
不同情况需要告诉 MyBatis 如何加载一个联合。MyBatis 可以用两种方式加载：

  • select: 执行一个其它映射的 SQL 语句返回一个 Java 实体类型。较灵活；
  • resultsMap: 使用一个嵌套的结果映射来处理通过 join 查询结果集，映射成 Java 实体类型。

例如，一个班级对应一个班主任。 
首先定义好班级中的班主任 private TeacherEntity teacherEntity;

使用 select 实现联合 
例：班级实体类中有班主任的属性，通过联合在得到一个班级实体时，同时映射出班主任实体。 
这样可以直接复用在 TeacherMapper.xml 文件中定义好的查询 teacher 根据其 ID 的 select 语句。而且不需要修改写好的 SQL 语句，只需要直接修改 resultMap 即可。

ClassMapper.xml 文件部分内容：

 

?
1
2
3
4
5
6
7
8
9
10
11
<resultMap type="ClassEntity" id="classResultMap"> 
    <id property="classID" column="CLASS_ID" /> 
    <result property="className" column="CLASS_NAME" /> 
    <result property="classYear" column="CLASS_YEAR" /> 
    <association property="teacherEntity" column="TEACHER_ID" select="getTeacher"/> 
</resultMap> 
 
<select id="getClassByID" parameterType="String" resultMap="classResultMap"> 
    SELECT * FROM CLASS_TBL CT 
    WHERE CT.CLASS_ID = #{classID}; 
</select>

　　

 

TeacherMapper.xml 文件部分内容：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<resultMap type="TeacherEntity" id="teacherResultMap"> 
    <id property="teacherID" column="TEACHER_ID" /> 
    <result property="teacherName" column="TEACHER_NAME" /> 
    <result property="teacherSex" column="TEACHER_SEX" /> 
    <result property="teacherBirthday" column="TEACHER_BIRTHDAY"/> 
    <result property="workDate" column="WORK_DATE"/> 
    <result property="professional" column="PROFESSIONAL"/> 
</resultMap> 
 
<select id="getTeacher" parameterType="String"  resultMap="teacherResultMap"> 
    SELECT * 
      FROM TEACHER_TBL TT 
     WHERE TT.TEACHER_ID = #{teacherID} 
</select>

　　

?
1
2
3
4
使用resultMap实现联合
与上面同样的功能，查询班级，同时查询器班主任。需在association中添加resultMap（在teacher的xml文件中定义好的），新写sql（查询班级表left join教师表），不需要teacher的select。
 
修改ClassMapper.xml文件部分内容：

　　

?
1
2
3
4
5
6
7
8
9
10
11
12
<resultMap type="ClassEntity" id="classResultMap"> 
    <id property="classID" column="CLASS_ID" /> 
    <result property="className" column="CLASS_NAME" /> 
    <result property="classYear" column="CLASS_YEAR" /> 
    <association property="teacherEntity" column="TEACHER_ID"  resultMap="teacherResultMap"/> 
</resultMap> 
 
<select id="getClassAndTeacher" parameterType="String" resultMap="classResultMap"> 
    SELECT * 
      FROM CLASS_TBL CT LEFT JOIN TEACHER_TBL TT ON CT.TEACHER_ID = TT.TEACHER_ID 
     WHERE CT.CLASS_ID = #{classID}; 
</select>

　　

其中的 teacherResultMap 请见上面 TeacherMapper.xml 文件部分内容中。

collection 聚集

聚集元素用来处理“一对多”的关系。需要指定映射的 Java 实体类的属性，属性的 javaType（一般为 ArrayList）；列表中对象的类型 ofType（Java 实体类）；对应的数据库表的列名称； 
不同情况需要告诉 MyBatis 如何加载一个聚集。MyBatis 可以用两种方式加载： 
1. select: 执行一个其它映射的 SQL 语句返回一个 Java 实体类型。较灵活； 
2. resultsMap: 使用一个嵌套的结果映射来处理通过 join 查询结果集，映射成 Java 实体类型。

例如，一个班级有多个学生。 
首先定义班级中的学生列表属性：private List<StudentEntity> studentList;

使用 select 实现聚集 
用法和联合很类似，区别在于，这是一对多，所以一般映射过来的都是列表。所以这里需要定义 javaType 为 ArrayList，还需要定义列表中对象的类型 ofType，以及必须设置的 select 的语句名称（需要注意的是，这里的查询 student 的 select 语句条件必须是外键 classID）。

ClassMapper.xml 文件部分内容：

 

?
1
2
3
4
5
6
7
8
9
10
11
12
<resultMap type="ClassEntity" id="classResultMap"> 
    <id property="classID" column="CLASS_ID" /> 
    <result property="className" column="CLASS_NAME" /> 
    <result property="classYear" column="CLASS_YEAR" /> 
    <association property="teacherEntity" column="TEACHER_ID"  select="getTeacher"/> 
    <collection property="studentList" column="CLASS_ID" javaType="ArrayList" ofType="StudentEntity" select="getStudentByClassID"/> 
</resultMap> 
 
<select id="getClassByID" parameterType="String" resultMap="classResultMap"> 
    SELECT * FROM CLASS_TBL CT 
    WHERE CT.CLASS_ID = #{classID}; 
</select> 

　　

 

StudentMapper.xml 文件部分内容：

 

?
1
2
3
4
5
6
7
8
9
10
11
12
13
<!-- java属性，数据库表字段之间的映射定义 --> 
<resultMap type="StudentEntity" id="studentResultMap"> 
    <id property="studentID" column="STUDENT_ID" /> 
    <result property="studentName" column="STUDENT_NAME" /> 
    <result property="studentSex" column="STUDENT_SEX" /> 
    <result property="studentBirthday" column="STUDENT_BIRTHDAY" /> 
</resultMap> 
 
<!-- 查询学生list，根据班级id --> 
<select id="getStudentByClassID" parameterType="String" resultMap="studentResultMap"> 
    <include refid="selectStudentAll" /> 
    WHERE ST.CLASS_ID = #{classID} 
</select>

　　

使用 resultMap 实现聚集 
使用 resultMap，就需要重写一个 sql，left join 学生表。

 

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<resultMap type="ClassEntity" id="classResultMap"> 
    <id property="classID" column="CLASS_ID" /> 
    <result property="className" column="CLASS_NAME" /> 
    <result property="classYear" column="CLASS_YEAR" /> 
    <association property="teacherEntity" column="TEACHER_ID"  resultMap="teacherResultMap"/> 
    <collection property="studentList" column="CLASS_ID" javaType="ArrayList" ofType="StudentEntity" resultMap="studentResultMap"/> 
</resultMap> 
 
<select id="getClassAndTeacherStudent" parameterType="String" resultMap="classResultMap"> 
    SELECT * 
      FROM CLASS_TBL CT 
           LEFT JOIN STUDENT_TBL ST 
              ON CT.CLASS_ID = ST.CLASS_ID 
           LEFT JOIN TEACHER_TBL TT 
              ON CT.TEACHER_ID = TT.TEACHER_ID 
      WHERE CT.CLASS_ID = #{classID}; 
</select> 

　　

其中的 teacherResultMap 请见上面 TeacherMapper.xml 文件部分内容中。studentResultMap 请见上面 StudentMapper.xml 文件部分内容中。

4. 动态映射关系 
通过 discriminator 子元素 （鉴别器）可以实现动态映射关系信息的设置。具体示例如下：

 

?
1
2
3
4
5
6
7
8
9
10
11
12
13
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 信息。

 

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<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)