【Flowable】基本操作

Metadata

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

【Flowable】基本操作

1.创建ProcessEngine

创建一个基本的maven工程，可以是Eclipse也可以是其他IDEA。然后添加两个依赖

Flowable流程引擎。使我们可以创建一个ProcessEngine流程引擎对象，并访问Flowable API。
一个是MySQL的数据库驱动

在pom.xml文件中添加下列行：

<dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-engine</artifactId>
    <version>6.3.0</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.21</version>
</dependency>

然后创建一个普通的Java类，添加对应的main方法，首先要做的是初始化ProcessEngine流程引擎实例。这是一个线程安全的对象，因此通常只需要在一个应用中初始化一次。 ProcessEngine由ProcessEngineConfiguration实例创建。该实例可以配置与调整流程引擎的设置。通常使用一个配置XML文件创建ProcessEngineConfiguration，但是（像在这里做的一样）也可以编程方式创建它。 ProcessEngineConfiguration所需的最小配置，是数据库JDBC连接：

public static void main(String[] args) {
    ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()
        .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn?serverTimezone=UTC")
        .setJdbcUsername("root")
        .setJdbcPassword("123456")
        .setJdbcDriver("com.mysql.cj.jdbc.Driver")
        .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);
    ProcessEngine processEngine = cfg.buildProcessEngine();
}

注意在mysql8.0中执行可能出现如下的错误

出现这种情况只需要在 mysql 的连接字符串中添加上 nullCatalogMeansCurrent=true，设置为只查当前连接的 schema 库即可。

public static void main(String[] args) {
    ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()
            .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn1?serverTimezone=UTC&nullCatalogMeansCurrent=true")
            .setJdbcUsername("root")
            .setJdbcPassword("123456")
            .setJdbcDriver("com.mysql.cj.jdbc.Driver")
            .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);
    ProcessEngine processEngine = cfg.buildProcessEngine();
}

同时可以看到创建了相关的表结构在数据库中

这样就得到了一个启动可用的流程引擎。接下来为它提供一个流程！

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 标签的子元素）。

将下面的 XML 保存在 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">

<process name="Holiday Request" isExecutable="true">

    <startEvent/>
    <sequenceFlow sourceRef="startEvent" targetRef="approveTask"/>

    <userTask name="Approve or reject request"/>
    <sequenceFlow sourceRef="approveTask" targetRef="decision"/>

    <exclusiveGateway/>
    <sequenceFlow sourceRef="decision" targetRef="externalSystemCall">
        <conditionExpression xsi:type="tFormalExpression">
            <![CDATA[
      ${approved}
    ]]>
        </conditionExpression>
    </sequenceFlow>
    <sequenceFlow  sourceRef="decision" targetRef="sendRejectionMail">
        <conditionExpression xsi:type="tFormalExpression">
            <![CDATA[
      ${!approved}
    ]]>
        </conditionExpression>
    </sequenceFlow>

    <serviceTask name="Enter holidays in external system"
                 flowable:class="org.flowable.CallExternalSystemDelegate"/>
    <sequenceFlow sourceRef="externalSystemCall" targetRef="holidayApprovedTask"/>

    <userTask name="Holiday approved"/>
    <sequenceFlow sourceRef="holidayApprovedTask" targetRef="approveEnd"/>

    <serviceTask name="Send out rejection email"
                 flowable:class="org.flowable.SendRejectionMail"/>
    <sequenceFlow sourceRef="sendRejectionMail" targetRef="rejectEnd"/>

    <endEvent/>

    <endEvent/>
</process>

</definitions>

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

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

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

@Test
public void testDeploy(){
    
    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();
    
    RepositoryService repositoryService = processEngine.getRepositoryService();
    Deployment deployment = repositoryService.createDeployment()
            .addClasspathResource("holiday-request.bpmn20.xml") 
            .name("请求流程") 
            .deploy(); 
    System.out.println("deployment.getId() = " + deployment.getId());
    System.out.println("deployment.getName() = " + deployment.getName());

}

然后执行该方法日志操作成功：

在后台表结构也可以看到相关的信息

act_re_deployment: 流程定义部署表，每部署一次就增加一条记录

act_re_procdef ：流程定义表，部署每个新的流程定义都会在这张表中增加一条记录

act_ge_bytearray ：流程资源表，流程部署的 bpmn 文件和 png 图片会保存在该表中

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

@Test
public void testDeployQuery(){
    
    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();
    
    RepositoryService repositoryService = processEngine.getRepositoryService();
    
    ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
            .deploymentId("2501")
            .singleResult();
    System.out.println("processDefinition.getId() = " + processDefinition.getId());
    System.out.println("processDefinition.getName() = " + processDefinition.getName());
    System.out.println("processDefinition.getDeploymentId() = " + processDefinition.getDeploymentId());
    System.out.println("processDefinition.getDescription() = " + processDefinition.getDescription());

}

输出结果为：

processDefinition.getId() = holidayRequest:2:2503
processDefinition.getName() = Holiday Request
processDefinition.getDeploymentId() = 2501
processDefinition.getDescription() = null

3. 启动流程实例

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

