Activiti V5.21 中文用户手册：快速入门与配置指南

需积分: 9 116 浏览量更新于2024-07-16 收藏 13.95MB PDF 举报

"Activiti V5.21 用户手册提供了关于如何使用 Activiti Explorer 的详细指南，该手册是中文版，适用于对Activiti流程引擎感兴趣的用户。Activiti 是一个基于模型驱动的开源业务流程管理（BPM）和工作流系统，它采用 Apache V2 许可协议，并且其 Web 设计器遵循 LGPLv2.1 许可。手册介绍了如何下载、安装和运行 Activiti Explorer，以及所需的软件环境和反馈问题的途径。手册还特别提醒用户，某些章节标记的实验性功能可能不够稳定，而 .impl. 包下的类是内部实现，可能会在不同版本间发生变化，不推荐直接使用。" 在 Activiti V5.21 中，用户需要安装 JDK 6 或更高版本来运行系统，可以从 Oracle 官方网站下载并验证安装。Eclipse Indigo 或 Juno 用于开发，特别是安装 Activiti 的 Eclipse 设计器插件。手册指出，不建议在 GitHub 的问题追踪系统中报告问题，而是推荐使用 Activiti 的 JIRA 系统。为了快速开始，用户应从 Activiti 网站下载 Activiti Explorer 的 WAR 文件，将其复制到 Apache Tomcat 的 webapps 目录下，然后通过运行 Tomcat 的 startup 脚本来启动服务器。一旦 Tomcat 启动，用户可以在浏览器中访问 http://localhost:8080/activiti-explorer 并使用默认的 kermit/kermit 账户登录。默认情况下，Activiti Explorer 使用 H2 内存数据库，但手册也提到，如果需要配置其他数据库，可以参考更详尽的文档。手册的其他部分可能涵盖了流程建模、部署、任务管理、表单集成、API 使用、监控和日志记录等主题。对于开发人员来说，了解如何利用 Activiti 的 API 和服务来集成到自己的应用程序中，以及如何设计和执行业务流程模型是至关重要的。此外，手册可能还会详细介绍 Activiti 的事件、监听器、变量处理、流程历史记录等功能，帮助用户更有效地管理和优化业务流程。 Activiti V5.21 用户手册中文版是学习和操作 Activiti BPM 平台的重要参考资料，提供了一个全面的指南，涵盖从基础设置到高级使用的各个方面，以帮助用户充分利用 Activiti 的功能。

行。流程有许多 wait states （暂停状态），RuntimeService 服务提供了许多操作用于“通知”流程实例，告知已经接收到外部触

发，使流程实例可以继续运行。

对于像 Activiti 这样的 BPM 引擎来说，核心是需要人类用户实际操作的任务。所有任务相关的东西都组织在 TaskService 中，例如

查询分派给用户或组的任务

创建 standalone（独立运行）任务。这是一种没有关联到流程实例的任务。

决定任务的执行用户（assignee），或者将用户通过某种方式与任务关联。

认领（claim）与完成（complete）任务。认领是指某人决定成为任务的执行用户，也即他将会完成这个任务。完成任务是指“做这个

任务要求的工作”，通常是填写某种表单。

IdentityService 很简单。它用于管理（创建，更新，删除，查询……）组与用户。请重点注意，Activiti 实际上在运行时并不做任何用户

检查。例如任务可以分派给任何用户，而引擎并不会验证系统中是否存在该用户。这是因为 Activiti 有时要与 LDAP、Active Directory

等服务结合使用。

FormService 是可选服务。也就是说 Activiti 没有它也能很好地运行，而不必牺牲任何功能。这个服务引入了 start form（开始表单）与

task form（任务表单）的概念。开始表单是在流程实例启动前显示的表单，而任务表单是用户完成任务时显示的表单。Activiti 可以在

BPMN 2.0 流程定义中定义这些表单。表单服务通过简单的方式暴露这些数据。再次重申，表单不一定要嵌入流程定义，因此这个服

务是可选的。

HistoryService 暴露所有 Activiti 引擎收集的历史数据。当执行流程时，引擎会保存许多数据（可以配置），例如流程实例启动时间，

谁在执行哪个任务，完成任务花费的事件，每个流程实例的执行路径，等等。这个服务主要提供查询这些数据的能力。

ManagementService 通常在用 Activiti 编写用户应用时不需要使用。它可以用于读取数据库表与表原始数据的信息，也提供了对作业

（job）的查询与管理操作。Activiti 中很多地方都使用作业，例如定时器（timer），异步操作（asynchronous continuation），延时暂

停/激活（delayed suspension/activation）等等。后续会详细介绍这些内容。

参考 javadocs了解服务操作与引擎 API 的更多信息。

4.2. 异常策略 Exception strategy

Activiti 的异常基类是 org.activiti.engine.ActivitiException ，是未检查异常（unchecked exception）。在任何 API 操作时都可

能会抛出这个异常，javadoc 记录了每个方法可能发生的异常。例如，从 TaskService 中摘录：

