@[toc] 当我们使用 Flowable 流程引擎的时候,虽然我们使用的是各种 API,但是小伙伴们都知道,这些 API 本质上操作的都是底层的数据表,Flowable 默认一共生成了 79 张数据表,了解这些数据表,有助于我们更好的理解 Flowable 中的各种 API,因此今天松哥就来和大家捋一捋 Flowable 中的数据表都有哪些,以及这些表都是干嘛用的。
现在我们基本上都是 Spring Boot 工程了,在 Spring Boot 工程中,只要我们添加了 Flowable 的依然,然后启动项目,系统就会自动帮我们创建 79 张表,查询 SQL 如下:
SELECT COUNT(*) TABLES, table_schema FROM information_schema.TABLES WHERE table_schema = 'flowable02' GROUP BY table_schema;
> 这里显示了 82 张表,是因为我自己手动创建了三个跟用户相关的表,其他 79 张表都是 Flowable 自动创建的。
好了,接下来我们就对这 79 张表进行一个简单的分类整理。
ACT_APP_*
(5)ACT_CMMN_*
(12)ACT_CO_*
(3)ACT_DMN_*
(6)ACT_EVT_*
(1)ACT_FO_*
(6)ACT_GE_*
(2)ACT_HI_*
(10)ACT_ID_*
(9)ACT_PROCDEF_*
(1)ACT_RE_*
(3)ACT_RU_*
(13)FLW_CHANNEL_*
(1)FLW_EV_*
(2)FLW_EVENT_*
(3)FLW_RU_*
(2)
*
是通配符,后面的数字表示这种类型的表有多少个。
大致看一下,其实还是有很多规律的。
最明显的规律就表名通过两个 _
隔开成了三部分,接下来我们就以此为线索,一部分一部分来讲。
1. 表名前缀
首先搭建看这个表的前缀,分了两种:
- ACT_
- FLW_
松哥在之前的文章中已经和大家介绍过了,Flowable 是基于 Activiti 开发出来的流程引擎,所以我们在很多地方都还能看到 Activiti 的影子,这个表名中 ACT_
就是 Activiti。
具体来说,与 Flowable 开源代码库相关的数据库表名以 ACT_
开头。特定于 Flowable Work 或 Engage 的数据库表以 FLW_
前缀开头。
2. 表名中间部分
紧跟着 ACT_ 或者 FLW_ 后面的内容,基本上也都是简称,例如:
- APP 表示这都是跟应用程序相关的表。
- CMMN 表示这都是跟 CMMN 协议相关的表。
- CO(CONTENT)表示这都是跟内容引擎相关的表。
- DMN 表示这都是跟 DMN 协议相关的表。
- EVT(EVENT)表示这都是跟事件相关的表。
- FO(FORM)表示这都是跟表单相关的表。
- GE(GENERAL)表示这都是通用表,适用于各种用例的。
- HI(HISTORY)这些是包含历史数据的表。当从运行时表中删除数据时,历史表仍然包含这些已完成实例的所有信息。
- ID(IDENTITY)表示这都是跟用户身份认证相关的表。
- PROCDEF(PROCESSDEFINE) 表示这都是跟记录流程定义相关的表。
- RE(REPOSITORY)表示这都是跟流程的定义、流程的资源等等包含了静态信息相关的表。
- RU(RUNTIME)代表运行时,这些是包含尚未完成的流程、案例等的运行时数据的运行时表。Flowable 仅在执行期间存储运行时数据,并在实例结束后删除记录,这使运行时表保持小而快。
- CHANNEL 表示这都是跟泳道相关的表。
- EV 表示这个是跟 FLW_ 搭配的,在这里似乎并没有一个明确的含义,相关的表也都是跟 Liquibase 相关的表。
- EVENT 表示这都是跟事件相关的表。
把这些简称的单词搞明白了,接下来的就容易看懂每一个表的含义了。
表名是由三部分构成的,我们现在已经分析了前两部分了,接下来我们来看第三部分。
3. 表名后缀
表名的后缀,有一些是通用的后缀名词,我们先来看下。
- DATABASECHANGELOG:表名中包含这个单词的,表示这个表是 Liquibase 执行的记录,Liquibase 是一个数据库脚本管理的工具,有点像 flyway,松哥之前写过 flyway 的文章,我这里就不啰嗦了。包含 DATABASECHANGELOG 后缀的表一共是 6 张。
- DATABASECHANGELOGLOCK:表名中包含这个单词的,表示这个表记录 Liquibase 执行锁的,用以确保一次只运行一个 Liquibase 实例,包含 DATABASECHANGELOGLOCK 后缀的表也是 6 张。
这两个加起来就 12 张表了,一共 79 张,现在还剩 67 张,我们来详细看下。
> 在后面的介绍中,凡是涉及到 DATABASECHANGELOG 和 DATABASECHANGELOGLOCK 的表,我就直接省略了。
3.1 ACT_APP_*
以 ACT_APP_*
开头的表负责应用引擎存储和应用部署定义。相关的表一共是五张,如下:
ACT_APP_APPDEF
应用程序模型产生应用程序定义。此定义,如流程/案例/等。是成功部署到应用引擎的应用模型的表示。
ACT_APP_DEPLOYMENT
当通过应用引擎部署应用模型时,会存储一条记录以保存此部署。部署的实际内容被存储在 ACT_APP_DEPLOYMENT_RESOURCE 表中,并从该表中引用。
ACT_APP_DEPLOYMENT_RESOURCE
此表包含构成应用程序部署的实际资源(存储为字节)。当引擎需要实际模型时,将从该表中获取资源。
3.2 ACT_CMMN_*
Flowable CMMN Engine 的数据库名称都以 ACT_CMMN_
开头。这里涉及到一个东西就是 CMMN,CMMN 与 BPMN 协议一致,也是一种流程内容的规范,CMMN 这类表一般用于存储处理 BPMN 所不能适用的业务场景数据,CMMN 通常与 BPMN 搭配使用,不过只有符合 CMMN 规范的模型数据才会使用这类表。
这里涉及到的相关表一共是 12 张,如下:
- ACT_CMMN_CASEDEF
- ACT_CMMN_DEPLOYMENT
- ACT_CMMN_DEPLOYMENT_RESOURCE
这三个都是没有附加前缀的表,主要定义了静态信息,例如 case 的定义和部署和以及相关的资源等。
接下来这些以 ACT_CMMN_HI_
开头的表代表历史数据,例如过去的案例实例、计划项目等。
ACT_CMMN_HI_CASE_INST
此表记录由 CMMN 引擎启动的每个案例实例的数据。
ACT_CMMN_HI_MIL_INST
此表记录了在案例实例中达到的每个里程碑的数据。
ACT_CMMN_HI_PLAN_ITEM_INST
此表记录了作为案例实例执行的一部分创建的每个计划项实例的数据。
接下来以 ACT_CMMN_RU_
开始的表代表运行时的数据,这些数据包含案例实例、计划项等的运行时数据。Flowable 仅在案例实例执行期间存储运行时数据,并在案例实例结束时删除记录,这使运行时表保持小且查询速度快。
ACT_CMMN_RU_CASE_INST
此表包含每个已启动但尚未完成的案例实例的条目。
ACT_CMMN_RU_MIL_INST
此表包含作为运行案例实例的一部分达到的每个里程碑的条目。
ACT_CMMN_RU_PLAN_ITEM_INST
案例实例执行由案例定义中定义的计划项的多个实例组成,此表包含在案例实例执行期间创建的每个实例的条目。
ACT_CMMN_RU_SENTRY_PART_INST
计划项目实例可以有守卫状态转换的哨兵,这样的哨兵在状态改变之前可以包含多个部分,这个表就是专门用来存储这种哨兵。
3.3 ACT_DMN_*
Flowable DMN 的数据库名称都以 ACT_DMN_
开头,这里涉及到的表一共是 6 张:
- ACT_DMN_DEPLOYMENT
- ACT_DMN_DEPLOYMENT_RESOURCE
这两个是就不需要我多说了吧,跟前面的都一样,只不过这里部署的是 DMN。
ACT_DMN_DECISION
此表包含已部署决策表的元数据,并与来自其他引擎的定义相对应。
ACT_DMN_HI_DECISION_EXECUTION
此表包含有关 DMN 决策表执行的审计信息。
3.4 ACT_RU_*
以 ACT_RU_
开头的表都是和流程引擎运行时信息相关的一些表。涉及到的表一共有 13 张:
ACT_RU_ACTINST
流程实例中的每个活动在此表中都有一行来指示活动的当前状态。
- ACT_RU_JOB
- ACT_RU_TIMER_JOB
- ACT_RU_SUSPENDED_JOB
- ACT_RU_EXTERNAL_JOB
- ACT_RU_HISTORY_JOB
- ACT_RU_DEADLETTER_JOB
Flowable 引擎使用作业表来实现异步逻辑、计时器或历史处理。这些表存储每个作业所需的数据。
ACT_RU_ENTITYLINK
此表存储有关实例的父子关系的信息。例如,如果流程实例启动子案例实例,则此关系存储在此表中。这样可以轻松查询关系。
ACT_RU_EVENT_SUBSCR
当流程定义使用事件(信号/消息/等或启动/中间/边界)时,引擎将对该表的引用存储在该表中。这简化了查询哪些实例正在等待某种类型的事件。
ACT_RU_EXECUTION
存储流程实例和指向流程实例当前状态的指针(称为执行)。
ACT_RU_IDENTITYLINK
此表存储有关用户或组的数据及其与(流程/案例/等)实例相关的角色。该表也被其他需要身份链接的引擎使用。
ACT_RU_TASK
此表包含正在运行的实例的每个未完成用户任务的条目。然后在查询用户的任务列表时使用此表。CMMN 引擎也使用此表。
ACT_RU_VARIABLE
此表存储与实例相关的变量。 CMMN 引擎也使用此表。
3.5 ACT_HI_*
以 ACT_HI_*
开头的表包含正在运行和已完成的实例的历史数据,这些表的名称遵循其运行时对应的名称,这里一共涉及到 10 张表:
ACT_HI_ACTINST
历史活动信息。这里记录流程流转过的所有节点,与 ACT_HI_TASKINST 不同的是, ACT_HI_TASKINST 只记录 Task 内容。
ACT_HI_ATTACHMENT
历史附件表。
ACT_HI_COMMENT
流程的历史评论表。
ACT_HI_DETAIL
历史详情表:流程中产生的变量详细,包括控制流程流转的变量,业务表单中填写的流程需要用到的变量等。
ACT_HI_ENTITYLINK
历史参与的人员表。
ACT_HI_IDENTITYLINK
任务参与者数据表,主要存储历史节点参与者的信息,可能是 Group 也可能是 User。
ACT_HI_PROCINST
保存每一个历史流程,创建时就生成,一条流程实例对应一个记录。
ACT_HI_TASKINST
记录每一个历史节点,一个 Task 对应一个记录。
ACT_HI_TSK_LOG
每一次执行可能会带上数据,存在这里。
ACT_HI_VARINST
流程历史变量表。
3.6 ACT_ID_*
以 ACT_ID_*
开头的都是和用户身份相关的表,一共是有 9 张表:
ACT_ID_BYTEARRAY
这是用户组的部署内容。
ACT_ID_GROUP
这是用户组的表。
ACT_ID_INFO
这是所有的用户的信息,账号密码。
ACT_ID_MEMBERSHIP
用户和用户组的关联表。
ACT_ID_PRIV
权限表。
ACT_ID_PRIV_MAPPING
用户、用户组以及权限之间的关联表。
ACT_ID_PROPERTY
用户的变量表。
ACT_ID_TOKEN
用户访问记录表。
ACT_ID_USER
用户表。
3.7 ACT_FO_FORM_*
以 ACT_FO_FORM_
开头的表存储表单引擎和围绕表单模型和这些表单的实例数据。
ACT_FO_FORM_DEFINITION
表单定义表。
ACT_FO_FORM_DEPLOYMENT
表单部署表。
ACT_FO_FORM_INSTANCE
表单实例表。
ACT_FO_FORM_RESOURCE
表单源数据表。
3.8 ACT_GE_*
以 ACT_GE_
开头的表表示一些通用信息表,涉及到的表一共是两个。
ACT_GE_BYTEARRAY
存储每个流程的部署记录,bytes_ 字段中保存流程的具体内容。
ACT_GE_PROPERTY
存储 Flowable 自身的一些变量,主要是版本号。
3.9 ACT_RE_*
以 ACT_RE_
开头的表表示这些表都是跟流程的定义、流程的资源等等包含了静态信息相关的表。
ACT_RE_DEPLOYMENT
流程部署记录,每次服务重启会部署一次,这里会新增一条记录。
ACT_RE_MODEL
创建模型时,额外定义的一些模型相关信息,存在这张表,默认不保存。
ACT_RE_PROCDEF
记录流程的变更,流程每变更一次存一条记录,version_ 字段加 1。
3.10 FLW_EVENT_*
FLW_EVENT_DEFINITION
已部署事件定义的元数据。
FLW_EVENT_DEPLOYMENT
已部署事件部署元数据。
FLW_EVENT_RESOURCE
事件所需资源。
3.11 其他表
还剩一些规则不太明显的表,如下:
FLW_RU_BATCH FLW_RU_BATCH_PART
这两个是批量迁移流程时使用。
ACT_PROCDEF_INFO
流程定义信息,对流程的说明。
ACT_CO_CONTENT_ITEM
每项内容在此表中都有个条目。
ACT_EVT_LOG
Flowable 引入了事件日志机制,默认会在数据库中创建 ACT_EVT_LOG
表保存事件日志,如果不使用事件日志,则可以删除这个表。
FLW_CHANNEL_DEFINITION
泳池管道定义表。
好啦,Flowable 中的表结构就和小伙伴们介绍完毕啦~大家可以收藏本文,在需要的时候作为一个参考~