Activiti用户指南：2017中文翻译版

1星需积分: 11 90 浏览量更新于2024-07-19 收藏 9.09MB PDF 举报

" Activiti用户指南.pdf2017-12-21最新中文翻译版" Activiti是一个开源的工作流程引擎，它基于Apache V2许可证发布。这个用户指南是2017年12月21日的中文翻译版，可能包含少许翻译误差，鼓励用户提供改进的中文文档。在开始使用Activiti之前，你需要了解以下关键知识点： 1. **许可证**：Activiti遵循Apache V2许可证，允许商业使用和修改，但需遵守一定的条款。 2. **下载**：你可以通过官方网站http://activiti.org/download.html获取Activiti的相关软件。 3. **源代码**：Activiti的源代码托管在GitHub上，地址是https://github.com/Activiti/Activiti，有兴趣的开发者可以查看和参与项目。 4. **系统需求**： - **JDK 7+**：Activiti需要JDK 7或更高版本运行。确保正确安装JDK并使用`java -version`命令检查版本。 - **集成开发环境(IDE)**：虽然可以选择任何IDE，但使用Activiti Designer需要Eclipse Kepler或Luna。可以从Eclipse官网下载并安装。 5. **问题报告**：遇到问题时，建议在用户论坛上发表讨论，并在Activiti的JIRA问题追踪器中创建问题。避免在GitHub上直接创建问题。 6. **实验功能**：带有[实验]标签的功能不稳定，可能随时变化。而`.impl.`包中的类虽然可能被用作配置值，但并不保证稳定性。 7. **内部实现类**：所有包含`.impl.`的包（如`org.activiti.engine.impl.db`）中的类被视为内部实现，不对外公开，稳定性不受保证。 8. **快速入门**： - **一分钟版本**：从Activiti官网下载并解压，然后在你的项目中引入Activiti库。使用JDK 7+创建一个流程引擎实例，即可开始执行工作流程。 9. **使用流程**：通常包括设计流程定义（使用Activiti Designer），部署到Activiti引擎，启动流程实例，执行任务和管理流程实例。 10. **API和工具**：Activiti提供了丰富的API和工具，如流程定义语言BPMN 2.0，用于设计流程模型；以及Engine API，用于与流程引擎交互，如启动流程、查询任务等。 11. **Activiti Designer**：这是一个Eclipse插件，用于图形化地设计和编辑BPMN 2.0流程图，然后导出为XML文件进行部署。 12. **部署和运行**：部署流程定义到Activiti引擎后，可以通过调用Engine API启动新的流程实例，流程将按照定义自动执行。 13. **监控和管理**：Activiti提供了管理和监控工具，帮助用户跟踪流程实例的状态，管理任务和事件，以及收集运行数据。通过深入学习这些知识点，你将能够有效地利用Activiti构建和管理复杂的企业工作流程。记得关注官方更新和社区资源，以便获取最新的信息和支持。

2017/12/21 Activiti用户指南

https://www.activiti.org/userguide/index.html#eclipseDesignerInstallation 16/246

为了让Activiti引擎知道这个过程，我们必须首先

部

署

它。部署意味着引擎会将BPMN 2.0 xml解析为可执行文件，并且将为包含在

部

署

中

的每个流程定义添加新的数据库记录。这样，当引擎重新启动时，它仍然会知道所有已

部

署的

进程：

在部署章节中阅读有关部署的更多信息。

4.3.2。启动一个流程实例

在将流程定义部署到Activiti引擎后，我们可以从中启动新的流程实例。对于每个流程定义，通常有很多流程实例。流程定义是

蓝

图

，流

程实例是运行时执行。

所有与进程的运行时状态相关的东西都可以在RuntimeService中找到。有多种方式来启动一个新的流程实例。在下面的代码片段中，

我们使用我们在流程定义xml中定义的键来启动流程实例。我们还在流程实例启动时提供一些流程变量，因为第一个用户任务的描述将

<activiti:formProperty id="managerMotivation" name="Motivation" type="string" />

</extensionElements>

<formalExpression>management</formalExpression>

</resourceAssignmentExpression>

</potentialOwner>

</userTask>

<conditionExpression xsi:type="tFormalExpression">${vacationApproved == 'true'}</conditionExpression>

</sequenceFlow>

<conditionExpression xsi:type="tFormalExpression">${vacationApproved == 'false'}</conditionExpression>

