【Flowable】Flowable工作流教程

2023-11-20

开始

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流程引擎，介绍一些核心概念，并展示如何使用API。

我们将构建的例子是一个简单的请假(holiday request)流程：

雇员(employee)申请几天的假期
经理(manager)批准或驳回申请
我们会模拟将申请注册到某个外部系统，并给雇员发送结果邮件

创建Maven项目（以idea举例）

New project --> 选择左侧Maven–>不需要勾选其他直接点击next
在这里插入图片描述

输入项目名称指定目录创建

在这里插入图片描述

这样就建立了空的Maven项目，为项目添加3个依赖：

Flowable流程引擎。使我们可以创建一个ProcessEngine流程引擎对象，并访问Flowable API。
一个内存数据库。因为Flowable引擎在运行流程实例时，需要使用数据库来存储执行与历史数据。
日志框架。Flowable使用SLF4J作为内部日志框架。本例中，我们使用log4j作为SLF4J的实现。
在pom.xml文件中添加下列行：

<dependencies>
  <dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-engine</artifactId>
    <version>6.3.0</version>
  </dependency>
  <dependency>
     <groupId>mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     <version>8.0.30</version>
  </dependency>
  <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.21</version>
  </dependency>
  <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.21</version>
  </dependency>
</dependencies>

如果由于某些原因，依赖JAR无法自动获取，可以右键点击项目，并选择’Maven → Update Project’以强制手动刷新（一般不会需要这么操作）。在这个项目中的’Maven Dependencies’下，可以看到flowable-engine与许多其他（传递的）依赖。

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

public class HolidayRequest {
    public static void main(String[] args) {
        
    }
}

首先要做的是初始化ProcessEngine流程引擎实例。创建一个ProcessEngineConfiguration实例 ，并配置数据库JDBC连接。然后由ProcessEngineConfiguration创建ProcessEngine实例。

在这里插入图片描述

在上面的代码中

第9行创建了一个独立(standalone)配置对象。这里的’独立’指的是引擎是完全独立创建及使用的（而不是在Spring环境中使用，这时需要使用SpringProcessEngineConfiguration类代替）。
第10至13行中，传递了一个内存Mysql数据库实例的JDBC连接参数。
第14行中，设置了true，确保在JDBC参数连接的数据库中，数据库表结构不存在时，会创建相应的表结构。 另外，Flowable也提供了一组SQL文件，可用于手动创建所有表的数据库表结构
第16行表示我们通过ProcessEngineConfiguration创建了一个ProcessEngine实例对象

然后我们运行main方法。

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

然后我们打开数据库管理工具查看数据库表结构，可以看到对应的表flowable都帮我们创建好了，我们后续就可以在这个里面操作：
在这里插入图片描述

Flowable使用SLF4J作为内部日志框架。在这个例子中，我们使用log4j作为SLF4J的实现。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

然后开始我们的案列开发

部署流程定义

我们要构建的流程是一个非常简单的请假流程。Flowable引擎需要流程定义为BPMN 2.0格式，这是一个业界广泛接受的XML标准。在Flowable术语中，我们将其称为一个流程定义(process definition)。一个流程定义可以启动多个流程实例(process instance)。流程定义可以看做是重复执行流程的蓝图。在这个例子中，流程定义定义了请假的各个步骤，而一个流程实例对应某个雇员提出的一个请假申请。

我们要使用的流程定义为：在这里插入图片描述
这个流程应该已经十分自我解释了。但为了明确起见，说明一下几个要点：

我们假定启动流程需要提供一些信息，例如雇员名字、请假时长以及说明。当然，这些可以单独建模为流程中的第一步。但是如果将它们作为流程的“输入信息”，就能保证只有在实际请求时才会建立一个流程实例。否则（将提交作为流程的第一步），用户可能在提交之前改变主意并取消，但流程实例已经创建了。在某些场景中，就可能影响重要的指标（例如启动了多少申请，但还未完成），取决于业务目标。
·左侧的圆圈叫做启动事件(start event)。这是一个流程实例的起点·。
第一个矩形是一个用户任务(user task)。这是流程中人类用户操作的步骤。在这个例子中，经理需要批准或驳回申请。
取决于经理的决定，排他网关(exclusive gateway) (带叉的菱形)会将流程实例路由至批准或驳回路径。
如果批准，则需要将申请注册至某个外部系统，并跟着另一个用户任务，将经理的决定通知给申请人。当然也可以改为发送邮件。
如果驳回，则为雇员发送一封邮件通知他。

