大神带你重新认识Mybatis中强大的resultMap

向右看齐 2023-09-30 20:27 9阅读 0赞

### 前言 ###

在Mybatis中，有一个强大的功能元素resultMap。当我们希望将JDBC ResultSets中的数据，转化为合理的Java对象时，你就能感受到它的非凡之处。正如其官方所述的那样：

> resultMap元素是 MyBatis 中最重要最强大的元素。它可以让你从 90% 的 JDBC ResultSets 数据提取代码中解放出来，并在一些情形下允许你进行一些 JDBC 不支持的操作。实际上，在为一些比如连接的复杂语句编写映射代码的时候，一份 resultMap 能够代替实现同等功能的长达数千行的代码。ResultMap 的设计思想是，对于简单的语句根本不需要配置显式的结果映射，而对于复杂一点的语句只需要描述它们的关系就行了。

一、字段映射

在Mybatis中，最简单的结果映射方式，就是通过类型别名typeAliases来处理。

如果要这样做，那么第一步需要配置实体类包的路径：

mybatis.type-aliases-package=com.xxx.entity

该路径下的所有类，就会被注册到TYPE\_ALIASES容器。我们在指定返回值类型的时候，就直接用别名即可。

比如，我们有一个User类：

![c40d8a8a4c44333933ad1219b6d952f6.png][]

如果数据库中表的字段与User类的属性名称一致，我们就可以使用resultType来返回。

![b5cc00ee9b27376c1103a094a270b4e9.png][]

当然，这是理想状态下，属性和字段名都完全一致的情况。但事实上，不一致的情况是有的，这时候我们的resultMap就要登场了。

如果User类保持不变，但SQL语句发生了变化，将id改成了uid。

![4aeb9aa75a50e2d93d0616391b0847cc.png][]

那么，在结果集中，我们将会丢失id数据。这时候我们就可以定义一个resultMap，来映射不一样的字段。

然后，我们把上面的select语句中的resultType修改为resultMap="getUserByIdMap"。

这里面column对应的是数据库的列名或别名；property对应的是结果集的字段或属性。

这就是resultMap最简单，也最基础的用法：字段映射。

下面，我们看看其他几种标签都是怎么应用的。

![09b1e3bbae3de7d2ab384068b60699b8.png][]

###  ###

二、构造方法

如果你希望将结果注入构造方法里，就可以用到constructor元素。

比如，我们的User类增加了一个构造方法：

public User(String id, String name) \{ this.id = id+"--------"; this.username = name+"--------"; \}

我们需要在resultMap中定义constructor元素：

