FlowableBPMN用户手册中文版(v6.3.0).pdf_camunda中文文档

5星 · 超过95%的资源需积分: 49 2.2k 浏览量更新于2023-05-22 评论收藏 10.58MB PDF 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

资源详情

资源评论

资源推荐

1. 简简介介
1.1. 协议协议
Flowable在Apache V2 协议下发布。
1.2. 下下载载
http://www.flowable.org/downloads.html
1.3. 源源码码
Flowable的发布包里包含了大部分源码，以JAR文件方式提供。Flowable的源码也可以通过以下链接获得： https://github.com/flowable/flowable-engine
1.4. 必要的必要的软软件件
1.4.1. JDK 8+
运行Flowable需要JDK 8或以上版本。可以访问 Oracle Java SE downloads页面 点击“Download JDK”按钮获取。该页面上也有安装指导。安装完成后，可以执行 java -
version 。能看到JDK的版本信息就说明安装成功了。
1.4.2. IDE
可以自行选择用于Flowable开发的IDE。如果想要使用Flowable Designer，则需要Eclipse Mars或Neon。 到 Eclipse下载页面选择Eclipse版本并下载。解压下载的文件， 然
后执行eclipse文件夹下的eclipse文件。手册后续有专门一章介绍如何安装我们的Eclipse Designer插件。
1.5. 反反馈问题馈问题
我们希望开发者在报告或提问之前，先看看提问的智慧。
看完提问的智慧，你可以在用户论坛提问、评论以及提交改进建议，也可以在我们的Github问题跟踪系统创建bug报告。
1.6. 实验实验性功能性功能
标记有[实验实验性性]的章节介绍的功能还不够稳定。
.impl.包下的类都是内部实现类，不保证稳定。但是，在用户手册中作为配置参数介绍的类则是被官方支持的，可以保证稳定。
1.7. 内内部部实现类实现类
在JAR文件中，所有.impl.包下的类（比如org.flowable.engine.impl.db）都是实现类，只应在内部使用。实现类中的所有类或接口都不保证稳定。
1.8. 版本策略版本策略
使用三个整数的形式标记版本：MAJOR.MINOR.MICRO。其中 MAJOR版本代表核心引擎的演进。MINOR版本代表新功能与新API。MICRO版本代表bug修复与改进。
总的来说，Flowable希望在MINOR与MICRO版本中，对所有非内部实现类保持“源代码兼容性”，即应用可以正确构建，且不改变语义。Flowable也希望在MINOR与MICRO版
本中，保持“二进制兼容性”，即用新版本的Flowable直接替换老版本的Jar文件，仍然可以正常工作。
如果在MINOR版本中修改了API，将保留原有版本，并使用@Deprecated注解。这种废弃的API将在两个MINOR版本之后移除。
1.9. 翻翻译说译说明明
由 TKJohn 根据 官方userguide源码 翻译至简体中文，工程发布于 GitHub ，任何意见建议欢迎提issue。
页面发布链接为 https://tkjohn.github.io/
2. 开开始始
2.1. Flowable是什么？是什么？
Flowable是一个使用Java编写的轻量级业务流程引擎。Flowable流程引擎可用于部署BPMN 2.0流程定义（用于定义流程的行业XML标准）， 创建这些流程定义的流程实例，
进行查询，访问运行中或历史的流程实例与相关数据，等等。这个章节将用一个可以在你自己的开发环境中使用的例子，逐步介绍各种概念与API。
Flowable可以十分灵活地加入你的应用/服务/构架。可以将JAR形式发布的Flowable库加入应用或服务，来
嵌入
引擎。 以JAR形式发布使Flowable可以轻易加入任何Java环
境：Java SE；Tomcat、Jetty或Spring之类的servlet容器；JBoss或WebSphere之类的Java EE服务器，等等。 另外，也可以使用Flowable REST API进行HTTP调用。也有许
多Flowable应用（Flowable Modeler, Flowable Admin, Flowable IDM 与 Flowable Task），提供了直接可用的UI示例，可以使用流程与任务。
所有使用Flowable方法的共同点是核心引擎。核心引擎是一组服务的集合，并提供管理与执行业务流程的API。 下面的教程从设置与使用核心引擎的介绍开始。后续章节都建
立在之前章节中获取的知识之上。
第一节展示了以最简单的方式运行Flowable的方法：只使用Java SE的标准Java main方法。这里也会介绍许多核心概念与API。
Flowable REST API章节展示了如何通过REST运行及使用相同的API。
Flowable APP章节将介绍直接可用的Flowable UI示例的基本方法。
2.2. Flowable与与Activiti
Flowable是Activiti(Alfresco持有的注册商标)的fork。在下面的章节中，你会注意到包名，配置文件等等，都使用flowable。
2.3. 构建命令行程序构建命令行程序
2.3.1. 创创建流程引擎建流程引擎
在这个初步教程中，将构建一个简单的例子，以展示如何创建一个Flowable流程引擎，介绍一些核心概念，并展示如何使用API。 截图时使用的是Eclipse，但实际上可以使用
任何IDE。我们使用Maven获取Flowable依赖及管理构建，但是类似的任何其它方法也都可以使用（Gradle，Ivy，等等）。
我们将构建的例子是一个简单的
请假
(holiday request)流程：
雇员
(employee)申请几天的假期
经理
(manager)批准或驳回申请
我们会模拟将申请注册到某个外部系统，并给雇员发送结果邮件
首先，通过File → New → Other → Maven Project创建一个新的Maven项目

