Activiti 工作流入门指南

概览

如我们的介绍部分所述，Activiti目前分为两大类：

• Activiti Core

• Activiti Cloud

如果你想上手Activiti的核心是否遵循了新的运行时API的入门指南：Activiti Core

如果你想基于Kuberantes构建Activiti，你可以参考Activiti Cloud HELM Charts:Activiti Cloud

Activiti Core入门

Activiti Core Runtime API入门

创建新API的目的明确，以满足以下要求：

• 为我们的云方法提供明确的途径

• 隔离内部和外部API以提供向后兼容性

• 遵循单一责任方法，提供模块化的未来之路

• 减少以前版本的API的混乱

• 将安全和身份管理作为一等公民

• 减少您希望依赖流行框架提供的约定的常见用例的价值时间

• 提供底层服务的替代实现

• 使社区能够在尊重既定合同的同时进行创新

我们尚未弃用旧API，因此您仍然可以自由使用它，但我们强烈建议您使用新API以获得长期支持。

我们尚未弃用旧API，因此您仍然可以自由使用它，但我们强烈建议您使用新API以获得长期支持。

是时候通过几个示例项目弄清楚了 。

TaskRuntime API

如果要构建业务应用程序，则可以为组织中的用户和组创建任务。

TaskRuntime API可以帮助您。

您可以从GitHub克隆这个例子：https://github.com/Activiti/activiti-examples

本节中的代码可以在“activiti-api-basic-task-example”maven模块中找到。

如果您在Spring Boot 2应用程序中运行，则只需添加activiti-spring-boot-starter依赖项和DB驱动程序，您可以将H2用于内存存储。

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-task-example/pom.xml#L45

    org.activiti
    activiti-spring-boot-starter


    com.h2database
    h2

我们建议使用我们的BOM（物料清单）

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-task-example/pom.xml#L30

    
        
            org.activiti
            activiti-dependencies
            7.0.0.Beta1
            import
            pom
        
    

现在让我们切换到我们的DemoApplication.class : https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-task-example/src/main/java/org/activiti/examples/DemoApplication.java#L25

现在让我们切换到我们的DemoApplication.class

@Autowired
private TaskRuntime taskRuntime;

将bean注入应用程序后，您应该能够创建任务并与任务交互。

public interface TaskRuntime {
  TaskRuntimeConfiguration configuration();
  Task task(String taskId);
  Page tasks(Pageable pageable);
  Page tasks(Pageable pageable, GetTasksPayload payload);
  Task create(CreateTaskPayload payload);
  Task claim(ClaimTaskPayload payload);
  Task release(ReleaseTaskPayload payload);
  Task complete(CompleteTaskPayload payload);
  Task update(UpdateTaskPayload payload);
  Task delete(DeleteTaskPayload payload);
  ...
}

例如，您可以通过执行以下操作来创建任务：

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-task-example/src/main/java/org/activiti/examples/DemoApplication.java#L45

taskRuntime.create(
            TaskPayloadBuilder.create()
                .withName("First Team Task")
                .withDescription("This is something really important")
                .withGroup("activitiTeam")
                .withPriority(10)
           .build());

只有属于activitiTeam的用户和所有者（当前登录的用户）才能看到此任务。

您可能已经注意到，您可以使用TaskPayloadBuilder以流畅的方式参数化将要发送到TaskRuntime的信息。

为了处理安全性，角色和组，我们依赖于Spring Security模块。因为我们在Spring Boot应用程序中，所以我们可以使用UserDetailsService来配置可用用户及其各自的组和角色。我们目前在@Configuration类中执行此操作：https：//github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-task-example/src/main/java/org/activiti/examples /DemoApplicationConfiguration.java#L26

需要注意的一点是，为了与用户交互TaskRuntime API，您需要具有以下角色：ACTIVITI_USER（授权机构：ROLE_ACTIVITI_USER）。

虽然与REST端点交互授权机制将建立在当前登录的用户，但对于例如起见，我们使用的是实用类（https://github.com/Activiti/activiti-examples/blob/master/activiti -api-basic-task-example / src / main / java / org / activiti / examples / SecurityUtil.java＃L26）允许我们在上下文中设置手动选择的用户。请注意，除非您正在尝试并且想要在不通过REST端点的情况下更改用户，否则不应该这样做。查看“web”示例以查看根本不需要此实用程序类的更多真实场景。

从示例中突出显示的最后一件事是任务事件监听器的注册：

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-task-example/src/main/java/org/activiti/examples/DemoApplication.java#L89

@Bean
public TaskRuntimeEventListener taskAssignedListener() {
  return taskAssigned
           -> logger.info(
                 ">>> Task Assigned: '"
                + taskAssigned.getEntity().getName()
                +"' We can send a notification to the assignee: "
                + taskAssigned.getEntity().getAssignee());
}

您可以根据需要注册任意数量的TaskRuntimeEventListeners。这将使您的应用程序能够通过服务触发的运行时事件得到通知。

ProcessRuntime API

以类似的方式，如果要开始使用ProcessRuntime API，则需要包含与以前相同的依赖项。我们的目标是在未来提供更多的灵活性和单独的运行时，但是现在相同的Spring Boot Starter提供了TaskRuntime和ProcessRuntime API。

本节中的代码可以在“activiti-api-basic-process-example”maven模块中找到。