</sequenceFlow>

Your manager has disapproved your vacation request for ${numberOfDays} days.

Reason: ${managerMotivation}

</documentation>

<activiti:formProperty id="numberOfDays" name="Number of days" value="${numberOfDays}" type="long"

required="true"/>

<activiti:formProperty id="startDate" name="First day of holiday (dd-MM-yyy)" value="${startDate}"

datePattern="dd-MM-yyyy hh:mm" type="date" required="true" />

<activiti:formProperty id="vacationMotivation" name="Motivation" value="${vacationMotivation}" type="string" />

<activiti:formProperty id="resendRequest" name="Resend vacation request to manager?" type="enum" required="true">

<activiti:value id="true" name="Yes" />

<activiti:value id="false" name="No" />

</activiti:formProperty>

</extensionElements>

<formalExpression>${employeeName}</formalExpression>

</resourceAssignmentExpression>

</humanPerformer>

</userTask>

<conditionExpression xsi:type="tFormalExpression">${resendRequest == 'true'}</conditionExpression>

</sequenceFlow>

<conditionExpression xsi:type="tFormalExpression">${resendRequest == 'false'}</conditionExpression>

</sequenceFlow>

</process>

</definitions>

ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();

RepositoryService repositoryService = processEngine.getRepositoryService();

repositoryService.createDeployment()

.addClasspathResource("org/activiti/test/VacationRequest.bpmn20.xml")

.deploy();

Log.info("Number of process definitions: " + repositoryService.createProcessDefinitionQuery().count());

2017/12/21 Activiti用户指南

https://www.activiti.org/userguide/index.html#eclipseDesignerInstallation 17/246

在其表达式中使用这些变量。过程变量通常被使用，因为它们为某个过程定义的过程实例赋予了含义。通常，流程变量是流程实例彼此

不同的原因。

4.3.3。完成任务

当进程启动时，第一步将是一个用户任务。这是系统用户必须执行的一个步骤。通常，这样的用户将具有

任

务

的

收

件

箱

，

其列出了需要

由该用户完成的所有任务。以下代码片段显示了如何执行这样的查询：

要继续流程实例，我们需要完成这个任务。对于Activiti引擎，这意味着你需要 complete 的任务。以下片段显示了这是如何完成的：

流程实例现在将继续到下一步。在此示例中，下一步允许员工填写调整原始假期请求的表单。员工可以重新提交将导致进程循环回启动

任务的休假请求。

4.3.4。暂停和激活一个过程

可以暂停一个流程定义。当进程定义被挂起时，不能创建新的进程实例（将引发异常）。暂停流程定义是通过以下方式完成的

RepositoryService ：

要重新激活流程定义，只需调用其中一个 repositoryService.activateProcessDefinitionXXX 方法即可。

也可以挂起一个流程实例。当被暂停时，进程不能继续（例如，完成一个任务抛出一个异常）并且没有任何工作（例如定时器）将被执

行。暂停一个流程实例可以通过调用该 runtimeService.suspendProcessInstance 方法来完成。再次激活流程实例是通过调用

runtimeService.activateProcessInstanceXXX 方法来完成的。

4.3.5。进一步阅读

我们刚刚在关于Activiti功能的前面章节中已经摸索过。我们将在未来进一步扩展这些部分，增加Activiti API的覆盖范围。当然，与任何

开源项目一样，学习的最好方法是检查代码并阅读Javadocs！

4.4。查询API

查询引擎中的数据有两种方法：查询API和本机查询。查询API允许使用流畅的API编程完全类型安全的查询。您可以为查询添加各种条

件（所有这些条件都作为逻辑“与”一起应用），而且恰恰是一种排序。以下代码显示了一个示例：

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

variables.put("employeeName", "Kermit");

variables.put("numberOfDays", new Integer(4));

variables.put("vacationMotivation", "I'm really tired!");

RuntimeService runtimeService = processEngine.getRuntimeService();

ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("vacationRequest", variables);

// Verify that we started a new process instance

Log.info("Number of process instances: " + runtimeService.createProcessInstanceQuery().count());

// Fetch all tasks for the management group

TaskService taskService = processEngine.getTaskService();

List<Task> tasks = taskService.createTaskQuery().taskCandidateGroup("management").list();

for (Task task : tasks) {

Log.info("Task available: " + task.getName());

}

Task task = tasks.get(0);

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