在下一界面中，选中'create a simple project (skip archetype selection)'

填入'Group Id'与'Artifact id':

这样就建立了空的Maven项目，然后添加两个依赖：

Flowable流程引擎。使我们可以创建一个ProcessEngine流程引擎对象，并访问Flowable API。

一个内存数据库。本例中为H2，因为Flowable引擎在运行流程实例时，需要使用数据库来存储执行与历史数据。请注意H2依赖包含了数据库

及

驱动。如果使用其他数据

库（例如PostgreSQL，MySQL等），需要添加对应的数据库驱动依赖。

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

<groupId>org.flowable</groupId>

<artifactId>flowable-engine</artifactId>

</dependency>

<groupId>com.h2database</groupId>

</dependency>

</dependencies>

如果由于某些原因，依赖JAR无法自动获取，可以右键点击项目，并选择'Maven → Update Project'以强制手动刷新（一般不会需要这么操作）。在这个项目中的'Maven

Dependencies'下，可以看到flowable-engine与许多其他（传递的）依赖。

创建一个新的Java类，并添加标准的Java main方法：

package org.flowable;

public class HolidayRequest {

public static void main(String[] args) {

}

首先要做的是初始化ProcessEngine流程引擎实例。这是一个线程安全的对象，因此通常只需要在一个应用中初始化一次。

ProcessEngine由ProcessEngineConfiguration实例创建。该实例可以配置与调整流程引擎的设置。通常使用一个配置XML文件创建ProcessEngineConfiguration，但是

（像在这里做的一样）也可以编程方式创建它。 ProcessEngineConfiguration所需的最小配置，是数据库JDBC连接：

package org.flowable;

import org.flowable.engine.ProcessEngine;

import org.flowable.engine.ProcessEngineConfiguration;

import org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration;

public class HolidayRequest {

public static void main(String[] args) {

ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()

.setJdbcUrl("jdbc:h2:mem:flowable;DB_CLOSE_DELAY=-1")

.setJdbcUsername("sa")

.setJdbcPassword("")

.setJdbcDriver("org.h2.Driver")

.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);

ProcessEngine processEngine = cfg.buildProcessEngine();

}

在上面的代码中，第10行创建了一个

独立

(standalone)配置对象。这里的'

独立

'指的是引擎是完全独立创建及使用的（而不是在Spring环境中使用，这时需要使

用SpringProcessEngineConfiguration类代替）。第11至14行中，传递了一个内存H2数据库实例的JDBC连接参数。重要：请注意这样的数据库在JVM重启后会消失。如果需

要永久保存数据，需要切换为持久化数据库，并相应切换连接参数。第15行中，设置了true，确保在JDBC参数连接的数据库中，数据库表结构不存在时，会创建相应的表结

构。另外，Flowable也提供了一组SQL文件，可用于手动创建所有表的数据库表结构。

然后使用这个配置创建ProcessEngine对象（第17行）。

这样就可以运行了。在Eclipse中最简单的方法是右键点击类文件，选择Run As → Java Application ：

应用运行没有问题，但也没有在控制台提供有用的信息，只有一条消息提示日志没有正确配置：

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

</dependency>

</dependency>

Log4j需要一个配置文件。在src/main/resources文件夹下添加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

重新运行应用。应该可以看到关于引擎启动与创建数据库表结构的提示日志：

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

2.3.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">

<![CDATA[

${approved}

]]>

</conditionExpression>

</sequenceFlow>

<![CDATA[

${!approved}

]]>

</conditionExpression>

</sequenceFlow>

<serviceTask id="externalSystemCall" name="Enter holidays in external system"

flowable:class="org.flowable.CallExternalSystemDelegate"/>

<serviceTask id="sendRejectionMail" name="Send out rejection email"

flowable:class="org.flowable.SendRejectionMail"/>

</process>

</definitions>

第2至11行看起来挺吓人，但其实在大多数的流程定义中都是一样的。这是一种

样板文件

，需要与BPMN 2.0标准规范完全一致。

每一个步骤（在BPMN 2.0术语中称作

活活动动

(activity)）都有一个id属性，为其提供一个在XML文件中唯一的标识符。所有的

活动

都可以设置一个名字，以提高流程图的可读性。

活动

之间通过顺顺序流序流(sequence flow)连接，在流程图中是一个有向箭头。在执行流程实例时，执行(execution)会从

启动事件

沿着

顺序流

流向下一个

活动

。

离开

排他网关

(

带有

的菱形

)的

顺序流

很特别：都以

表达式

(expression)的形式定义了

条件

(condition) （见第25至32行）。当流程实例的执行到达这个

网关

时，会计算

条件

，并

使用第一个计算为true的顺序流。这就是

排他

的含义：只选择一个。当然如果需要不同的路由策略，可以使用其他类型的网关。

这里用作条件的

表达式

为${approved}，这是${approved == true}的简写。变量’approved’被称作流程流程变变量量(process variable)。

流程变量

是持久化的数据，与流程实例存储在一

起，并可以在流程实例的生命周期中使用。在这个例子里，我们需要在特定的地方（当经理用户任务提交时，或者以Flowable的术语来说，

完成

(complete)时）设置这个

流程

变量

，因为这不是流程实例启动时就能获取的数据。

现在我们已经有了流程BPMN 2.0 XML文件，下来需要将它

部署部署

(deploy)到引擎中。

部署

一个流程定义意味着：

流程引擎会将XML文件存储在数据库中，这样可以在需要的时候获取它。

流程定义转换为内部的、可执行的对象模型，这样使用它就可以启动

流程实例

。

将流程定义

部署

至Flowable引擎，需要使用RepositoryService，其可以从ProcessEngine对象获取。使用RepositoryService，可以通过XML文件的路径创建一个新的

部署

(Deployment)，并调用deploy()方法实际执行：

RepositoryService repositoryService = processEngine.getRepositoryService();

Deployment deployment = repositoryService.createDeployment()

.addClasspathResource("holiday-request.bpmn20.xml")

.deploy();

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

ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()

.deploymentId(deployment.getId())

.singleResult();

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

2.3.3. 启动启动流程流程实实例例

现在已经在流程引擎中

部署

了流程定义，因此可以使用这个

流程定义

作为“蓝图”启动

流程实例

。

要启动流程实例，需要提供一些初始化

流程变量

。一般来说，可以通过呈现给用户的表单，或者在流程由其他系统自动触发时通过REST API，来获取这些变量。在这个例子

里，我们简化为使用java.util.Scanner类在命令行输入一些数据：

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属性，在这个例子里是holidayRequest。

（请注意：除了使用key之外，在后面你还会看到有很多其他方式启动一个流程实例）

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("holidayRequest", variables);

在流程实例启动后，会创建一个执执行行(execution)，并将其放在启动事件上。从这里开始，这个

执行

沿着顺序流移动到经理审批的用户任务，并执行用户任务行为。这个行为将

在数据库中创建一个任务，该任务可以之后使用查询找到。用户任务是一个

等待状态

(wait state)，引擎会停止执行，返回API调用处。

2.3.4. 另一另一个话题个话题：事：事务务

在Flowable中，数据库事务扮演了关键角色，用于保证数据一致性，并解决并发问题。当调用Flowable API时，默认情况下，所有操作都是同步的，并处于同一个事务下。这

意味着，当方法调用返回时，会启动并提交一个事务。

流程启动后，会有一一个数个数据据库库事事务务从流程实例启动时持续到下一个

等待状态

。在这个例子里，指的是第一个用户任务。当引擎到达这个用户任务时，状态会持久化至数据库，

提交事务，并返回API调用处。

在Flowable中，当一个流程实例运行时，总会有一个数据库事务从前一个

等待状态

持续到下一个

等待状态

。数据持久化之后，可能在数据库中保存很长时间，甚至几年，直到

某个API调用使流程实例继续执行。请注意当流程处在等待状态时，不会消耗任何计算或内存资源，直到下一次APi调用。

在这个例子中，当第一个用户任务完成时，会启动一个数据库事务，从用户任务开始，经过排他网关（自动逻辑），直到第二个用户任务。或通过另一条路径直接到达结束。

2.3.5. 查查询询与完成任与完成任务务

在更实际的应用中，会为雇员及经理提供用户界面，让他们可以登录并查看任务列表。其中可以看到作为

流程变量

存储的流程实例数据，并决定如何操作任务。在这个例子

中，我们通过执行API调用来模拟任务列表，通常这些API都是由UI驱动的服务在后台调用的。

我们还没有为用户任务配置办理人。我们想将第一个任务指派给"经理(managers)"组，而第二个用户任务指派给请假申请的提交人。因此需要为第一个任务添

加candidateGroups属性：

剩余187页未读，继续阅读

jeely125

2022-03-22

资源很好！！！

席ZC

粉丝: 3490
资源: 21

会员权益专享

Flowable BPMN 用户手册中文版 (v 6.3.0).pdf

评论2

会员权益专享

最新资源

Flowable BPMN 用户手册 中文版 (v 6.3.0).pdf

评论2

Flowable BPMN 用户手册 (v 6.5.pdf

springboot 集成flowable 依赖

flowable流程图如何绘制

flowable监听器中如何获取配置文件中的值

flowable工作流官方汉化版

springboot整合flowable教程

flowable pdf

在reportlab中,如何在flowable框架下,在某个特定页面画图?

flowable工作流

flowable和activiti区别

Flowable中文文档（v 6.4.2）

帮我写一个Flowable工作流示例

flowable怎么使用

springboot 集成flowable 依赖mysql

activiti和flowable对比

flowable常见的类

讲解一下 flowable工作流

java工作流flowable

Flowable工作流用户任务超时后的处理方法

会员权益专享

最新资源

Flowable BPMN 用户手册中文版 (v 6.3.0).pdf