mybatiscollection用法_Mybatis中强大的resultMap

前言

在Mybatis中&＃xff0c;有一个强大的功能元素resultMap。当我们希望将JDBC ResultSets中的数据&＃xff0c;转化为合理的Java对象时&＃xff0c;你就能感受到它的非凡之处。正如其官方所述的那样&＃xff1a;resultMap元素是 MyBatis 中最重要最强大的元素。它可以让你从 90% 的 JDBC ResultSets 数据提取代码中解放出来&＃xff0c;并在一些情形下允许你进行一些 JDBC 不支持的操作。实际上&＃xff0c;在为一些比如连接的复杂语句编写映射代码的时候&＃xff0c;一份 resultMap 能够代替实现同等功能的长达数千行的代码。ResultMap 的设计思想是&＃xff0c;对于简单的语句根本不需要配置显式的结果映射&＃xff0c;而对于复杂一点的语句只需要描述它们的关系就行了。

一、字段映射

在Mybatis中&＃xff0c;最简单的结果映射方式&＃xff0c;就是通过类型别名typeAliases来处理。
如果要这样做&＃xff0c;那么第一步需要配置实体类包的路径&＃xff1a;mybatis.type-aliases-package&＃61;com.xxx.entity
该路径下的所有类&＃xff0c;就会被注册到TYPE_ALIASES容器。我们在指定返回值类型的时候&＃xff0c;就直接用别名即可。

比如&＃xff0c;我们有一个User类&＃xff1a;

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

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

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

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

然后&＃xff0c;我们把上面的select语句中的resultType修改为resultMap&＃61;"getUserByIdMap"。

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

这就是resultMap最简单&＃xff0c;也最基础的用法&＃xff1a;字段映射。

下面&＃xff0c;我们看看其他几种标签都是怎么应用的。

二、构造方法

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

比如&＃xff0c;我们的User类增加了一个构造方法&＃xff1a;

我们需要在resultMap中定义constructor元素&＃xff1a;

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

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

三、关联

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

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

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

毕竟&＃xff0c;User类中只有一个Role对象&＃xff0c;并没有role_id和role_name字段属性。

所以&＃xff0c;我们要使用association来关联它们。

最后我们就可以将角色信息一块显示出来&＃xff1a;

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

四、集合

1、集合的嵌套结果映射

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

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

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

我们整体的resultMap会变成下面这样&＃xff1a;

这样的话&＃xff0c;即便你有多个角色也可以被正确显示&＃xff1a;

2、集合的嵌套 Select 查询

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

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

一级菜单&＃xff0c;包含一个二级菜单的列表&＃xff0c;这里用childMenu来表示。

SQL语句中&＃xff0c;如果没有parent_id字段属性&＃xff0c;我们就先查所有的一级菜单&＃xff1a;

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

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

我们来看menusMap的定义&＃xff1a;

重点来看collection元素&＃xff1a;

property&＃61;"childMenu" 对应的是菜单中的子级菜单列表&＃xff1b;

ofType&＃61;"Menu" 对应返回数据的类型&＃xff1b;

select&＃61;"getMenus" 指定了SELECT语句的id&＃xff1b;

column&＃61;"{parent_id&＃61;id}" 则是参数的表达式。

这个collection整体的含义可以这样理解&＃xff1a;

通过getMenus这个SELECT语句来获取一级菜单中的childMenu属性结果&＃xff1b;在上面的SELECT语句中&＃xff0c;需要传递一个parent_id参数&＃xff1b;这个参数的值就是一级菜单中的id。

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

五、自动填充关联对象

我们知道&＃xff0c;在Mybatis解析返回值的时候。

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

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

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

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

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

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

其中&＃xff0c;User类定义如下&＃xff1a;

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

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

相关代码如图&＃xff1a;

来源&＃xff1a;掘金

作者&＃xff1a;清幽之地

原文&＃xff1a;Mybatis中强大的resultMap - 掘金