要启动流程实例，需要提供一些初始化_流程变量_。一般来说，可以通过呈现给用户的表单，或者在流程由其他系统自动触发时通过 REST API，来获取这些变量。在这个例子里，我们简化直接在代码中定义了，我们使用 RuntimeService 启动一个 流程实例 。

@Test
public void testRunProcess(){
    
    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();
    
    RuntimeService runtimeService = processEngine.getRuntimeService();
    
    Map<String,Object> variables = new HashMap<>();
    variables.put("employee","张三") ;
    variables.put("nrOfHolidays",3); 
    variables.put("description","工作累了，想出去玩玩"); 
    
    ProcessInstance processInstance = runtimeService
            .startProcessInstanceByKey("holidayRequest", variables);
    
    System.out.println("流程定义的ID：" + processInstance.getProcessDefinitionId());
    System.out.println("流程实例的ID：" + processInstance.getId());
    System.out.println("当前活动的ID：" + processInstance.getActivityId());
}

启动成功，输出结果如下：

流程定义的ID：holidayRequest:2:2503
流程实例的ID：5001
当前活动的ID：null

对应的流程实例 ID 为：5001

启动流程实例涉及到的表结构：

act_hi_actinst 流程实例执行历史
act_hi_identitylink 流程的参与用户的历史信息
act_hi_procinst 流程实例历史信息
act_hi_taskinst 流程任务历史信息
act_ru_execution 流程执行信息
act_ru_identitylink 流程的参与用户信息
act_ru_task 任务信息

4. 查看任务

上面员工发起了一个请假流程，接下来就会流转到总经理这儿来处理，之前我们没有指定经理这的处理人，我们可以加一个

然后我们来查看下 lisi 的任务

@Test
public void testQueryTask(){
    
    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();
    TaskService taskService = processEngine.getTaskService();
    List<Task> list = taskService.createTaskQuery()
            .processDefinitionKey("holidayRequestNew")
            .taskAssignee("lisi")
            .list();
    for (Task task : list) {
        System.out.println("task.getProcessDefinitionId() = " + task.getProcessDefinitionId());
        System.out.println("task.getId() = " + task.getId());
        System.out.println("task.getAssignee() = " + task.getAssignee());
        System.out.println("task.getName() = " + task.getName());
    }
}

输出结果为：

task.getProcessDefinitionId() = holidayRequestNew:1:10003
task.getId() = 12508
task.getAssignee() = lisi
task.getName() = Approve or reject request

5. 完成任务

现在李四这个角色可以来完成当前的任务了

在此处我们直接解决掉这个请假，然后会走发送拒绝邮件的流程，这块我们需要用到 JavaDelegate 来触发。

我们定义这样一个 Java 类

public class SendRejectionMail implements JavaDelegate {

    @Override
    public void execute(DelegateExecution delegateExecution) {
        System.out.println("请假被拒绝,,,安心工作吧");
    }
}

然后来完成任务

@Test
public void testCompleteTask(){
    
    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();
    TaskService taskService = processEngine.getTaskService();
    Task task = taskService.createTaskQuery()
            .processDefinitionKey("holidayRequestNew")
            .taskAssignee("lisi")
            .singleResult();
    
    Map<String,Object> variables = new HashMap<>();
    variables.put("approved",false); 
    
    taskService.complete(task.getId(),variables);
}

然后可以看到 JavaDelegate 触发了

6. 流程的删除

有些流程已经没有用了，我们需要删除掉，其实也非常简单

@Test
public void testDeleteProcess(){
    
    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();
    RepositoryService repositoryService = processEngine.getRepositoryService();
repositoryService.deleteDeployment("2501",true);

}

7. 查看历史信息

选择使用 Flowable 这样的流程引擎的原因之一，是它可以自动存储所有流程实例的审计数据或历史数据。这些数据可以用于创建报告，深入展现组织运行的情况，瓶颈在哪里，等等。

例如，如果希望显示流程实例已经执行的时间，就可以从 ProcessEngine 获取 _HistoryService_，并创建 * 历史活动 (historical activities)* 的查询。在下面的代码片段中，可以看到我们添加了一些额外的过滤条件：

只选择一个特定流程实例的活动
只选择已完成的活动

结果按照结束时间排序，代表其执行顺序。

@Test
public void testQueryHistory(){
    
    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();
    HistoryService historyService = processEngine.getHistoryService();
    List<HistoricActivityInstance> list = historyService.createHistoricActivityInstanceQuery()
            .processDefinitionId("holidayRequestNew:1:10003")
            .finished()
            .orderByHistoricActivityInstanceEndTime().asc()
            .list();
    for (HistoricActivityInstance historicActivityInstance : list) {
        System.out.println(historicActivityInstance.getActivityId() + " took "
                + historicActivityInstance.getDurationInMillis() + " milliseconds");
    }

}

输出结果

startEvent took 1 milliseconds
approveTask took 837735 milliseconds
decision took 13 milliseconds
sendRejectionMail took 2 milliseconds
rejectEnd took 1 milliseconds

好了~ flowable 的基本应用我们就先介绍到这里了。

【Flowable】 基本操作

Metadata

【Flowable】 基本操作

1.创建ProcessEngine

2. 部署流程定义

3. 启动流程实例

4. 查看任务

5. 完成任务

6. 流程的删除

7. 查看历史信息

【Flowable】基本操作

【Flowable】基本操作