![29de385f969f9a24a515719af9d1d8c4.png][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

其中，column代表数据库字段名称或者别名；name则是构造方法中的参数名称；javaType指定了参数的类型。

如你所想，这样指定构造方法后，我们结果集中的id和username属性都会发生变化。

\{ "id": "1001--------", "username": "后羿--------", "password": "123456", "address": "北京市海淀区", "email": "510273027@qq.com" \}

三、关联

在实际的业务中，我们的用户一般都会有一个角色。那么在User类里面一般也是以一个实体类来表示。

@Data public class User \{ //省略用户属性... //角色信息 private Role role; \}

我们在查询用户的时候，如果也希望看到它的角色信息，我们会这样来写查询语句：

![6142925228c116777ad18048f5f4fa88.png][]

如上，就要查询单个用户以及用户的角色信息。不过在这里，我们不能用resultType=User来返回。

毕竟，User类中只有一个Role对象，并没有role\_id和role\_name字段属性。

所以，我们要使用association来关联它们。

![2dd98f6d582aef35cacaaf57ea523edd.png][]

最后我们就可以将角色信息一块显示出来：

![1250a3e9a2772a201f748158735a0588.png][]

事实上，如果你确定关联信息是一对一的情况，有个更简便的方法可以替代association，我们在本文的第五部分-自动填充关联对象再看它是怎么实现的。

###  ###

四、集合

1、集合的嵌套结果映射

上面我们看到一个用户后羿，它的角色是射手；但大部分时候，我们每个人都不可能只拥有一种角色。所以，我们需要将User类中的角色属性的类型改成List。

@Data public class User \{ //省略用户属性... //角色信息 private List<Role> roles; \}

现在就变成了一个用户对应多个角色，所以就不是简单的association。

因为association处理的是有一个类型的关联；而我们这里是有多个类型的关联，所以就需要用到collection属性。

我们整体的resultMap会变成下面这样：

![f8cf18b1bcfa8cf472892a464928e355.png][]

这样的话，即便你有多个角色也可以被正确显示：

![d8e5cde63ed7b07c5bc28fdf9396612c.png][]

2、集合的嵌套 Select 查询

在大部分业务系统中，我们都会有一个菜单的表，比如像下面这样，一张Menu表：

![e9f8fdfb84c1b363f599895fad02937f.png][]

这里我们给菜单分为两级。我们给前端返回菜单的时候，也是需要分级的，不可能将这7条数据平级展示。那么，在这里我们的Menu实体类如下：

@Data public class Menu \{ private String id; private String name; private String url; private String parent\_id; private List<Menu> childMenu; \}

一级菜单，包含一个二级菜单的列表，这里用childMenu来表示。

SQL语句中，如果没有parent\_id字段属性，我们就先查所有的一级菜单：

![24c682fa75aabf41e1cedadf29873b3f.png][]

这个查询语句，在不传输任何参数的情况下，我们会得到两条一级菜单的数据。

那么在只调用此方法一次的情况下，怎么把所有的菜单信息查询出来，并按层级展示呢？

我们来看menusMap的定义：

![1b24fc0eb2436adcb526c6c9ce5003e4.png][]

重点来看collection元素：

property="childMenu" 对应的是菜单中的子级菜单列表；

ofType="Menu" 对应返回数据的类型；

select="getMenus" 指定了SELECT语句的id；

column="\{parent\_id=id\}" 则是参数的表达式。

这个collection整体的含义可以这样理解：

通过getMenus这个SELECT语句来获取一级菜单中的childMenu属性结果；在上面的SELECT语句中，需要传递一个parent\_id参数；这个参数的值就是一级菜单中的id。

通过这种方式，我们就可以得到已分级的所有菜单信息。

![fce89bd74a5554f346bd45264d46a900.png][]

![1ef8eb64f3104e6bbb281768b9c24443.png][]

![f310316f899b4af48194b02fdab58000.png][]

###  ###

五、自动填充关联对象

我们知道，在Mybatis解析返回值的时候。

第一步是获取返回值类型，拿到Class对象，然后获取构造器，设置可访问并返回实例，然后又把它包装成MetaObject对象。

从数据库rs中拿到结果之后，会调用MetaObject.setValue(String name, Object value) 来填充对象。

在这过程中，有趣的是，它会以.来分隔这个name属性。

如果name属性中包含.符号，就找到.符号之前的属性名称，把它当做一个实体对象来处理。

可能笔者在这里描述的不够直观，我们还是来看例子。

在本文第三部分中，我们有一个用户对应一个角色的例子。

其中，User类定义如下：

@Data public class User \{ //省略用户属性... //角色信息 private Role role; \}

在这里，我们无需定义resultMap，直接返回resultType=User即可。不过需要把role信息的别名修改一下，重点是.符号

![213d549ac8c6a1ffdbe06a2538cdf0d6.png][]

这样，在Mybatis解析到role.id属性的时候，以.符号分隔之后发现，role别名对应的是Role对象，则会先初始化Role对象，并将值赋予id属性。

相关代码如图：

![format_png][]

[c40d8a8a4c44333933ad1219b6d952f6.png]: https://img-blog.csdnimg.cn/img_convert/c40d8a8a4c44333933ad1219b6d952f6.png
[b5cc00ee9b27376c1103a094a270b4e9.png]: https://img-blog.csdnimg.cn/img_convert/b5cc00ee9b27376c1103a094a270b4e9.png
[4aeb9aa75a50e2d93d0616391b0847cc.png]: https://img-blog.csdnimg.cn/img_convert/4aeb9aa75a50e2d93d0616391b0847cc.png
[09b1e3bbae3de7d2ab384068b60699b8.png]: https://img-blog.csdnimg.cn/img_convert/09b1e3bbae3de7d2ab384068b60699b8.png
[29de385f969f9a24a515719af9d1d8c4.png]: https://img-blog.csdnimg.cn/img_convert/29de385f969f9a24a515719af9d1d8c4.png
[6142925228c116777ad18048f5f4fa88.png]: https://img-blog.csdnimg.cn/img_convert/6142925228c116777ad18048f5f4fa88.png
[2dd98f6d582aef35cacaaf57ea523edd.png]: https://img-blog.csdnimg.cn/img_convert/2dd98f6d582aef35cacaaf57ea523edd.png
[1250a3e9a2772a201f748158735a0588.png]: https://img-blog.csdnimg.cn/img_convert/1250a3e9a2772a201f748158735a0588.png
[f8cf18b1bcfa8cf472892a464928e355.png]: https://img-blog.csdnimg.cn/img_convert/f8cf18b1bcfa8cf472892a464928e355.png
[d8e5cde63ed7b07c5bc28fdf9396612c.png]: https://img-blog.csdnimg.cn/img_convert/d8e5cde63ed7b07c5bc28fdf9396612c.png
[e9f8fdfb84c1b363f599895fad02937f.png]: https://img-blog.csdnimg.cn/img_convert/e9f8fdfb84c1b363f599895fad02937f.png
[24c682fa75aabf41e1cedadf29873b3f.png]: https://img-blog.csdnimg.cn/img_convert/24c682fa75aabf41e1cedadf29873b3f.png
[1b24fc0eb2436adcb526c6c9ce5003e4.png]: https://img-blog.csdnimg.cn/img_convert/1b24fc0eb2436adcb526c6c9ce5003e4.png
[fce89bd74a5554f346bd45264d46a900.png]: https://img-blog.csdnimg.cn/img_convert/fce89bd74a5554f346bd45264d46a900.png
[1ef8eb64f3104e6bbb281768b9c24443.png]: https://img-blog.csdnimg.cn/img_convert/1ef8eb64f3104e6bbb281768b9c24443.png
[f310316f899b4af48194b02fdab58000.png]: https://img-blog.csdnimg.cn/img_convert/f310316f899b4af48194b02fdab58000.png
[213d549ac8c6a1ffdbe06a2538cdf0d6.png]: https://img-blog.csdnimg.cn/img_convert/213d549ac8c6a1ffdbe06a2538cdf0d6.png
[format_png]: https://img-blog.csdnimg.cn/img_convert/ac80299d5cf4b48b80f012b9cf772a0b.webp?x-oss-process=image/format,png