public interface ProcessRuntime {
  ProcessRuntimeConfiguration configuration();
  ProcessDefinition processDefinition(String processDefinitionId);
  Page processDefinitions(Pageable pageable);
  Page processDefinitions(Pageable pageable,
              GetProcessDefinitionsPayload payload);
  ProcessInstance start(StartProcessPayload payload);
  Page processInstances(Pageable pageable);
  Page processInstances(Pageable pageable,
              GetProcessInstancesPayload payload);
  ProcessInstance processInstance(String processInstanceId);
  ProcessInstance suspend(SuspendProcessPayload payload);
  ProcessInstance resume(ResumeProcessPayload payload);
  ProcessInstance delete(DeleteProcessPayload payload);
  void signal(SignalPayload payload);
  ...
}

与TaskRuntime API类似，为了与ProcessRuntime API交互，当前登录的用户需要具有角色“ACTIVITI_USER”。

首先，让我们自动装配我们的ProcessRuntime：

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-process-example/src/main/java/org/activiti/examples/DemoApplication.java#L32

@Autowired
private ProcessRuntime processRuntime;
​
@Autowired
private SecurityUtil securityUtil;

与以前一样，我们需要SecurityUtil帮助器来代表我们与API交互的用户进行定义。

现在我们可以开始与ProcessRuntime进行交互：

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-process-example/src/main/java/org/activiti/examples/DemoApplication.java#L47

Page processDefinitionPage = processRuntime
                                .processDefinitions(Pageable.of(0, 10));
logger.info("> Available Process definitions: " +
                  processDefinitionPage.getTotalItems());
for (ProcessDefinition pd : processDefinitionPage.getContent()) {
  logger.info("\t > Process definition: " + pd);
}

流程定义需要放在/ src / main / resources / processes /中。对于此示例，我们定义了以下过程：

我们使用Spring Scheduling功能每秒启动一个进程，从数组中获取随机值来处理：

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-process-example/src/main/java/org/activiti/examples/DemoApplication.java#L67

@Scheduled(initialDelay = 1000, fixedDelay = 1000)
public void processText() {
  securityUtil.logInAs("system");
  String content = pickRandomString();
  SimpleDateFormat formatter = new SimpleDateFormat("dd-MM-yy HH:mm:ss");
  logger.info("> Processing content: " + content
                    + " at " + formatter.format(new Date()));
  ProcessInstance processInstance = processRuntime
                  .start(ProcessPayloadBuilder
                       .start()
                       .withProcessDefinitionKey("categorizeProcess")
                       .withProcessInstanceName("Processing Content: " + content)
                       .withVariable("content", content)
                       .build());
  logger.info(">>> Created Process Instance: " + processInstance);
}

这些连接器使用Bean名称自动连接到ProcessRuntime，在此示例中为“processTextConnector”。这个bean名称是从我们的流程定义中的serviceTask元素的implementation属性中获取的：

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-process-example/src/main/resources/processes/categorize-content.bpmn20.xml#L22

这个新的Connector接口是JavaDelegates的自然演变，新版本的Activiti Core将尝试通过将它们包装在Connector实现中来重用JavaDelagates：

public interface Connector {
  IntegrationContext execute(IntegrationContext integrationContext);
}

连接器接收带有过程变量的IntegrationContext，并返回一个修改后的IntegrationContext，其结果需要映射回过程变量。

在前面的示例中，连接器实现正在接收“content”变量并基于内容处理逻辑添加“approved”变量。

在这些连接器中，您可能包括系统到系统调用，例如REST调用和基于消息的交互。这些交互往往变得越来越复杂，因此我们将在未来的教程中看到如何从ProcessRuntime（云连接器）的上下文之外的运行中提取这些连接器，从而将这些外部交互的责任分离出去。 ProcessRuntime范围。

检查maven模块activiti-api-spring-integration-example以获得更高级的示例，使用Spring Integrations基于File轮询器来启动进程。

完整的例子

您可以使用ProcessRuntime和TaskRuntime API找到一个示例来自动执行以下过程：

本节中的代码可以在“activiti-api-basic-full-example”maven模块中找到。

仅作为ProcessRuntime示例，这也是对某些输入内容进行分类，但在这种情况下，该进程依赖于Human Actor来决定是否批准内容。我们像以前一样有一个计划任务，每5秒创建一个新的流程实例，模拟用户检查是否有可用的任务。

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-full-example/src/main/java/org/activiti/examples/DemoApplication.java#L63

和

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-full-example/src/main/java/org/activiti/examples/DemoApplication.java#L85

UserTask创建给一组潜在的用户，在本例中为“activitiTeam”组。但在这种情况下，我们不会像第一个示例那样手动创建任务。每次启动进程时，流程实例都会为我们创建任务。

https://github.com/Activiti/activiti-examples/blob/master/activiti-api-basic-full-example/src/main/resources/processes/categorize-human-content.bpmn20.xml#L38

  SequenceFlow_09xowo4
  SequenceFlow_1jzbgkj
  
    
      activitiTeam
    
  

属于该组的用户将能够声明并处理该任务。

我们建议您运行这些示例并进行实验，如果您有疑问或发现问题，请与我们联系。

概要

在这篇博文中，我们已经了解了如何开始使用新的Activiti Core Beta1项目中的新ProcessRuntime和TaskRuntime API。

我们建议您检查Activiti的例子库，为更多的例子：https://github.com/Activiti/activiti-examples

帮助我们编写更多这些示例可能是一个非常好的初始社区贡献。如果您有兴趣，请联系我们，我们非常乐意为您提供指导。

如果您对这些示例和教程有疑问或反馈，请随时通过Gitter与我们联系：https：//gitter.im/Activiti/Activiti7 ？ utm_source = share-link ＆ utm_medium = link ＆ utm_campaign = share-link 。

更多博客文章将介绍Runtime Admin API以及如何调整这些示例以在我们的新Activiti Cloud方法中执行。