MyBatis resultMap元素
resultMap 是 MyBatis 中最复杂的元素,主要用于解决实体类属性名与数据库表中字段名不一致的情况,可以将查询结果映射成实体对象。
现有的 MyBatis 版本只支持 resultMap 查询,不支持更新或者保存,更不必说级联的更新、删除和修改。
1、resultMap元素的构成
resultMap 元素还可以包含以下子元素,代码如下。
<resultMap id="" type="">
<constructor><!-- 类再实例化时用来注入结果到构造方法 -->
<idArg/><!-- ID参数,结果为ID -->
<arg/><!-- 注入到构造方法的一个普通结果 -->
</constructor>
<id/><!-- 用于表示哪个列是主键 -->
<result/><!-- 注入到字段或JavaBean属性的普通结果 -->
<association property=""/><!-- 用于一对一关联 -->
<collection property=""/><!-- 用于一对多、多对多关联 -->
<discriminator javaType=""><!-- 使用结果值来决定使用哪个结果映射 -->
<case value=""/><!-- 基于某些值的结果映射 -->
</discriminator>
</resultMap>
其中:
- 元素的 type 属性表示需要的 POJO,id 属性是 resultMap 的唯一标识。
- 子元素
id 和 result 元素都有以下属性。
元素 说明 property 映射到列结果的字段或属性。如果 POJO 的属性和 SQL 列名(column元素)是相同的,那么 MyBatis 就会映射到 POJO 上 column 对应 SQL 列 javaType 配置 Java 类型。可以是特定的类完全限定名或 MyBatis 上下文的别名 jdbcType 配置数据库类型。这是 JDBC 类型,MyBatis 已经为我们做了限定,基本支持所有常用数据库类型 typeHandler 类型处理器。允许你用特定的处理器来覆盖 MyBatis 默认的处理器。需要指定 jdbcType 和 javaType 相互转化的规则 一条 SQL 查询语句执行后会返回结果集,结果集有两种存储方式,即使用 Map 存储和使用 POJO 存储。
2、使用Map存储结果集
任何 select 语句都可以使用 Map 存储,代码如下。
<select id="getAllRole" resultType="java.util.Map"> SELECT * FROM role </select>
在 RoleMapper 接口中添加以下方法。
@MapKey("id") List<Map<String,Object>> getAllRole();
Map 的 key 是 select 语句查询的字段名(必须完全一样),而 Map 的 value 是查询返回结果中字段对应的值,一条记录映射到一个 Map 对象中。
使用 Map 存储结果集很方便,但可读性稍差,所以一般推荐使用 POJO 的方式。
3、使用POJO存储结果集
因为 MyBatis 提供了自动映射,所以使用 POJO 存储结果集是最常用的方式。但有时候需要更加复杂的映射或级联,这时就需要使用 select 元素的 resultMap 属性配置映射集合。
RoleMapper.xml新增如下内容:
<resultMap id="roleMap" type="role"> <id property="roleId" column="ID"></id> <result property="roleName" column="NAME"></result> </resultMap>
resultMap 元素的属性 id 代表这个 resultMap 的标识,type 标识需要映射的 POJO。我们可以使用 MyBatis 定义好的类的别名或自定义类的全限定名。
这里使用 property 元素指定 Role 的属性名称 name,column 表示数据库中 role 表的 SQL 列名 name,将 POJO 和 SQL 的查询结果一 一对应。
RoleMapper.xml 中 select 元素配置代码如下。
<select id="getRole" resultMap="roleMap"> SELECT * FROM role </select>
测试代码如下:
RoleMapper roleMapper = sqlSession.getMapper(RoleMapper.class); List<Role> roleList=roleMapper.getRole(); System.out.println(roleList);
测试结果如下:
09:40:08 [main] DEBUG cn.edu.guet.mapper.RoleMapper.getRole - ==> Preparing: SELECT * FROM role 09:40:08 [main] DEBUG cn.edu.guet.mapper.RoleMapper.getRole - ==> Parameters: 09:40:08 [main] TRACE cn.edu.guet.mapper.RoleMapper.getRole - <== Columns: id, name 09:40:08 [main] TRACE cn.edu.guet.mapper.RoleMapper.getRole - <== Row: 26f627db863442a9966c69a9e69712a2, 维护人员 09:40:08 [main] TRACE cn.edu.guet.mapper.RoleMapper.getRole - <== Row: 67426c770519471384fa87aa0fabbc45, 系统管理员 09:40:08 [main] DEBUG cn.edu.guet.mapper.RoleMapper.getRole - <== Total: 2 [Role{roleId='26f627db863442a9966c69a9e69712a2', roleName='维护人员'}, Role{roleId='67426c770519471384fa87aa0fabbc45', roleName='系统管理员'}]
可以发现 SQL 语句的列名和 roleMap 中的 column 一一对应。
4、resultType和resultMap的区别
MyBatis 的每一个查询映射的返回类型都是 resultMap,只是当我们提供的返回类型是 resultType 时,MyBatis 会自动把对应的值赋给 resultType 所指定对象的属性,而当我们提供的返回类型是 resultMap 时,MyBatis 会将数据库中的列数据复制到对象的相应属性上,可用于复制查询。
需要注意的是,resultMap 和 resultType 不能同时使用。