/**

* 当任务成功执行时调用。

* @param taskId 需要完成的任务 id，不能为 null。

* @throws Activit iOb j ect Not F oun d Exc e pti on 若给定 id 找不到任

务。

void complete(String taskId);

在上例中，如果传递的 id找不到任务，会抛出异常。并且，由于 javadoc中明确要求 taskId 不能为 null，因此如果传递了 null 值，会

抛

出 ActivitiIllegalArgumentException 异常。

尽管我们想避免过大的异常层次结构，我们还是添加了下述在特定情况下抛出的异常子类。所有流程执行与 API 调用中发生的错误，

如果不符合下面列出的异常，会统一抛出 ActivitiExceptions 。

ActivitiWrongDbException : 当 Activiti 引擎检测到数据库表结构版本与引擎版本不匹配时抛出。

ActivitiOptimisticLockingException : 当对同一数据实体的并发访问，导致数据存储发生乐观锁时抛出。

ActivitiClassLoadingException : 当需要载入的类（如 JavaDelegates, TaskListeners, …）无法找到，或载入时发生错误时抛

出。

ActivitiObjectNotFoundException : 当请求或要操作的对象不存在时抛出。

ActivitiIllegalArgumentException : 这个异常说明调用 Activiti API 时使用了不合法的参数。可能是引擎配置中的不合法值，

或者是 API 调用传递的不合法参数，也可能是流程定义中的不合法值。

ActivitiTaskAlreadyClaimedException : 当调用 taskService.claim(…) ，而该任务已经被认领时抛出。

4.3. 使用 Activiti services(Working with the Activiti services)

如前所述，与 Activiti 引擎交互的方式，是使用 org.activiti.engine.ProcessEngine 类实例暴露的服务。下面的示例假定你已经有

可

运行的 Activiti 环境，也就是说，你可以访问有效的 org.activiti.engine.ProcessEngine 。如果你只是简单地想尝试下面的代码，

可

以下载或克隆

Ac tiviti

单元测试模板，导入你的

IDE

，在 org.activiti.MyUnitTest

单元测试中增加一个 testUserguideCode()

方

法。

4.3.1. 部署流程 Deploying the process

所有有关“静态”数据（例如流程定义）的东西，都可以通过 RepositoryService 访问。从概念上说，所有这种静态数据，都是 Activiti

引擎“仓库（repository）”中的内容。

在 src/test/resources/org/activiti/test 资源目录（如果没有使用单元测试模板，也可以是其他任何地方）下创建名

为 VacationRequest.bpmn20.xml 的 xml 文件，写入下列内容。请注意这个章节不会解释例子中用到的 xml的结构。如果需要，请

先阅读 BPMN 2.0 章节 the BPMN 2.0 chapter 了解这种结构。

<?xml version="1.0" encoding="UTF‐8" ?>

<definitions id="definitions"

targetNamespace="http://activiti.org/bpmn20"

xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"

xmlns:xsi="http://www.w3.org/2001/XMLSchema‐instance"

xmlns:activiti="http://activiti.org/bpmn">

<activiti:formProperty id="numberOfDays" name="Number of days" type="long" value="1" required="true"/>

<activiti:formProperty id="startDate" name="First day of holiday (dd‐MM‐yyy)" datePattern="dd‐MM‐yyyy hh:mm"

type="date" required="true" />

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

</extensionElements>

</startEvent>

${employeeName} would like to take ${numberOfDays} day(s) of vacation (Motivation: ${vacationMotivation}).

</documentation>

<activiti:formProperty id="vacationApproved" name="Do you approve this vacation" type="enum" required="true">

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

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

</activiti:formProperty>

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

</extensionElements>

<formalExpression>management</formalExpression>

</resourceAssignmentExpression>

</potentialOwner>

</userTask>

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

</sequenceFlow>

<task id="sendApprovalMail" name="Send confirmation e‐mail" /> <sequenceFlow

id="flow4" sourceRef="sendApprovalMail" targetRef="theEnd1" /> <endEvent

id="theEnd1" />

<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: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>

你必须首先部署（deploy）流程，以使 Activiti 引擎可以识别它。部署意味着引擎会将 BPMN 2.0 xml 文件解析为可执行的东西，并为部

署中包含的每个流程定义创建新的数据库记录。这样，引擎重启后，仍能获取已部署的流程：

ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();

RepositoryService repositoryService = processEngine.getRepositoryService();

repositoryService.createDeployment()

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

.deploy();

Lo g .in f o(" N umb er o f pro ce ss def i nit i ons: " + rep os ito ry Se rvi ce . c rea te Proc ess De fi niti o nQu ery ( ).c ou nt () );

在部署章节阅读更多部署相关信息。

4.3.2. 启动流程实例 Starting a process instance

向 Activiti 引擎部署流程定义后，可以用它启动流程实例。每个流程定义都可以有多个流程实例。流程定义就像是“蓝图”，而流程实例

在运行时执行它。

所有与流程运行时状态相关的东西都可以在 RuntimeService 中找到。启动流程实例有多种不同的方法。在下列代码片段中，使用流程

定义 xml 中定义的 key启动流程实例。在启动流程实例时，我们也设置了一些流程变量（process variables），因为第一个用户任务

（user task）的描述（description）中的表达式（expression）需要用到它们。流程变量的使用很普遍，因为它们为流程定义的流程实

例赋予了意义。流程变量使每个流程实例与其他实例不同。

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();

Pr o ces sIn s tance pr oce ss In sta nc e = ru nti me Serv ice . s tar tP roce ssI ns ta nceB y Key ("va cat io nR equ es t" , v ar ia bl es );

// Verify that we started a new process instance

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

4.3.3. 完成任务 Completing tasks

流程启动时，第一步是一个用户任务。这个步骤必须由系统用户操作。一般会提供“待办任务”列出所有需要该用户处理的任务。下面的

代码片段展示如何进行这种列表的查询：

1 // 获取 management 组的所有任务

2 TaskService taskService = processEngine.getTaskService();

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

4 for (Task task : tasks) {

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

6 }

我们需要结束这个任务才能使流程实例继续运行。对于 Activiti 引擎来说，就是 complete（完成）这个任务。下面的代码片段展示了

如何操作：

1 Task task = tasks.get(0);

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

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

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

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

现在流程实例会继续向下一步进行。在这个例子里，下一步允许雇员填写一个表单，用来修改提交的请假申请。雇员可以重新提交请假

申请，这会使流程从开始任务重新开始运行。

4.3.4. 暂停与激活流程 Suspending and activating a process

可以暂停流程定义。当流程定义暂停后，不能再创建新的流程实例（会抛出异常）。使用 RepositoryService 暂停流程定义：

re p osi tor y Servic e . sus pe nd Pro ce ss Def i nitio nB yKe y(" v aca ti onRe que st ");

try {

runtimeService.startProcessInstanceByKey("vacationRequest");

} catch (ActivitiException e) {

e.printStackTrace();

}

要重新激活流程定义，可以调用 repositoryService.activateProcessDefinitionXXX 方法。

也可以暂停流程实例。当流程实例暂停后，不能进行流程操作（例如完成任务会抛出异常），作业（如定时器）也不会执行。可以调

用 runtimeService.suspendProcessInstance 暂停流程实例。调用 runtimeService.activateProcessInstanceXXX 重新激活

流程实例。

4.3.5. 扩展阅读 Further reading

在前面的章节，我们大致介绍了 Acvtiviti 的功能。我们会在未来扩展这些内容，覆盖更多的 Activiti API。当然，与其他开源项目一样，

最好的学习方法是研究代码与阅读 Javadocs！

4.4. 查询 API (Query API)

从引擎中查询数据有两种方式：查询 API 与原生(native)查询。查询 API 可以使用链式 API，通过编程方式进行类型安全的查询。你可以

在查询中增加各种条件（所有条件都用做 AND 逻辑），也可以明确指定排序。下面是示例代码：

List<Task> tasks = taskService.createTaskQuery()

.taskAssignee("kermit")

.p r oce ssV a riab le Va lue Eq ua ls ( "o rd erI d ", "0 8 15" )

.orderByDueDate().asc()

.list();

有时你需要更强力的查询，例如使用 OR 操作符查询，或者使用查询 API 不能满足查询条件要求。我们为这种需求提供了原生查询，可

以自己写 SQL 查询。返回类型由使用的查询对象决定，数据也会映射到正确的对象中，如 Task, ProcessInstance, Execution….查询会

在

数据库中进行，因此你需要使用数据库中定义的表名与列名。这需要了解内部数据结构，因此建议小心使用原生查询。数据库表名可以

通过 API 读取，这样可以将依赖关系减到最小。

List<Task> tasks = taskService.createNativeTaskQuery()

.sql(" S ELEC T c ou nt (*) F ROM " + man a gem ent S ervi ce . g etT ab le Nam e( T ask. cl as s) + " T W HERE T.NA ME _ = # { tas k Name }" )

.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();

4.5. 变量 Variables

流程实例按步骤执行时，需要同时也使用一些数据。在 Activiti 中，这些数据称作 variables(变量)，并会存储在数据库中。变量可以用在

表达式中（例如在排他网关中用于选择正确的出口路径），用在 java 服务任务（java service task）中用于调用外部服务（例如为服务

调用提供输入或结果存储），等等。

流程实例可以拥有变量（称作 process variables，流程变量），执行(executions)——流程当前活动节点的指针，以及用户任务也可以拥

有变量。流程实例可以持有任意数量的变量，每个变量都存储在 ACT_RU_VARIABLE数据库表的一行中。

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

剩余264页未读，继续阅读

席ZC

粉丝: 5499
资源: 21

Activiti V5.21 中文用户手册：快速入门与配置指南

activiti中文api（用户手册）

activiti6.0 中文api

activiti5工作流官方文档汉化版

Activiti V5.21 用户手册中文版：快速入门与配置详解

Activiti V5.21中文用户手册：配置与启动指南

Activiti V5.21中文手册：全面指南与配置详解

Activiti V5.21中文用户手册：全面导航与配置指南

Activiti 表单设计与用户任务交互

基于Activiti的用户任务管理：提高工作流任务分配效率

org.activiti.engine.impl.util.json.jsonarray jar包

最新资源