Flowable API

 

流程引擎API与服务

引擎API是与Flowable交互的最常用手段。总入口点是ProcessEngine。可以使用多种方式创建。使用ProcessEngine，可以获得各种提供工作流/BPMN方法的服务。它是线程安全的，可以在服务器中保存并共用一个引用。

 

ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
 
RuntimeService runtimeService = processEngine.getRuntimeService();
RepositoryService repositoryService = processEngine.getRepositoryService();
TaskService taskService = processEngine.getTaskService();
ManagementService managementService = processEngine.getManagementService(); IdentityService identityService = processEngine.getIdentityService();
HistoryService historyService = processEngine.getHistoryService();
FormService formService = processEngine.getFormService();
DynamicBpmnService dynamicBpmnService = processEngine.getDynamicBpmnService();

在ProcessEngines.getDefaultProcessEngine()第一次调用时，将初始化并构建流程引擎，之后的重复调用都会返回同一个流程引擎。可以通过ProcessEngines.init()创建流程引擎，并由ProcessEngines.destroy()关闭流程引擎。

ProcessEngines会扫描flowable.cfg.xml与flowable-context.xml文件。

  • 对于flowable.cfg.xml文件，流程引擎会以标准Flowable方式构建引擎：ProcessEngineConfiguration.createProcessEngineConfigurationFromInputStream(inputStream).buildProcessEngine()。
  • 对于flowable-context.xml文件，流程引擎会以Spring的方式创建：首先构建Spring应用上下文，然后从该上下文中获取流程引擎。

 

所有的服务都是无状态的。这意味着你可以很容易的在集群环境的多个节点上运行Flowable，使用同一个数据库，而不用担心上一次调用实际在哪一台机器上执行。不论在哪个节点执行，对任何服务的任何调用都是幂等(idempotent)的。

 

RepositoryService很可能是使用Flowable引擎要用的第一个服务。这个服务提供了管理与控制部署(deployments)与流程定义(process definitions)的操作。在这里简单说明一下，流程定义是BPMN 2.0流程对应的Java对象，体现流程中每一步的结构与行为。部署是Flowable引擎中的包装单元，一个部署中可以包含多个BPMN 2.0 XML文件及其他资源。开发者可以决定在一个部署中包含的内容，可以是单个流程的BPMN 2.0 XML文件，也可以包含多个流程及其相关资源（如hr-processes部署可以包含所有与人力资源流程相关的东西）。RepositoryService可用于部署这样的包。部署意味着将它上传至引擎，引擎将在储存至数据库之前检查与分析所有的流程。在部署操作后，可以在系统中使用这个部署包，部署包中的所有流程都可以启动。

此外，这个服务还可以：

  • 查询引擎现有的部署与流程定义。
  • 暂停或激活部署中的流程，或整个部署。暂停意味着不能再对它进行操作，激活刚好相反，重新使它可以操作。
  • 获取各种资源，比如部署中保存的文件，或者引擎自动生成的流程图。
  • 获取POJO版本的流程定义。它可以用Java而不是XML的方式查看流程。

 

RuntimeService

与提供静态信息（也就是不会改变，至少不会经常改变的信息）的RepositoryService相反，RuntimeService用于启动流程定义的新流程实例。前面介绍过，流程定义中定义了流程中不同步骤的结构与行为。流程实例则是流程定义的实际执行过程。同一时刻，一个流程定义通常有多个运行中的实例。RuntimeService也用于读取与存储流程变量。流程变量是是流程实例中的数据，可以在流程的许多地方使用（例如，排他网关经常使用流程变量判断流程下一步要走的路径）。RuntimeService还可以用于查询流程实例与执行（Execution）。执行也就是BPMN 2.0的token概念。通常执行是指向流程实例当前位置的指针。最后，还可以在流程实例等待外部触发时使用RuntimeService，使流程可以继续运行。流程有许多等待状态（wait states），RuntimeService服务提供了许多操作用于通知流程实例：已经接收到外部触发，流程实例可以继续运行。

 

TaskService

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

  • 查询分派给用户或组的任务。
  • 创建独立运行（standalone）任务。这是一种没有关联到流程实例的任务。
  • 决定任务的执行用户（assignee），或者将用户通过某种方式与任务关联。
  • 认领（claim）与完成（complete）任务。认领是指某人决定成为任务的执行用户，也即他将会完成这个任务。完成任务是指做这个任务要求的工作，通常是填写某个表单。

 

IdentityService

它用于管理（创建、更新、删除、查询）组与用户。

请注意，Flowable实际上在运行时不做任何用户检查。例如任务可以分派给任何用户，而引擎并不会验证系统中是否存在该用户。这是因为Flowable有时要与LDAP、Active Directory等服务结合使用。

 

FormService

可选服务。这个服务引入了开始表单（start form）与任务表单（task form）的概念。

开始表单是在流程实例启动前显示的表单，而任务表单是用户完成任务时显示的表单。

Flowable可以在BPMN 2.0流程定义中定义这些表单。表单服务通过简单的方式暴露这些数据。再将重申，表单不一定嵌入流程定义，因此，这个服务是可选的。

 

HistoryService

暴露Flowable引擎收集的所有数据。当执行流程时，引擎会保存许多数据（可配置），例如流程实例启动时间，谁在执行哪个任务，完成任务花费的时间，每个流程实例的执行路径等等。这个服务主要提供查询这些数据的能力。

 

ManagementService

通常在用Flowable编写用户应用时不需要使用。它可以读取数据库表与表原始数据的信息，也提供了对作业（Job）的查询与管理操作。Flowable中很多地方都使用作业，例如定时器（timer），异步操作（asynchronous continuation），延时暂停/激活（delayed suspension/activation）等等。

 

DynamicBpmnService

可用于修改流程定义中的部分内容，而不需要重新部署它。例如，可以修改流程定义中一个用户任务的办理人设置，或者修改一个服务任务中的类名。