一般来说，这样的流程定义使用可视化建模工具建立，如Flowable Designer(Eclipse)或Flowable Web Modeler(Web应用)。但在这里我们直接撰写XML，以熟悉BPMN 2.0及其概念。

将下面的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">

  <process id="holidayRequest" name="Holiday Request" isExecutable="true">

    <startEvent id="startEvent"/>
    <sequenceFlow sourceRef="startEvent" targetRef="approveTask"/>

    <userTask id="approveTask" name="Approve or reject request"/>
    <sequenceFlow sourceRef="approveTask" targetRef="decision"/>

    <exclusiveGateway id="decision"/>
    <sequenceFlow sourceRef="decision" targetRef="externalSystemCall">
      <conditionExpression xsi:type="tFormalExpression">
        <![CDATA[
          ${approved}
        ]]>
      </conditionExpression>
    </sequenceFlow>
    <sequenceFlow  sourceRef="decision" targetRef="sendRejectionMail">
      <conditionExpression xsi:type="tFormalExpression">
        <![CDATA[
          ${!approved}
        ]]>
      </conditionExpression>
    </sequenceFlow>

    <serviceTask id="externalSystemCall" name="Enter holidays in external system"
        flowable:class="org.flowable.CallExternalSystemDelegate"/>
    <sequenceFlow sourceRef="externalSystemCall" targetRef="holidayApprovedTask"/>

    <userTask id="holidayApprovedTask" name="Holiday approved"/>
    <sequenceFlow sourceRef="holidayApprovedTask" targetRef="approveEnd"/>

    <serviceTask id="sendRejectionMail" name="Send out rejection email"
        flowable:class="org.flowable.SendRejectionMail"/>
    <sequenceFlow sourceRef="sendRejectionMail" targetRef="rejectEnd"/>

    <endEvent id="approveEnd"/>

    <endEvent id="rejectEnd"/>

  </process>

</definitions>

