Flowable 之表结构分析

---

提示：以下是本篇文章正文内容，Java 系列学习将会持续更新

一、表结构分类

工作流程的相关操作都是操作存储在对应的表结构中，为了能更好的弄清楚 Flowable 的实现原理和细节，我们有必要先弄清楚 Flowable 的相关表结构及其作用。在 Flowable 中的表结构在初始化的时候会创建五类表结构，具体如下：

• ACT_RE：RE 表示 repository。 这个前缀的表包含了流程定义和流程静态资源 （图片，规则等）。
• ACT_RU：RU 表示 runtime。 这些运行时的表，包含流程实例，任务，变量，异步任务，等运行中的数据。 Flowable只在流程实例执行过程中保存这些数据， 在流程结束时就会删除这些记录。 这样运行时表可以一直很小速度很快。
• ACT_HI：HI 表示 history。 这些表包含历史数据，比如历史流程实例， 变量，任务等。
• ACT_GE：GE 表示 general。 通用数据， 用于不同场景下 。
• ACT_ID：ID 表示 identity(组织机构)。这些表包含标识的信息，如用户，用户组等。

表分类	表名	解释
一般数据
	[ACT_GE_BYTEARRAY]	通用的流程定义和流程资源
	[ACT_GE_PROPERTY]	系统相关属性
流程历史记录
	[ACT_HI_ACTINST]	历史的流程实例
	[ACT_HI_ATTACHMENT]	历史的流程附件
	[ACT_HI_COMMENT]	历史的说明性信息
	[ACT_HI_DETAIL]	历史的流程运行中的细节信息
	[ACT_HI_IDENTITYLINK]	历史的流程运行过程中用户关系
	[ACT_HI_PROCINST]	历史的流程实例
	[ACT_HI_TASKINST]	历史的任务实例
	[ACT_HI_VARINST]	历史的流程运行中的变量信息
流程定义表
	[ACT_RE_DEPLOYMENT]	部署单元信息
	[ACT_RE_MODEL]	模型信息
	[ACT_RE_PROCDEF]	已部署的流程定义
运行实例表
	[ACT_RU_EVENT_SUBSCR]	运行时事件
	[ACT_RU_EXECUTION]	运行时流程执行实例
	[ACT_RU_IDENTITYLINK]	运行时用户关系信息，存储任务节点与参与者的相关信息
	[ACT_RU_JOB]	运行时作业
	[ACT_RU_TASK]	运行时任务
	[ACT_RU_VARIABLE]	运行时变量表
用户用户组表
	[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]	记录用户的token信息
	[ACT_ID_USER]	用户表

回到目录…

二、代码案例讲解

2.1 部署流程定义

/**
 * 部署流程
 */
@Test
public void test1(){
    Deployment deploy = repositoryService.createDeployment()
            .addClasspathResource("holiday-request-new.bpmn20.xml")
            .name("请假流程...")
            .category("请假") // 分类
            .tenantId("dpb") // 租户id
            .deploy();
    System.out.println("deploy.getId() = " + deploy.getId());
    System.out.println("deploy.getName() = " + deploy.getName());
    System.out.println("deploy.getCategory() = " + deploy.getCategory());
}

2.1.1 act_ge_bytearray

部署资源表如下：

字段	名称	备注
ID_	主键
REV_	版本号
NAME_	名称	部署的文件名称，如：holiday-request-new.bpmn20.xml、holiday-request-new.bpmn20.png
DEPLOYMENT_ID_	部署ID
BYTES_	字节（二进制数据）
GENERATED_	是否系统生成	0为用户上传， 1为系统自动生成， 比如系统会 自动根据xml生 成png

2.1.2 act_re_deployment

部署ID表如下：

字段	名称	备注
ID_	主键
NAME_	名称
CATEGORY_	分类
TENANT_ID_	租户ID
DEPLOY_TIME_	部署时间
DERIVED_FROM_	来源于
DERIVED_FROM_ROOT_	来源于
ENGINE_VERSION_	流程引擎的版本

2.1.3 act_re_procdef

流程实例表如下：和 ACT_RE_DEPLOYMENT 是多对一的关系。

字段	名称	备注
ID_	主键
REV_	版本号
CATEGORY_	分类	流程定义的Namespace就是类别
NAME_	名称
KEY_	标识
VERSION_	版本
DEPLOYMENT_ID_	部署ID
RESOURCE_NAME_	资源名称	流程bpmn文件名称
DGRM_RESOURCE_NAME_	图片资源名称
DESCRIPTION_	描述
HAS_START_FORM_KEY_	拥有开始表单标识	start节点是否存在formKey 0否 1是
HAS_GRAPHICAL_NOTATION_	拥有图形信息
SUSPENSION_STATE_	挂起状态	暂停状态 1激活 2暂停
TENANT_ID_	租户ID

