【Flowable】 4-核心基础讲解
【Flowable】 4-核心基础讲解
Metadata
title: 【Flowable】 4-核心基础讲解
date: 2023-01-23 16:47
tags:
- 行动阶段/完成
- 主题场景/组件
- 笔记空间/KnowladgeSpace/ProgramSpace/ModuleSpace
- 细化主题/Module/Flowable
categories:
- Flowable
keywords:
- Flowable
description: 【Flowable】 4-核心基础讲解
1. 表结构讲解
工作流程的相关操作都是操作存储在对应的表结构中，为了能更好的弄清楚 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.ProcessEngine 讲解
2.1 硬编码的方式
我们前面讲解案例的时候是通过 ProcessEngineConfiguration 这个配置类来加载的。
// 配置数据库相关信息 获取 ProcessEngineConfiguration
ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()
.setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn2?serverTimezone=UTC&nullCatalogMeansCurrent=true")
.setJdbcUsername("root")
.setJdbcPassword("123456")
.setJdbcDriver("com.mysql.cj.jdbc.Driver")
.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);
// 获取流程引擎对象
ProcessEngine processEngine = cfg.buildProcessEngine();
这种方式会调用 buildProcessEngine() 方法，里面的核心代码为：
2.2 配置文件
除了上面的硬编码的方式外，我们还可以在 resources 目录下创建一个flowable.cfg.xml文件，注意这个名称是固定的哦。内容如下：
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="processEngineConfiguration"
class="org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration">
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/flow1?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC&nullCatalogMeansCurrent=true" /><property name="jdbcDriver" value="com.mysql.cj.jdbc.Driver" />
<property name="jdbcUsername" value="root" />
<property name="jdbcPassword" value="123456" />
<property name="databaseSchemaUpdate" value="true" />
<property name="asyncExecutorActivate" value="false" />
</bean>
</beans>
在上面的配置文件中配置相关的信息。我们在 Java 代码中就可以简化为：
@Test
public void test01(){
// 获取流程引擎对象
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
System.out.println("processEngine = " + processEngine);
}
可以看下 getDefaultProcessEngine 的源码，在里面最终还是执行了和硬编码一样的代码
public static ProcessEngine getProcessEngine(String processEngineName) {
if (!isInitialized()) {
init(); // 完成初始化操作
}
return processEngines.get(processEngineName);
}
进入 init 方法
public static synchronized void init() {
if (!isInitialized()) {
if (processEngines == null) {
// Create new map to store process-engines if current map is null
processEngines = new HashMap<>();
}
ClassLoader classLoader = ReflectUtil.getClassLoader();
Enumeration<URL> resources = null;
try {
resources = classLoader.getResources("flowable.cfg.xml"); // 加载flowable.cfg.xml配置文件
} catch (IOException e) {
throw new FlowableIllegalArgumentException("problem retrieving flowable.cfg.xml resources on the classpath: " + System.getProperty("java.class.path"), e);
}
// Remove duplicated configuration URL's using set. Some
// classloaders may return identical URL's twice, causing duplicate
// startups
Set<URL> configUrls = new HashSet<>();
while (resources.hasMoreElements()) {
configUrls.add(resources.nextElement());
}
for (Iterator<URL> iterator = configUrls.iterator(); iterator.hasNext();) {
URL resource = iterator.next();
LOGGER.info("Initializing process engine using configuration '{}'", resource.toString());
initProcessEngineFromResource(resource); // 初始化ProcessEngine
}
try {
resources = classLoader.getResources("flowable-context.xml"); // 在整合Spring的情况下加载该文件
} catch (IOException e) {
throw new FlowableIllegalArgumentException("problem retrieving flowable-context.xml resources on the classpath: " + System.getProperty("java.class.path"), e);
}
while (resources.hasMoreElements()) {
URL resource = resources.nextElement();
LOGGER.info("Initializing process engine using Spring configuration '{}'", resource.toString());
initProcessEngineFromSpringResource(resource); // 从Spring的资源文件中完成ProcessEngine的初始化
}
setInitialized(true);
} else {
LOGGER.info("Process engines already initialized");
}
}
在源码中提供了单独使用好整合 Spring 的配置加载方式。再进入到 initProcessEngineFromResource(resource) 方法中：
而且我们也可以看到 ProcessEngine 最终的实现是 ProcessEngineImpl 对象。
2.3 自定义配置文件
最后我们如果要加载自定义名称的配置文件可以通过 ProcessEngineConfiguration 中的对应构造方法来实现
@Test
public void test2() throws Exception{
ProcessEngineConfiguration configuration = ProcessEngineConfiguration
.createProcessEngineConfigurationFromResource("flowable.cfg.xml");
ProcessEngine processEngine = configuration.buildProcessEngine();
System.out.println("processEngine = " + processEngine);
}
3. Servcie 服务接口
Service 是工作流引擎提供用于进行工作流部署、执行、管理的服务接口，我们使用这些接口可以就是操作服务对应的数据表
3.1 Service 创建方式
通过 ProcessEngine 创建 Service
方式如下：
RuntimeService runtimeService = processEngine.getRuntimeService();
RepositoryService repositoryService = processEngine.getRepositoryService();
TaskService taskService = processEngine.getTaskService();
// ...
3.2 Service 总览
| Service | Descriptioin |
|---|---|
| RepositoryService | Flowable 的资源管理类 |
| RuntimeService | Flowable 的流程运行管理类 |
| TaskService | Flowable 的任务管理类 |
| HistoryService | Flowable 的历史管理类 |
| ManagerService | Flowable 的引擎管理类 |
简单介绍：
在ProcessEngines.getDefaultProcessEngine()第一次被调用时，将初始化并构建流程引擎，之后的重复调用都会返回同一个流程引擎。可以通过ProcessEngines.init()创建流程引擎，并由ProcessEngines.destroy()关闭流程引擎。
ProcessEngines 会扫描flowable.cfg.xml与flowable-context.xml文件。对于flowable.cfg.xml文件，流程引擎会以标准 Flowable 方式构建引擎：ProcessEngineConfiguration.createProcessEngineConfigurationFromInputStream(inputStream).buildProcessEngine()。对于flowable-context.xml文件，流程引擎会以 Spring 的方式构建：首先构建 Spring 应用上下文，然后从该上下文中获取流程引擎。
所有的服务都是无状态的。这意味着你可以很容易的在集群环境的多个节点上运行 Flowable，使用同一个数据库，而不用担心上一次调用实际在哪台机器上执行。不论在哪个节点执行，对任何服务的任何调用都是幂等（idempotent）的。
RepositoryService 很可能是使用 Flowable 引擎要用的第一个服务。这个服务提供了管理与控制部署(deployments)与流程定义(process definitions)的操作。在这里简单说明一下，流程定义是 BPMN 2.0 流程对应的 Java 对象，体现流程中每一步的结构与行为。部署是 Flowable 引擎中的包装单元，一个部署中可以包含多个 BPMN 2.0 XML 文件及其他资源。开发者可以决定在一个部署中包含的内容，可以是单个流程的 BPMN 2.0 XML 文件，也可以包含多个流程及其相关资源（如’hr-processes’部署可以包含所有与人力资源流程相关的的东西）。RepositoryService可用于部署这样的包。部署意味着将它上传至引擎，引擎将在储存至数据库之前检查与分析所有的流程。在部署操作后，可以在系统中使用这个部署包，部署包中的所有流程都可以启动。
此外，这个服务还可以：
- 查询引擎现有的部署与流程定义。
- 暂停或激活部署中的某些流程，或整个部署。暂停意味着不能再对它进行操作，激活刚好相反，重新使它可以操作。
- 获取各种资源，比如部署中保存的文件，或者引擎自动生成的流程图。
- 获取 POJO 版本的流程定义。它可以用 Java 而不是 XML 的方式查看流程。
与提供静态信息（也就是不会改变，至少不会经常改变的信息）的RepositoryService相反，RuntimeService 用于启动流程定义的新流程实例。前面介绍过，流程定义中定义了流程中不同步骤的结构与行为。流程实例则是流程定义的实际执行过程。同一时刻，一个流程定义通常有多个运行中的实例。RuntimeService也用于读取与存储流程变量。流程变量是流程实例中的数据，可以在流程的许多地方使用（例如排他网关经常使用流程变量判断流程下一步要走的路径）。RuntimeService还可以用于查询流程实例与执行 (Execution)。执行也就是 BPMN 2.0 中 'token' 的概念。通常执行是指向流程实例当前位置的指针。最后，还可以在流程实例等待外部触发时使用RuntimeService，使流程可以继续运行。流程有许多等待状态(wait states)，RuntimeService服务提供了许多操作用于 “通知” 流程实例：已经接收到外部触发，流程实例可以继续运行。
对于像 Flowable 这样的 BPM 引擎来说，核心是需要用户操作的任务。所有任务相关的东西都组织在 TaskService 中，例如：
- 查询分派给用户或组的任务
- 创建 * 独立运行 (standalone)* 任务。这是一种没有关联到流程实例的任务。
- 决定任务的执行用户 (assignee)，或者将用户通过某种方式与任务关联。
- 认领 (claim) 与完成 (complete) 任务。认领是指某人决定成为任务的执行用户，也即他将会完成这个任务。完成任务是指“做这个任务要求的工作”，通常是填写某个表单。
IdentityService 很简单。它用于管理（创建，更新，删除，查询……）组与用户。请注意，Flowable 实际上在运行时并不做任何用户检查。例如任务可以分派给任何用户，而引擎并不会验证系统中是否存在该用户。这是因为 Flowable 有时要与 LDAP、Active Directory 等服务结合使用。
FormService 是可选服务。也就是说 Flowable 没有它也能很好地运行，而不必牺牲任何功能。这个服务引入了_开始表单 (start form) 与任务表单 (task form) 的概念。 开始表单是在流程实例启动前显示的表单，而任务表单_是用户完成任务时显示的表单。Flowable 可以在 BPMN 2.0 流程定义中定义这些表单。表单服务通过简单的方式暴露这些数据。再次重申，表单不一定要嵌入流程定义，因此这个服务是可选的。
HistoryService 暴露 Flowable 引擎收集的所有历史数据。当执行流程时，引擎会保存许多数据（可配置），例如流程实例启动时间、谁在执行哪个任务、完成任务花费的事件、每个流程实例的执行路径，等等。这个服务主要提供查询这些数据的能力。
ManagementService 通常在用 Flowable 编写用户应用时不需要使用。它可以读取数据库表与表原始数据的信息，也提供了对作业 (job) 的查询与管理操作。Flowable 中很多地方都使用作业，例如定时器 (timer)，异步操作(asynchronous continuation)，延时暂停 / 激活(delayed suspension/activation) 等等。后续会详细介绍这些内容。
DynamicBpmnService 可用于修改流程定义中的部分内容，而不需要重新部署它。例如可以修改流程定义中一个用户任务的办理人设置，或者修改一个服务任务中的类名。
wechat
alipay
)