taskVariables.put("vacationApproved", "false");

taskVariables.put("managerMotivation", "We have a tight deadline!");

taskService.complete(task.getId(), taskVariables);

repositoryService.suspendProcessDefinitionByKey("vacationRequest");

try {

runtimeService.startProcessInstanceByKey("vacationRequest");

} catch (ActivitiException e) {

e.printStackTrace();

}

List<Task> tasks = taskService.createTaskQuery()

.taskAssignee("kermit")

.processVariableValueEquals("orderId", "0815")

.orderByDueDate().asc()

.list();

2017/12/21 Activiti用户指南

https://www.activiti.org/userguide/index.html#eclipseDesignerInstallation 18/246

有时您需要更强大的查询，例如使用OR运算符的查询或使用查询API无法表达的限制。对于这些情况，我们引入了原生查询，它允许您

编写自己的SQL查询。返回类型由您使用的查询对象定义，并将数据映射到正确的对象，例如Task，ProcessInstance，Execution等。

由于查询将在数据库中被触发，因此必须使用数据库中定义的表名和列名称; 这需要一些有关内部数据结构的知识，建议小心使用本机

查询。表格名称可以通过API检索，以保持依赖性尽可能小。

4.5。变量

每个流程实例都需要使用数据来执行它所存在的步骤。在Activiti中，这些数据被称为

变

量

，这些

变

量

存储在数据库中。在调用外部服务

（例如提供输入或存储服务调用的结果）时，可以在表达式中使用变量（例如，在专用网关中选择正确的输出序列流），在Java服务任

务中使用变量

流程实例可以包含变量（称为

流

程

变

量

），也可以包含

执

行

（这是指向流程激活的特定指针），用户任务可以包含变量。一个流程实例

可以有任意数量的变量。每个变量都存储在ACT_RU_VARIABLE数据库表中的一行中。

任何startProcessInstanceXXX方法都有一个可选参数，用于在创建和启动流程实例时提供变量。例如，从RuntimeService：

变量可以在流程执行过程中添加。例如（RuntimeService）：

请注意，变量可以为给定的执行设置为

本

地

（记住一个流程实例由一个执行树组成）。该变量只在执行时可见，在执行树中不会更高。

如果数据不应该传播到流程实例级别，或者变量在流程实例中具有特定路径的新值（例如使用并行路径时），这可能很有用。

变量也可以重新获取，如下所示。请注意，TaskService上存在类似的方法。这意味着任务（如执行）可以具有仅在任务期间处于

活

动

状

态

的

局部变量。

变量通常用在Java委托，表达式，执行或任务监听器，脚本等中。在这些构造中，当前的

执

行

或

任

务

对象是可用的，并且可以用于变量

设置和/或检索。最简单的方法是这些：

请注意，以上所有内容也适用于

本

地

变体。

对于历史（和向后兼容的原因），当进行上述任何调用时，幕后实际上所有变量都将从数据库中获取。这意味着如果你有10个变量，并

且只通过getVariable

（

“myVariable”

）

得到一个变量，幕后的其他9 个变量将被获取和缓存。这并不坏，因为随后的调用不会再次触发数

据库。例如，当你的流程定义有三个连续的服务任务（从而一个数据库事务）时，使用一个调用来获取第一个服务任务中的所有变量可

能会更好，然后单独获取每个服务任务中所需的变量。请注意，这适用于既用于获取和设置变量。

当然，当使用很多变量或者只是想要严格控制数据库查询和流量时，这是不合适的。自从Activiti 5.17以来，已经引入了新的方法来对这

个问题进行更严格的控制，通过添加一个新的方法，这个方法有一个可选的参数来告诉引擎是否在幕后，所有的变量都需要被提取和缓

存：

List<Task> tasks = taskService.createNativeTaskQuery()

.sql("SELECT count(*) FROM " + managementService.getTableName(Task.class) + " T WHERE T.NAME_ = #{taskName}")

.parameter("taskName", "gonzoTask")

.list();

long count = taskService.createNativeTaskQuery()

.sql("SELECT count(*) FROM " + managementService.getTableName(Task.class) + " T1, "

+ managementService.getTableName(VariableInstanceEntity.class) + " V1 WHERE V1.TASK_ID_ = T1.ID_")

.count();

1 ProcessInstance startProcessInstanceByKey(String processDefinitionKey, Map<String, Object> variables);