2.1.4 挂起和激活

• 部署的流程默认的状态为激活，如果我们暂时不想使用该定义的流程，那么可以挂起该流程。当然该流程定义下边所有的流程实例全部暂停。
• 当流程定义为挂起状态，该流程定义将不允许启动新的流程实例，同时该流程定义下的所有的流程实例都将全部挂起暂停执行。

/**
 * 挂起流程
 */
@Test
public void test2(){
    ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
            .processDefinitionId("holiday:1:4")
            .singleResult();
    // 获取流程定义的状态
    boolean suspended = processDefinition.isSuspended();
    System.out.println("suspended = " + suspended);
    if(suspended){
        // 表示被挂起
        System.out.println("激活流程定义");
        repositoryService.activateProcessDefinitionById("holiday:1:4",true,null);
    }else{
        // 表示激活状态
        System.out.println("挂起流程");
        repositoryService.suspendProcessDefinitionById("holiday:1:4",true,null);
    }
}

具体的实现其实就是更新了流程定义表中的字段。

而且通过 REV_ 字段来控制数据安全，也是一种乐观锁的体现。如果要启动一个已经挂起的流程就会出现如下的错误：

回到目录…

2.2 启动流程实例

/**
 * 启动流程实例
 */
@Test
public void testRunProcess(){
    // 构建流程变量
    Map<String,Object> variables = new HashMap<>();
    variables.put("employee","张三") ;// 谁申请请假
    variables.put("nrOfHolidays",3); // 请几天假
    variables.put("description","工作累了，想出去玩玩"); // 请假的原因
    // 启动流程实例，第一个参数是流程定义的id
    ProcessInstance processInstance = runtimeService
            .startProcessInstanceById("holiday:1:4", variables);// 启动流程实例
    // 输出相关的流程实例信息
    System.out.println("流程定义的ID：" + processInstance.getProcessDefinitionId());
    System.out.println("流程实例的ID：" + processInstance.getId());
    System.out.println("当前活动的ID：" + processInstance.getActivityId());
}

• 当我们启动了一个流程实例后，会在 ACT_RU_* 对应的表结构中操作，运行时实例涉及的表结构共 10 张：
  • ACT_RU_DEADLETTER_JOB 正在运行的任务表
  • ACT_RU_EVENT_SUBSCR 运行时事件
  • ACT_RU_EXECUTION 运行时流程执行实例
  • ACT_RU_HISTORY_JOB 历史作业表
  • ACT_RU_IDENTITYLINK 运行时用户关系信息
  • ACT_RU_JOB 运行时作业表
  • ACT_RU_SUSPENDED_JOB 暂停作业表
  • ACT_RU_TASK 运行时任务表
  • ACT_RU_TIMER_JOB 定时作业表
  • ACT_RU_VARIABLE 运行时变量表
• 启动一个流程实例的时候涉及到的表有：
  • ACT_RU_EXECUTION 运行时流程执行实例
  • ACT_RU_IDENTITYLINK 运行时用户关系信息
  • ACT_RU_TASK 运行时任务表
  • ACT_RU_VARIABLE 运行时变量表

2.2.1 act_ru_execution

字段	名称	备注
ID_	主键
REV_	版本号
PROC_INST_ID_	流程实例ID
BUSINESS_KEY_	业务主键ID
PARENT_ID_	父执行流的ID
PROC_DEF_ID_	流程定义的数据ID
SUPER_EXEC_
ROOT_PROC_INST_ID_	流程实例的root流程id
ACT_ID_	节点实例ID
IS_ACTIVE_	是否存活
IS_CONCURRENT_	执行流是否正在并行
IS_SCOPE_
IS_EVENT_SCOPE_
IS_MI_ROOT_
SUSPENSION_STATE_	流程终端状态
CACHED_ENT_STATE_
TENANT_ID_	租户编号
NAME_
START_TIME_	开始时间
START_USER_ID_	开始的用户编号
LOCK_TIME_	锁定时间
IS_COUNT_ENABLED_
EVT_SUBSCR_COUNT_
TASK_COUNT_
JOB_COUNT_
TIMER_JOB_COUNT_
SUSP_JOB_COUNT_
DEADLETTER_JOB_COUNT_
VAR_COUNT_
ID_LINK_COUNT_

