Rafy 领域实体框架 - 树型实体功能(自关联表)

Rafy 领域实体框架中,对自关联的实体结构做了特殊的处理,下面对这一功能进行讲解。

场景

在开发数据库应用程序时,往往会遇到自关联表的场景。例如,分类信息、组织架构中的部门、文件夹信息等,都是不限制层级的。如下图中操作系统的文件夹:

在开发这类程序时,往往是设计一张表,表中的一个可空的外键直接引用这张表本身。对应的实体如下图:

而针对这样的场景,许多ORM框架都不做默认的处理,开发者往往每次都要做重复的工作:建立类似结构的表,编写关系处理代码,编写查询代码……而这种场景经常会出现,所以 Rafy 实体框架中,默认就支持了树型实体的一系列功能,来降低重复劳动。

功能及使用说明

在 Rafy 中的树型实体功能,只需开发者使用一行代码为指定的实体打开这个功能,框架会自动完成以下工作:

  • 自动添加实体的自引用关系。自动生成数据库自关联表。
  • 自动维护树节点的 TreeIndex 索引。
  • 自带多个查询,用于查询树节点。
  • 查询结果自动转变为树的结构。
  • 支持树节点的按需加载。

下面,将逐一进行讲解。

打开树型实体功能

开发者只需使用一行代码即可让指定的实体转变为树型实体。在指定实体的配置代码中,添加下面这行代码即可:

自动添加实体的自引用关系

实体基类上已经默认带有以下几个属性,来表达树节点之间的关系。

当某个实体类型被配置为树型实体时,这几个属性才会有意义。 SupportTree:指示该实体是否为树型实体。 TreeIndex:树节点的编码、索引。此属性会映射为数据库中的字段。 TreePId:该树节点的父节点的 Id。此属性会映射为数据库中的字段。 TreeParent:该树节点的父节点实体。 TreeChildren:该树节点的所有子节点集合。

自动生成数据库自关联表

运行程序后,该实体对应的表将会自动添加两个字段:TreeIndex、TreePId,如下图:

自动维护树节点的 TreeIndex 索引

TreeIndex 是树结点的系统编号,由框架自动维护。下图显示了一个正在使用的树的 TreeIndex 的格式:

这个属性不但可以用于显示,更重要的是它是树型实体大量功能的结构基础。例如,当查询某个节点下的所有节点时,就是通过 TreeIndex 来进行模糊匹配的。所以这个属性的值非常重要,只能由框架来自行维护,而不能由开发者来设置。

开发者可以通过 TreeParent、TreeChildren、TreePId 等属性来变更节点与节点之间的父子关系,这时,对应的节点的 TreeIndex 则会同时自动变更。

树结构的表示

树的结构非常重要,我手画了张草图来表示:

主要由三个类型构成整个树:EntityList、Entity、EntityTreeChildren。这个结构可以表示完整的一棵树,也可以表示部分树。其中,EntityList 用于存储树的根节点(如果是部分树,则表示最上层节点);Entity 表示树中的每一个节点;EntityTreeChildren 集合则表示某个节点下的子节点。

另外,EntityTreeChildren 集合可以按需加载。当它还没有进行加载时,遍历整个树只能遍历到当前已经在内存中的树节点。例如,上图中,Root3的子节点没有被加载,1.2.2 的子节点也没有被加载。

那么,如何加载还没有加载到内存中的节点呢?这需要使用到 ITreeComponent 接口中的 LoadAllNodes 方法。EntityList、Entity、EntityTreeChildren 这三个类型都实现了 ITreeComponent 接口,下面是这个接口的定义:

另外,可以使用其中的 EachNode 方法来以深度优先的算法遍历整棵树。

自带多个查询,用于查询树节点

实体仓库中带有许多查询方法,其中一些是专门为树型实体设计的:

  • GetTreeRoots:查询所有的根节点。
  • GetByTreePId:查找指定树节点的直接子节点。
  • GetByTreeParentIndex:递归查找指定父索引号的节点下的所有子节点。
  • LoadAllTreeParents:递归加载某个节点的所有父节点。使用此方法后,指定节点的父节点将被赋值到它的 TreeParent 属性上。
  • GetAllTreeParents:获取指定索引对应的树节点的所有父节点。 查询出的父节点同样以一个部分树的形式返回。