每一个步骤（在BPMN 2.0术语中称作活动(activity）都有一个id属性，为其提供一个在XML文件中唯一的标识符。所有的活动都可以设置一个名字，以提高流程图的可读性。

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

离开排他网关(带有X的菱形)的顺序流很特别：都以表达式(expression)的形式定义了条件(condition) 。当流程实例的执行到达这个网关时，会计算条件，并使用第一个计算为true的顺序流。这就是排他的含义：只选择一个。

这里用作条件的表达式为"$ {approved}"，这是${approved == true}的简写。变量’approved’被称作流程变量。

现在我们已经有了流程BPMN 2.0 XML文件，下来需要将它部署(deploy)到引擎中（还是在我们main方法中添加）。

RepositoryService repositoryService = processEngine.getRepositoryService();
        Deployment deployment = repositoryService.createDeployment()
                .addClasspathResource("holiday-request.bpmn20.xml")
                .name("员工请假流程")
                .deploy();

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

ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
  .deploymentId(deployment.getId())
  .singleResult();
System.out.println("定义流程的名称 : " + processDefinition.getName());

启动一个流程

现在已经在流程引擎中部署了流程定义，因此可以使用这个流程定义作为“蓝图”启动流程实例。

要启动流程实例，需要提供一些初始化流程变量。一般来说，可以通过呈现给用户的表单，或者在流程由其他系统自动触发时通过REST API，来获取这些变量。在这个例子里，我们简化为使用java.util.Scanner类在命令行输入一些数据：

//4模拟信息
        Scanner scanner = new Scanner(System.in);
        System.out.println("姓名");
        String employee = scanner.nextLine();
        System.out.println("请假时长");
        Integer nrOfHolidays = Integer.valueOf(scanner.nextLine());
        System.out.println("请假原因");
        String description = scanner.nextLine();

我们使用RuntimeService启动一个流程实例。收集的数据作为一个java.util.Map实例传递,其中的键就是之后用于获取变量的标识符。这个流程实例使用key启动。这个key就是BPMN 2.0 XML文件中设置的id属性，在这个例子里是holidayRequest。

<process id="holidayRequest" name="请假流程" isExecutable="true"> //这个id是我们流程的key

将用户录入的信息保存到map中，作为流程变量

		Map<String, Object> maps = new HashMap<String, Object>();
        maps.put("employee", employee);
        maps.put("nrOfHolidays", nrOfHolidays);
        maps.put("description", description);
		ProcessInstance processInstance =
  			runtimeService.startProcessInstanceByKey("holidayRequest", variables);

在流程实例启动后，会创建一个执行(execution)，并将其放在启动事件上。从这里开始，这个执行沿着顺序流移动到经理审批的用户任务，并执行用户任务行为。这个行为将在数据库中创建一个任务，该任务可以之后使用查询找到。用户任务是一个等待状态(wait state)，引擎会停止执行，返回API调用处。

启动任务后我们需要完成任务，我们来实现操作查询任务并且完成任务

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

在xml文件中添加flowable:candidateGroups="managers"
如下：
<userTask id="approveTask" name="Approve or reject request" flowable:candidateGroups="managers"/>

并如下所示为第二个任务添加assignee属性。请注意我们没有像上面的’managers’一样使用静态值，而是使用一个流程变量动态指派。这个流程变量是在流程实例启动时传递的：

<userTask id="holidayApprovedTask" name="Holiday approved" flowable:assignee="${employee}"/>

要获得实际的任务列表，需要通过TaskService创建一个TaskQuery。我们配置这个查询只返回’managers’组的任务：

		//6创建任务流程对象
        TaskService taskService = processEngine.getTaskService();
        //7根据组名称来查询代办任务
        List<Task> tasks = taskService.createTaskQuery()
        		.taskCandidateGroup("managers")
        		.list();
        System.out.println("你有" + tasks.size() + "个任务");
        for (int i = 0; i < tasks.size(); i++) {
            System.out.println((i + 1) + ")" + tasks.get(i).getName() + "：编号为" + (i + 1));
        }

可以使用任务Id获取特定流程实例的变量，并在屏幕上显示实际的申请：

System.out.println("你想处理哪个任务?");
        Integer taskIndex = Integer.valueOf(scanner.nextLine());
        Task task = tasks.get(taskIndex - 1);
        //通过任务id获取在流程中的信息
        Map<String, Object> variables = taskService.getVariables(task.getId());
        System.out.println(variables.get("employee") + "想请假" + 
        					variables.get("nrOfHolidays") + "天，请假理由是：" +
               				 variables.get("description") + "，是否同意请假？(y/n)");

经理现在就可以完成任务了。在现实中，这通常意味着由用户提交一个表单。表单中的数据作为流程变量传递。在这里，我们在完成任务时传递带有’approved’变量（这个名字很重要，因为之后会在顺序流的条件中使用！）的map来模拟：

	boolean approved = scanner.nextLine().toLowerCase().equals("y");
	variables = new HashMap<String, Object>();
	variables.put("approved", approved);
	taskService.complete(task.getId(), variables);

现在任务完成，并会在离开排他网关的两条路径中，基于’approved’流程变量选择一条。

实现自动逻辑(JavaDelegate)

我们还没有实现申请通过后执行的自动逻辑。在BPMN 2.0 XML中，这是一个服务任务(service task)：

在XML中找到下面的代码：

<serviceTask id="externalSystemCall" name="Enter holidays in external system"
    flowable:class="org.flowable.CallExternalSystemDelegate"/>

在现实中，这个逻辑可以做任何事情，创建一个新的类，填入org.flowable作为包名，CallExternalSystemDelegate作为类名。让这个类实现org.flowable.engine.delegate.JavaDelegate接口，并实现execute方法：

package org.flowable;

import org.flowable.engine.delegate.DelegateExecution;
import org.flowable.engine.delegate.JavaDelegate;

public class CallExternalSystemDelegate implements JavaDelegate {

    public void execute(DelegateExecution execution) {
        System.out.println("审批用户通过"
            + execution.getVariable("employee"));
    }

}

当执行到达服务任务时，会初始化并调用BPMN 2.0 XML中所引用的类。

查询历史数据

如果希望显示流程实例已经执行的时间，就可以从ProcessEngine获取HistoryService，并创建历史活动(historical activities)的查询。在下面的代码片段中，可以看到我们添加了一些额外的过滤条件：

只选择一个特定流程实例的活动
只选择已完成的活动

//查询历史数据
        HistoryService historyService = processEngine.getHistoryService();
        List<HistoricActivityInstance> histories = historyService.createHistoricActivityInstanceQuery()
        .finished()
        .orderByHistoricActivityInstanceStartTime()
        .desc()
        .list();
        for (HistoricActivityInstance history : histories) {
            System.out.println(history.getActivityId() + " == id, 耗时" + 
            history.getDurationInMillis() + "ms");
        }

完整代码：

//4模拟信息
        Scanner scanner = new Scanner(System.in);
        System.out.println("姓名");
        String employee = scanner.nextLine();
        System.out.println("请假时长");
        Integer nrOfHolidays = Integer.valueOf(scanner.nextLine());
        System.out.println("请假原因");
        String description = scanner.nextLine();

        Map<String, Object> maps = new HashMap<String, Object>();
        maps.put("employee", employee);
        maps.put("nrOfHolidays", nrOfHolidays);
        maps.put("description", description);

        //5使用引擎部署流程
        ProcessInstance processInstance = processEngine.getRuntimeService().startProcessInstanceByKey("holidayRequest", maps);

        //6创建任务流程对象
        TaskService taskService = processEngine.getTaskService();
        //7根据组名称来查询代办任务
        List<Task> tasks = taskService.createTaskQuery().taskCandidateGroup("managers").list();
        System.out.println("你有" + tasks.size() + "个任务");
        for (int i = 0; i < tasks.size(); i++) {
            System.out.println((i + 1) + ")" + tasks.get(i).getName() + "：编号为" + (i + 1));
        }
        System.out.println("你想处理哪个任务?");
        Integer taskIndex = Integer.valueOf(scanner.nextLine());
        Task task = tasks.get(taskIndex - 1);
        //通过任务id获取在流程中的信息
        Map<String, Object> variables = taskService.getVariables(task.getId());
        System.out.println(variables.get("employee") + "想请假" + variables.get("nrOfHolidays") + "天，请假理由是：" +
                variables.get("description") + "，是否同意请假？(y/n)");
        //判断审批是否通过
        boolean approved = scanner.nextLine().toLowerCase().equals("y");
        variables = new HashMap<String, Object>();
        variables.put("approved", approved);
        //保存意见，完成任务（不保存否则任务完成后找不到）
        if (approved) {
            Comment comment = taskService.addComment(task.getId(), processInstance.getProcessInstanceId(), "同意休假");
            comment.setUserId("manager");
            taskService.saveComment(comment);
        } else {
            Comment comment = taskService.addComment(task.getId(), processInstance.getProcessInstanceId(), "不同意休假");
            comment.setUserId("manager");
            taskService.saveComment(comment);
        }
        //处理任务
        taskService.complete(task.getId(), variables);

        //查询申请人的任务
        tasks = taskService.createTaskQuery().taskAssignee(employee).list();
        if (tasks.size() > 0) {
            //如果有任务则处理，获取处理任务的编号
            System.out.println("你有" + tasks.size() + "个任务，编号为" + (tasks.size() - (tasks.size() - 1)));
            task = tasks.get(Integer.parseInt(scanner.nextLine()) - 1);
            //通过任务id获取到流程里的变量信息
            variables = taskService.getVariables(task.getId());
            System.out.println("你好" + variables.get("employee") + "先生，您的假期一共有" + variables.get("nrOfHolidays") + "天，请享用");
            //完成任务
            Comment comment = taskService.addComment(task.getId(), processInstance.getId(), variables.get("employee") + "休假中");
            comment.setUserId("employee");
            taskService.saveComment(comment);
            taskService.complete(task.getId(), new HashMap<String, Object>());
        }

        //展示审批意见
        List<Comment> comments = taskService.getProcessInstanceComments(processInstance.getId());
        for (Comment comment : comments) {
            System.out.println("审批人" + comment.getUserId() + "，审批时间" + comment.getTime() + "，审批意见" + comment.getFullMessage());
        }

        //查询历史数据
        HistoryService historyService = processEngine.getHistoryService();
        List<HistoricActivityInstance> histories = historyService.createHistoricActivityInstanceQuery().finished().orderByHistoricActivityInstanceStartTime().desc().list();
        for (HistoricActivityInstance history : histories) {
            System.out.println(history.getActivityId() + " == id, 耗时" + history.getDurationInMillis() + "ms");
        }

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)