Flowable学习笔记（一、入门）

2401_86963620

于 2024-09-05 00:37:17 发布

阅读量1.2k

点赞数 17

文章标签：学习笔记 android

本文链接：https://blog.csdn.net/2401_86963620/article/details/141907563

版权

二、开始

======================================================================

1、构建命令行程序

我们将构建的例子是一个简单的请假(holiday request)流程：

雇员(employee)申请几天的假期
经理(manager)批准或驳回申请
我们会模拟将申请注册到某个外部系统，并给雇员发送结果邮件

1.1、创建流程引擎

1.1.1、创建maven项目

创建一个名为holiday-request的maven项目，添加依赖：

org.flowable

flowable-engine

6.3.0

mysql

mysql-connector-java

8.0.15

1.1.2、创建数据库表格

创建一个数据库flowable_demo。
创建一个普通的Java类：HolidayRequest

/**

@Author 三分恶
@Date 2020/5/2
@Description 创建表格

public class HolidayRequest {

public static void main(String[] args) {

//1、创建ProcessEngineConfiguration实例,该实例可以配置与调整流程引擎的设置

ProcessEngineConfiguration cfg=new StandaloneProcessEngineConfiguration()

//2、通常采用xml配置文件创建ProcessEngineConfiguration，这里直接采用代码的方式

//3、配置数据库相关参数

.setJdbcUrl(“jdbc:mysql://localhost:3306/flowable_demo?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2b8&nullCatalogMeansCurrent=true”)

.setJdbcUsername(“root”)

.setJdbcPassword(“root”)

.setJdbcDriver(“com.mysql.jdbc.Driver”)

.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);

//4、初始化ProcessEngine流程引擎实例

ProcessEngine processEngine=cfg.buildProcessEngine();

}

1.1.3、运行

运行该类，会发现在数据库flowable_demo中创建了34个表：

在这里插入图片描述

1.1.4、创建的表格说明

flowable命名规则：

ACT_RE_* ：’ RE ’表示repository（存储）。RepositoryService接口操作的表。带此前缀的表包含的是静态信息，如，流程定义，流程的资源（图片，规则等）。
ACT_RU_* ：’ RU ’表示runtime。这是运行时的表存储着流程变量，用户任务，变量，职责（job）等运行时的数据。flowable只存储实例执行期间的运行时数据，当流程实例结束时，将删除这些记录。这就保证了这些运行时的表小且快。
ACT_ID_* : ’ ID ’表示identity(组织机构)。这些表包含标识的信息，如用户，用户组，等等。
ACT_HI_* : ’ HI ’表示history。就是这些表包含着历史的相关数据，如结束的流程实例，变量，任务，等等。
ACT_GE_* : 普通数据，各种情况都使用的数据。

34张表说明：

| 表分类 | 表名 | 表说明 |

| — | — | — |

| 一般数据(2) | ACT_GE_BYTEARRAY | 通用的流程定义和流程资源 |

| ACT_GE_PROPERTY | 系统相关属性 |

| 流程历史记录(8) | ACT_HI_ACTINST | 历史的流程实例 |

| ACT_HI_ATTACHMENT | 历史的流程附件 |

| ACT_HI_COMMENT | 历史的说明性信息 |

| ACT_HI_DETAIL | 历史的流程运行中的细节信息 |

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

| ACT_HI_PROCINST | 历史的流程实例 |

| ACT_HI_TASKINST | 历史的任务实例 |

| ACT_HI_VARINST | 历史的流程运行中的变量信息 |

| 用户用户组表(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) | ACT_RE_DEPLOYMENT | 部署单元信息 |

| ACT_RE_MODEL | 模型信息 |

| ACT_RE_PROCDEF | 已部署的流程定义 |

| 运行实例表(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 | 运行时变量表 |

| 其他表(2) | ACT_EVT_LOG | 事件日志表 |

| ACT_PROCDEF_INFO | 流程定义信息 |

1.1.4、日志配置

在上面的运行中，同时可以看到，控制台有报错的信息，这是日志没有正确地配置：

在这里插入图片描述

Flowable使用SLF4J作为内部日志框架。我们使用log4j作为SLF4J的实现。因此在pom.xml文件中添加下列依赖：

org.slf4j

slf4j-api

1.7.21

org.slf4j

slf4j-log4j12

1.7.21

在 src/resouce目录下新建log4j的配置文件log4j.properties:

log4j.rootLogger=DEBUG, CA

log4j.appender.CA=org.apache.log4j.ConsoleAppender

log4j.appender.CA.layout=org.apache.log4j.PatternLayout

log4j.appender.CA.layout.ConversionPattern= %d{hh:mm:ss,SSS} [%t] %-5p %c %x - %m%n

再次运行，可以看到关于引擎启动与创建数据库表结构的提示日志：

在这里插入图片描述

1.2、部署流程定义

要构建的流程是一个非常简单的请假流程。Flowable引擎需要流程定义为BPMN 2.0格式，这是一个业界广泛接受的XML标准。

在Flowable术语中，我们将其称为一个流程定义(process definition)。一个流程定义可以启动多个流程实例(process instance)。流程定义可以看做是重复执行流程的蓝图。在这个例子中，流程定义定义了请假的各个步骤，而一个流程实例对应某个雇员提出的一个请假申请。

BPMN 2.0存储为XML，并包含可视化的部分：使用标准方式定义了每个步骤类型（人工任务，自动服务调用，等等）如何呈现，以及如何互相连接。这样BPMN 2.0标准使技术人员与业务人员能用双方都能理解的方式交流业务流程。

我们要使用的流程定义为：

在这里插入图片描述

流程定义的说明：

我们假定启动流程需要提供一些信息，例如雇员名字、请假时长以及说明。当然，这些可以单独建模为流程中的第一步。但是如果将它们作为流程的“输入信息”，就能保证只有在实际请求时才会建立一个流程实例。否则（将提交作为流程的第一步），用户可能在提交之前改变主意并取消，但流程实例已经创建了。在某些场景中，就可能影响重要的指标（例如启动了多少申请，但还未完成），取决于业务目标。
左侧的圆圈叫做启动事件(start event)。这是一个流程实例的起点。
第一个矩形是一个用户任务(user task)。这是流程中人类用户操作的步骤。在这个例子中，经理需要批准或驳回申请。
取决于经理的决定，排他网关(exclusive gateway) (带叉的菱形)会将流程实例路由至批准或驳回路径。
如果批准，则需要将申请注册至某个外部系统，并跟着另一个用户任务，将经理的决定通知给申请人。当然也可以改为发送邮件。
如果驳回，则为雇员发送一封邮件通知他。

一般来说，这样的流程定义使用可视化建模工具建立，如Flowable Designer(Eclipse)或Flowable Web Modeler(Web应用)。

这里我们直接撰写XML，以熟悉BPMN 2.0及其概念。

以下是与上面展示的流程图对应的BPMN 2.0 XML。这里只包含了“流程部分”。如果使用图形化建模工具，实际的XML文件还将包含“可视化部分”，用于描述图形信息，如流程定义中各个元素的坐标（所有的图形化信息包含在XML的BPMNDiagram标签中，作为definitions标签的子元素）。

在src/main/resources文件夹下创建为holiday-request.bpmn20.xml文件：

<?xml version="1.0" encoding="utf-8" ?>

<definitions xmlns=“http://www.omg.org/spec/BPMN/20100524/MODEL”

xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance”

xmlns:xsd=“http://www.w3.org/2001/XMLSchema”

xmlns:bpmndi=“http://www.omg.org/spec/BPMN/20100524/DI”

xmlns:omgdc=“http://www.omg.org/spec/DD/20100524/DC”

xmlns:omgdi=“http://www.omg.org/spec/DD/20100524/DI”

xmlns:flowable=“http://flowable.org/bpmn”

typeLanguage=“http://www.w3.org/2001/XMLSchema”

expressionLanguage=“http://www.w3.org/1999/XPath”

targetNamespace=“http://www.flowable.org/processdef”>

<![CDATA[ ${approved} ]]> <![CDATA[ ${!approved} ]]>

每一个步骤（在BPMN 2.0术语中称作活动(activity)）都有一个id属性，为其提供一个在XML文件中唯一的标识符。所有的活动都可以设置一个名字，以提高流程图的可读性。
活动之间通过**顺序流(sequence flow)**连接，在流程图中是一个有向箭头。在执行流程实例时，执行(execution)会从启动事件沿着顺序流流向下一个活动。
离开**排他网关(带有X的菱形)**的顺序流很特别：都以表达式(expression)的形式定义了条件(condition) 。当流程实例的执行到达这个网关时，会计算条件，并使用第一个计算为true的顺序流。这就是排他的含义：**只选择一个。**当然如果需要不同的路由策略，可以使用其他类型的网关。
这里用作条件的表达式为 ${approved}，这是$ {approved == true}的简写。变量’approved’被称作流程变量(process variable)。流程变量是持久化的数据，与流程实例存储在一起，并可以在流程实例的生命周期中使用。在这个例子里，我们需要在特定的地方（当经理用户任务提交时，或者以Flowable的术语来说，完成(complete)时）设置这个流程变量，因为这不是流程实例启动时就能获取的数据。

现在我们已经有了流程BPMN 2.0 XML文件，下来需要将它部署(deploy)到引擎中。部署一个流程定义意味着：

流程引擎会将XML文件存储在数据库中，这样可以在需要的时候获取它。
流程定义转换为内部的、可执行的对象模型，这样使用它就可以启动流程实例。

将流程定义部署至Flowable引擎，需要使用RepositoryService，其可以从ProcessEngine对象获取。使用RepositoryService，可以通过XML文件的路径创建一个新的部署(Deployment)，并调用deploy()方法实际执行：

//创建RepositoryService实例

RepositoryService repositoryService=processEngine.getRepositoryService();

//加载流程

Deployment deployment=repositoryService.createDeployment()

.addClasspathResource(“holiday-request.bpmn20.xml”)

.deploy();

我们现在可以通过API查询验证已经部署在引擎中的流程定义。通过RepositoryService创建的ProcessDefinitionQuery对象实现。

//查询流程定义

ProcessDefinition processDefinition=repositoryService.createProcessDefinitionQuery()

.deploymentId(deployment.getId())

.singleResult();

System.out.println("Found process definition : "+processDefinition.getName());

运行:

在这里插入图片描述

xml文件已经存储进了数据库：

在这里插入图片描述

1.3、启动流程实例

现在已经在流程引擎中部署了流程定义，因此可以使用这个流程定义作为“蓝图”启动流程实例。

要启动流程实例，需要提供一些初始化流程变量。一般来说，可以通过呈现给用户的表单，或者在流程由其他系统自动触发时通过REST API，来获取这些变量。在这个例子里，我们简化为使用java.util.Scanner类在命令行输入一些数据：

//1、获取流程初始化变量

Scanner scanner = new Scanner(System.in);

System.out.println(“Who are you?”);

String employee = scanner.nextLine();

System.out.println(“How many holidays do you want to request?”);

Integer nrOfHolidays = Integer.valueOf(scanner.nextLine());

System.out.println(“Why do you need them?”);

String description = scanner.nextLine();

接下来，我们使用RuntimeService启动一个流程实例。收集的数据作为一个java.util.Map实例传递，其中的键就是之后用于获取变量的标识符。这个流程实例使用key启动(还有其它方式)。这个key就是BPMN 2.0 XML文件中设置的id属性，在这个例子里是holiday-request。

//2、使用RuntimeService启动一个流程实例

RuntimeService runtimeService=processEngine.getRuntimeService();

Map<String, Object> variables = new HashMap<String, Object>();

variables.put(“employee”, employee);

variables.put(“nrOfHolidays”, nrOfHolidays);

variables.put(“description”, description);

ProcessInstance processInstance=runtimeService.startProcessInstanceByKey(“holiday-request”,variables);

在流程实例启动后，会创建一个执行(execution)，并将其放在启动事件上。从这里开始，这个执行会沿着顺序流移动到经理审批的用户任务，并执行用户任务行为。这个行为将在数据库中创建一个任务，该任务可以之后使用查询找到。用户任务是一个等待状态(wait state)，引擎会停止执行，返回API调用处。

输入流程初始化变量：

在这里插入图片描述