另外,一些非树实体的查询方法,对于树型实体也是可用的。如 GetAll、GetByParentId 等。但是也会有所区别,例如 GetAll 方法在查询非树实体时,查询出的实体列表中包含所有的实体;但是在查询树型实体时,结果会按照树的结构来进行加载,即列表中只会有根节点,其它节点则分别在根节点的下级节点中。

同时,这些查询往往支持是否使用贪婪加载的参数。以 GetTreeRoots 方法举例,它的接口是这样的:public EntityList GetTreeRoots(EagerLoadOptions eagerLoad = null); 。它在默认情况下只返回根节点,而根节点中的子节点是没有被加载的。但是,我们可以通过参数中的 eagerLoad 来指定,在加载根节点的同时,把所有的子节点都加载上。

以上只是对一些接口做一些必要的解释,具体的使用方法及其它的接口,请参照注释及源码中的单元测试。

限制

说了上面这么多自带的功能,但是 Rafy 中树型实体的设计也有这的限制:一个树型实体类型对应的数据表中,只能存储一棵树。树中的所有节点的 TreeIndex 都必须是唯一的。

好了,鉴于篇幅,这篇文章只是简单地讲解了树型实体中的重点概念及功能,并没有深入说明。这是因为,在使用的过程中你会发现,一般情况下用起来非常容易,只需要打开树型实体功能,并调用想要的查询就可以了,用不到特别复杂的 API。如果确实需要深入了解,那么在理解了整个树的结构设计后,再结合帮助、注释以及源码中的单元测试,相信也会比较简单。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏生信宝典

Linux学习-文件列太多,很难识别想要的信息在哪列;别焦急,看这里。

经常会碰到列数特别多的文件,而屏幕又不足以放下这么多列;即便能放下,也不容易清晰的辨别出想提取的信息在第几列。 根据我们前面的学习,可以用一行命令或简单的写一...

304100
来自专栏gaoqin31

设计模式之 策略模式

定义 :封装了一些列算法,它们之前可以相互替换,此模式使得算法的改变,不会影响到使用它们的客户端

13530
来自专栏张善友的专栏

.net 2.0 你是如何使用事务处理?

     事务处理作为企业级开发必备的基础设施, .net 2.0通过System.Transactions对事务提供强大的支持.你还是在使用.net 1.x下...

22760
来自专栏编程

Nutch重要命令使用说明

之前几篇博文对nucth抓取周期的几个命令做了说明,本篇博文将对nutch抓取周期以外的几个重要的命令的使用进行详细的说明。 1. mergesegs 合并多个...

21050
来自专栏深度学习之tensorflow实战篇

RStudio中,出现中文乱码问题的解决方案

RStudio中,出现中文乱码问题的解决方案 正常出现乱码问题, 解决步骤: 1、设置RStudio文本显示的默认编码: RStudio菜单栏的Tools...

29970
来自专栏python3

查看php-fpm内存占用

ps --no-headers -o "rss,cmd" -C php-fpm | awk '{ sum+=$1 } END { printf ("%d%s\n...

13220
来自专栏Spark学习技巧

Mapreduce shuffle详解

Mapreduce shuffle详解 Mapreduce确保每个reducer的的输入都是按键排序的。系统执行排序的过程(即将map输出作为输入 传给redu...

45330
来自专栏日常分享

RabbitMQ基本模式

   最近用到了一些RabbitMQ的东西,看了官方的Get Started,以此为模板总结一下。

33120
来自专栏企鹅号快讯

Jmeter常用获取数据的几种方式

还没用过聊天机器人?给我发消息试试。 Jmeter在互联网测试中应用非常多,可以用来做接口测试或者性能测试,算是非常不错的一个工具。今天我们来聊聊Jmeter获...

24280
来自专栏腾讯Bugly的专栏

Android 混淆那些事儿

本文主要讲述了代码混淆和资源混淆的原理,Studio默认的混淆方案,混淆的参数,以及如何对Apk进行代码混淆(自定义混淆文件)和资源混淆(结合微信混淆和美团混淆...

1K50

扫码关注云+社区

领取腾讯云代金券