【Flowable】 6-核心流程操作的本质

Metadata

title: 【Flowable】 6-核心流程操作的本质
date: 2023-01-23 16:57
tags:
  - 行动阶段/完成
  - 主题场景/组件
  - 笔记空间/KnowladgeSpace/ProgramSpace/ModuleSpace
  - 细化主题/Module/Flowable
categories:
  - Flowable
keywords:
  - Flowable
description: 【Flowable】 6-核心流程操作的本质

1. 流程部署详解

1.1 部署实现

我们先来看下流程部署的具体过程。代码实现

@Test
public void test3(){
    ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
    RepositoryService repositoryService = processEngine.getRepositoryService();
    Deployment deploy = repositoryService.createDeployment()
            .addClasspathResource("holiday-request-new.bpmn20.xml")
            .name("请假流程...")
            .category("请假") 
            .tenantId("dpb") 
            .deploy();
    System.out.println("deploy.getId() = " + deploy.getId());
    System.out.println("deploy.getName() = " + deploy.getName());
    System.out.println("deploy.getCategory() = " + deploy.getCategory());
}

1.2 部署涉及表结构

涉及到的三张表：

部署资源表：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

部署 ID 表：act_re_deployment

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

流程表：act_re_procdef

字段	名称	备注
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

注意：

业务流程定义数据表。此表和 ACT_RE_DEPLOYMENT 是多对一的关系，即，一个部署的 bar 包里可能包含多个流程定义文件，每个流程定义文件都会有一条记录在 ACT_REPROCDEF 表内，每个流程定义的数据，都会对于 ACT_GE_BYTEARRAY 表内的一个资源文件和 PNG 图片文件。和 ACT_GE_BYTEARRAY 的关联是通过程序用 ACT_GE_BYTEARRAY.NAME 与 ACT_RE_PROCDEF.NAME_完成的

1.3 挂起和激活

部署的流程默认的状态为激活，如果我们暂时不想使用该定义的流程，那么可以挂起该流程。当然该流程定义下边所有的流程实例全部暂停。

流程定义为挂起状态，该流程定义将不允许启动新的流程实例，同时该流程定义下的所有的流程实例都将全部挂起暂停执行。

@Test
public void test05(){
    
    ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
    RepositoryService repositoryService = processEngine.getRepositoryService();
    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. 启动流程实例

然后我们来看看启动流程实例的过程。实现代码如下：

@Test
public void testRunProcess(){
    
    ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
    
    RuntimeService runtimeService = processEngine.getRuntimeService();
    
    Map<String,Object> variables = new HashMap<>();
    variables.put("employee","张三") ;
    variables.put("nrOfHolidays",3); 
    variables.put("description","工作累了，想出去玩玩"); 
    
    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 运行时变量表

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_

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

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_	拾取时间

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

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_	用户保存文本类型的参数值

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

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

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

3. 处理流程

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

ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
    TaskService taskService = processEngine.getTaskService();
    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 运行时变量表: 会记录新的流程变量

当然流程实例也可以挂起

ProcessEngine engine = ProcessEngines.getDefaultProcessEngine();

RuntimeService runtimeService = engine.getRuntimeService();

ProcessInstance processInstance = runtimeService.createProcessInstanceQuery()
.processInstanceId("25001")
.singleResult();

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 相同，但是属于不同的流程实例相互间也是隔离的

4. 完成一个流程

然后我们把第一个流程处理完成

ProcessEngine processEngine = cfg.buildProcessEngine();
TaskService taskService = processEngine.getTaskService();
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 历史的流程运行中的变量信息

在我们上面的处理流程的过程中设计到的历史表有

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_	租户编号

ACT_HI_IDENTITYLINK 历史的流程运行过程中用户关系

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

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_	名称

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_	租户

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 类型数据
…