void setVariable(String executionId, String variableName, Object value);

void setVariableLocal(String executionId, String variableName, Object value);

void setVariables(String executionId, Map<String, ? extends Object> variables);

void setVariablesLocal(String executionId, Map<String, ? extends Object> variables);

Map<String, Object> getVariables(String executionId);

Map<String, Object> getVariablesLocal(String executionId);

Map<String, Object> getVariables(String executionId, Collection<String> variableNames);

Map<String, Object> getVariablesLocal(String executionId, Collection<String> variableNames);

Object getVariable(String executionId, String variableName);

<T> T getVariable(String executionId, String variableName, Class<T> variableClass);

execution.getVariables();

execution.getVariables(Collection<String> variableNames);

execution.getVariable(String variableName);

execution.setVariables(Map<String, object> variables);

execution.setVariable(String variableName, Object value);

1 Map<String, Object> getVariables(Collection<String> variableNames, boolean fetchAllVariables);

2017/12/21 Activiti用户指南

https://www.activiti.org/userguide/index.html#eclipseDesignerInstallation 19/246

当对参数fetchAllVariables使用true

时

，行为将如上所述：当获取或设置变量时，所有其他变量将被获取并缓存。

但是，使用false作为值时，将使用特定的查询，并且不会提取或缓存其他变量。只有这里讨论的变量的值才会被缓存以供后续使用。

4.6。瞬态变量

瞬态变量是像常规变量一样的变量，但不是持久的。通常情况下，瞬态变量用于高级用例（即，如果有疑问，请使用常规过程变量）。

以下内容适用于瞬态变量：

对于瞬态变量没有存储历史。

像

常

规

变量一样，瞬态变量在设置时放置在

最

高

父

节

点

上

。这意味着在执行时设置变量时，瞬态变量实际上存储在流程实例执行中。

像常规变量一样，如果应该在特定的执行或任务上设置变量，则存在方法的

本

地

变体。

一个瞬态变量只能在流程定义中的下一个

等

待

状

态

之前被访问。之后，他们走了。等待状态在这里意味着流程实例中保存到数据存储

的地方。请注意，

异

步

活动在这个定义中也是一个

等

待

状

态

！

瞬态变量只能由setTransientVariable

（

name

，

value

）

设

置

，但是在调用getVariable

（

name

）

时也会返回瞬态变量（一个

getTransientVariable

（

name

）

也存在，只能检查瞬态变量）。其原因是为了使表达式的写作变得容易，并且使用变量的现有逻辑适

用于这两种类型。

一个瞬态变量会

隐

藏

一个具有相同名称的持久变量。这意味着，如果在流程实例上设置了持久变量和瞬态变量，并且使用

getVariable

（

“someVariable”

）

，则将返回瞬态变量值。

瞬变变量可以在常规变量暴露的大部分地方得到和/或设置：

在DelegateExecution在JavaDelegate实现

在DelegateExecution在ExecutionListener实现和DelegateTask上TaskListener实现

在通过

执

行

对象的脚本任务中

通过运行时服务启动流程实例时

完成任务时

调用runtimeService.trigger方法时

这些方法遵循常规过程变量的命名约定：

下面的BPMN图显示了一个典型的例子：

假设

提

取

数据

服务任务调用某个远程服务（例如使用REST）。我们还假设需要一些配置参数，并且在启动流程实例时需要提供。而

且，这些配置参数对于历史审计目的来说并不重要，所以我们将它们作为瞬态变量传递：

Object getVariable(String variableName, boolean fetchAllVariables);

void setVariable(String variableName, Object value, boolean fetchAllVariables);

void setTransientVariable(String variableName, Object variableValue);

void setTransientVariableLocal(String variableName, Object variableValue);

void setTransientVariables(Map<String, Object> transientVariables);

void setTransientVariablesLocal(Map<String, Object> transientVariables);

Object getTransientVariable(String variableName);

Object getTransientVariableLocal(String variableName);

Map<String, Object> getTransientVariables();

Map<String, Object> getTransientVariablesLocal();

void removeTransientVariable(String variableName);

void removeTransientVariableLocal(String variableName);

1 ProcessInstance processInstance = runtimeService.createProcessInstanceBuilder()

2017/12/21 Activiti用户指南

https://www.activiti.org/userguide/index.html#eclipseDesignerInstallation 20/246