创建流程实例后对应的表结构的数据：

2.2.2 act_ru_task

运行时任务表如下：

字段	名称	备注
ID_	主键
REV_	版本号
EXECUTION_ID_	任务所在的执行流ID
PROC_INST_ID_	流程实例ID
PROC_DEF_ID_	流程定义数据ID
NAME_	任务名称
PARENT_TASK_ID_	父任务ID
DESCRIPTION_	说明
TASK_DEF_KEY_	任务定义的ID值
OWNER_	任务拥有人
ASSIGNEE_	被指派执行该任务的人
DELEGATION_	委托人
PRIORITY_	优先级
CREATE_TIME_	创建时间
DUE_DATE_	耗时
CATEGORY_	类别
SUSPENSION_STATE_	是否挂起	1代表激活 2代表挂起
TENANT_ID_	租户编号
FORM_KEY_
CLAIM_TIME_	拾取时间

创建流程实例后对应的表结构的数据：

2.2.3 act_ru_variable

运行时变量表如下：

字段	名称	备注
ID_	主键
REV_	版本号
TYPE_	参数类型	可以是基本的类型，也可以用户自行扩展
NAME_	参数名称
EXECUTION_ID_	参数执行ID
PROC_INST_ID_	流程实例ID
TASK_ID_	任务ID
BYTEARRAY_ID_	资源ID
DOUBLE_	参数为double，则保存在该字段中
LONG_	参数为long，则保存在该字段中
TEXT_	用户保存文本类型的参数值
TEXT2_	用户保存文本类型的参数值

创建流程实例后对应的表结构的数据：

2.2.4 act_ru_identitylink

运行时用户关系信息表如下：

字段	名称	备注
ID_	主键
REV_	版本号
GROUP_ID_	用户组ID
TYPE_	关系数据类型	assignee支配人(组)、candidate候选人(组)、owner拥有人,participant参与者
USER_ID_	用户ID
TASK_ID_	任务ID
PROC_INST_ID_	流程定义ID
PROC_DEF_ID_	属性ID

创建流程实例后对应的表结构的数据：

回到目录…

2.3 处理流程任务

上面的流程已经流转到了 zhangsan 这个用户这里，然后可以开始审批了。

@Test
public void testcompleteTask(){
    Task task = taskService.createTaskQuery()
        .processDefinitionId("holiday:1:4")
        .taskAssignee("zhangsan")
        .singleResult();
    // 添加流程变量
    Map<String,Object> variables = new HashMap<>();
    variables.put("approved",false); // 拒绝请假
    // 完成任务
    taskService.complete(task.getId(),variables);
}

在正常处理流程中涉及到的表结构：

• ACT_RU_EXECUTION 运行时流程执行实例
• ACT_RU_IDENTITYLINK 运行时用户关系信息
• ACT_RU_TASK 运行时任务表
• ACT_RU_VARIABLE 运行时变量表

ACT_RU_TASK 运行时任务表：会新生成一条记录。

ACT_RU_VARIABLE 运行时变量表：会记录新的流程变量。

当然，流程实例也可以挂起。

@Test
public void testSuspensionDeployment(){
	// 1.获取流程实例对象
	ProcessInstance processInstance = runtimeService.createProcessInstanceQuery()
    	.processInstanceId("25001")
    	.singleResult();
	// 2.获取相关的状态操作
	boolean suspended = processInstance.isSuspended();
	String id = processInstance.getId();
	if(suspended){
    	// 挂起--》激活
    	runtimeService.activateProcessInstanceById(id);
    	System.out.println("流程定义：" + id + "，已激活");
	}else{
    	// 激活--》挂起
    	runtimeService.suspendProcessInstanceById(id);
    	System.out.println("流程定义：" + id + "，已挂起");
	}
}

启动第二个流程实例后再查看相关的表结构时，对他们的关系理解会更加的清楚一些。

启动一个新的流程实例对应的就会产生两条记录。

IDENTITYLINK 中会记录每次流程操作的信息。

流程变量数据，即使 key 相同，但是属于不同的流程实例相互间也是隔离的。

回到目录…

2.4 完成流程

当我们把最后一个流程任务处理完成，该流程就结束了。

@Test
public void testCompeleteLastTask() {
	Task task = taskService.createTaskQuery()
    	.processDefinitionId("holiday:1:4")
    	.taskAssignee("lisi")
    	.singleResult();
	// 添加流程变量
	Map<String,Object> variables = new HashMap<>();
	variables.put("approved",false); // 拒绝请假
	// 完成任务
	taskService.complete(task.getId(),variables);
}

• 流程结束后，我们会发现以下四张表中对应的数据都没有了，也就是这个流程已经不是运行中的流程了。
  • ACT_RU_EXECUTION 运行时流程执行实例
  • ACT_RU_IDENTITYLINK 运行时用户关系信息
  • ACT_RU_TASK 运行时任务表
  • ACT_RU_VARIABLE 运行时变量表
• 然后在对应的历史表中我们可以看到相关的信息：
  • ACT_HI_ACTINST 历史的流程实例
  • ACT_HI_ATTACHMENT 历史的流程附件
  • ACT_HI_COMMENT 历史的说明性信息
  • ACT_HI_DETAIL 历史的流程运行中的细节信息
  • ACT_HI_IDENTITYLINK 历史的流程运行过程中用户关系
  • ACT_HI_PROCINST 历史的流程实例
  • ACT_HI_TASKINST 历史的任务实例
  • ACT_HI_VARINST 历史的流程运行中的变量信息

2.4.1 act_hi_actinst

历史的流程实例如下：

字段	名称	备注
ID_	主键
PROC_DEF_ID_	流程定义ID
PROC_INST_ID_	流程实例ID
EXECUTION_ID_	执行ID
ACT_ID_	节点实例ID
TASK_ID_	任务ID
CALL_PROC_INST_ID_	调用外部的流程实例ID
ACT_NAME_	节点名称
ACT_TYPE_	节点类型
ASSIGNEE_	处理人
START_TIME_	开始时间
END_TIME_	结束时间
DURATION_	耗时
DELETE_REASON_	删除原因
TENANT_ID_	租户编号

2.4.2 act_hi_identitylink

历史的流程运行过程中用户关系如下：

字段	名称	备注
ID_	主键
GROUP_ID_	组编号
TYPE_	类型
USER_ID_	用户编号
TASK_ID_	任务编号
CREATE_TIME_	创建时间
PROC_INST_ID_	流程实例编号
SCOPE_ID_
SCOPE_TYPE_
SCOPE_DEFINITION_ID_

2.4.3 act_hi_procinst

历史的流程实例如下：

字段	名称	备注
ID_	主键
PROC_INST_ID_	流程实例ID
BUSINESS_KEY_	业务主键
PROC_DEF_ID_	属性ID
START_TIME_	开始时间
END_TIME_	结束时间
DURATION_	耗时
START_USER_ID_	起始人
START_ACT_ID_	起始节点
END_ACT_ID_	结束节点
SUPER_PROCESS_INSTANCE_ID_	父流程实例ID
DELETE_REASON_	删除原因
TENANT_ID_	租户编号
NAME_	名称

2.4.4 act_hi_taskinst

历史的任务实例如下：

字段	名称	备注
ID_	主键
PROC_DEF_ID_	流程定义ID
TASK_DEF_KEY_	任务定义的ID值
PROC_INST_ID_	流程实例ID
EXECUTION_ID_	执行ID
PARENT_TASK_ID_	父任务ID
NAME_	名称
DESCRIPTION_	说明
OWNER_	实际签收人 任务的拥有者	签收人（默认为空，只有在委托时才有值）
ASSIGNEE_	被指派执行该任务的人
START_TIME_	开始时间
CLAIM_TIME_	任务拾取时间
END_TIME_	结束时间
DURATION_	耗时
DELETE_REASON_	删除原因
PRIORITY_	优先级别
DUE_DATE_	过期时间
FORM_KEY_	节点定义的formkey
CATEGORY_	类别
TENANT_ID_	租户

2.4.5 act_hi_varinst

历史的流程运行中的变量信息：流程变量虽然在任务完成后在流程实例表中会删除，但是在历史表中还是会记录的。

字段	名称	备注
ID_	主键
PROC_INST_ID_	流程实例ID
EXECUTION_ID_	指定ID
TASK_ID_	任务ID
NAME_	名称
VAR_TYPE_	参数类型
REV_	数据版本
BYTEARRAY_ID_	字节表ID
DOUBLE_	存储double类型数据
LONG_	存储long类型数据
…

回到目录…

---

总结:
提示：这里对文章进行总结：
本文是对Flowable的学习，对Flowable进行表结构分析，介绍了一个相对简单的流程处理涉及到的相关表结构内容。之后的学习内容将持续更新！！！