请注意，变量将可用，直到达到用户任务并将其保存到数据库。例如，在“

附

加

工

作

”用户任务中，它们不再可用。另请注意，如果

提

取

数据

是异步的，那么在该步骤之后它们也将不可用。

在

获

取

数据

（简化）可能是这样的

该

过

程

数据

会得到响应瞬态变量，分析它，并存储在实际过程变量的相关数据，我们以后需要它们。

离开专用网关的序列流的条件不知道是否使用了持久变量或瞬变变量（在这种情况下是

状

态

瞬态变量）：

4.7。表达式

Activiti使用UEL进行表达式解析。UEL代表

统

一

表

达

式

语言

（Unified Expression Language

）

，是EE6规范的一部分（有关详细信息，

请参阅EE6规范）。为了支持所有环境下最新的UEL规范的所有功能，我们使用JUEL的修改版本。

表达式可用于例如Java服务任务，执行监听器，任务监听器和条件序列流。虽然有两种类型的表达式，值表达式和方法表达式，但

Activiti将这种表达方式抽象出来，这样它们都可以在 expression 需要的地方使用。

值表达式：解析为一个值。默认情况下，所有的过程变量都可以使用。所有春豆（如果使用Spring）都可以在表达式中使用。一些例

子：

方法表达式：调用一个方法，有或没有参数。当调用一个没有参数的方法时，一定要在方法名之后加上空的圆括号（因为这和表达式

区分了一个值表达式）。传递的参数可以是字面值或自己解析的表达式。例子：

请注意，这些表达式支持解析原语（包括比较它们），bean，列表，数组和地图。

在所有流程变量之上，有几个默认对象可用于表达式：

execution ： DelegateExecution 持有关于正在进行的执行的更多信息。

task ： DelegateTask 包含有关当前任务的附加信息。注意：只适用于任务监听器评估的表达式。

authenticatedUserId ：当前通过身份验证的用户的ID。如果没有用户通过身份验证，该变量不可用。

有关更具体的用法和示例，请查看Spring中的表达式，Java服务任务，执行监听器，任务监听器或条件序列流。

4.8。单元测试

业务流程是软件项目不可分割的一部分，应该按照与正常应用程序逻辑测试相同的方式进行测试：使用单元测试。由于Activiti是一个可

嵌入的Java引擎，编写业务流程的单元测试就像编写常规单元测试一样简单。

Activiti支持JUnit版本3和4的单元测试。在JUnit 3风格中， org.activiti.engine.test.ActivitiTestCase 必须扩展。这将通过受保

护的成员字段使ProcessEngine和服务可用。在 setup() 测试中，processEngine将默认使用 activiti.cfg.xml 类路径上的资源进行

初始化。要指定不同的配置文件，请覆盖getConfigurationResource

（）

方法。当配置资源相同时，流程引擎会静态缓存在多个单元测

试中。

.processDefinitionKey("someKey")

.transientVariable("configParam01", "A")

.transientVariable("configParam02", "B")

.transientVariable("configParam03", "C")

.start();

public static class FetchDataServiceTask implements JavaDelegate {

public void execute(DelegateExecution execution) {

String configParam01 = (String) execution.getVariable(configParam01);

// ...

RestReponse restResponse = executeRestCall();

execution.setTransientVariable("response", restResponse.getBody());

execution.setTransientVariable("status", restResponse.getStatus());

}

1 <conditionExpression xsi:type="tFormalExpression">${status == 200}</conditionExpression>

$ {myVar的}

$ {} myBean.myProperty

$ {printer.print（）}

$ {myBean.addNewOrder（ 'ORDERNAME'）}

$ {myBean.doSomething（myVar，execution）}

剩余245页未读，继续阅读

godth

粉丝: 6
资源: 5

Activiti用户指南：2017中文翻译版

activiti中文api（用户手册）

Activiti-in-Action.pdf

activiti6的手册pdf版和html版

Manning.Activiti.in.Action.Jul.2012.pdf

activiti-explorer.war+Activiti_User_Guide_5.16.pdf

Activiti 5.16 用户手册.pdf

activiti5.X超详细使用步骤总结+Activiti5.4 用户指南（中文版） .pdf

[应用开发及迁移][客户端编程开发框架]Activiti指南.pdf

Activiti5.4 用户指南（中文版） .pdf

Activiti 5.4 用户指南（中文版） .pdf

最新资源