Flowable基础

一、Flowable介绍

Flowable是BPMN基于java的软件，但Flowable不仅包括BPMN，还包括DMN决策表和CMMN Case管理引擎，并具有自己的用户管理、微服务API等一系列功能，是一个服务平台。

官方手册：https://tkjohn.github.io/flowable-userguide/#_introduction

  创建一个基本的maven项目，可以是Eclipse或其他IDEA。然后添加两个依赖性

• Flowable流程引擎。让我们创建一个Procesengine流程引擎对象，并访问Flowable API。
• 一个是MySQL的数据库驱动

在pom.xml将以下行添加到文件中：

<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.21</version></dependency>

然后创建一个普通的Java类别，添加相应的main方法，首先要做的是Procesengine流程引擎的初始化实例。这是一个线程安全的对象，所以它通常只需要在一个应用程序中初始化一次。 ProcessEngine由ProcesengineConfiguration实例创建。该实例可以配置和调整流程引擎的设置。 配置XML文件通常用于创建ProcessEngineConfiguration，但是(就像在这里做的一样)也可以通过编程创建它。 ProcessEngineConfiguration数据库JDBC连接所需的最小配置：

public static void main(String[] args) {    ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()        .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn?serverTimezone=UTC")        .setJdbcUsername("root")        .setJdbcPassword("123456")        .setJdbcDriver("com.mysql.cj.jdbc.Driver")        .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);    ProcessEngine processEngine = cfg.buildProcessEngine();}

 注意以下错误可能发生在mysql8.0中

在这种情况下，只需在mysql的连接字符串中添加nullcatalogMeanscurentent=true，设置为只检查当前连接的schema库。

public static void main(String[] args) {    ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()            .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn1serverTimezone=UTC&nullCatalogMeansCurrent=true")            .setJdbcUsername("root")            .setJdbcPassword("123456")            .setJdbcDriver("com.mysql.cj.jdbc.Driver")            .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);    ProcessEngine processEngine = cfg.buildProcessEngine();}

 然后应用程序运行没有问题，但控制台没有提供有用的信息，只有一个信息提示日志没有正确配置。使用FlowableSLF4J作为内部日志框架。在这个例子中，我们使用log4j作为SLF4J的实现。因此，pom.以下依赖添加到xml文件中： 然后应用程序运行没有问题，但控制台上没有提供有用的信息，只有一个信息提示日志没有正确配置。Flowable使用SLF4J作为内部日志框架。在这个例子中，我们使用log4j作为SLF4J的实现。所以在pom.以下依赖添加到xml文件中：

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

Log4j需要配置文件。在src/main/resources添加文件夹log4j.properties并写入以下内容：

log4j.rootLogger=DEBUG, CAlog4j.appender.CA=org.apache.log4j.consoleapenderlog4j.appender.CA.layout=org.apache.log4j.Patternlayoutlog4j.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)。流程定义可视为重复执行过程的蓝图。 这个例子中，流程定义定义请假的每一步，一个流程实例与员工提出的请假申请相对应。

BPMN 2.0存储为XML，并包含可视化部分：使用标准定义每个步骤类型（手动任务、自动服务呼叫等），以及如何相互连接。所以BPMN 2.0标准使技术人员和业务人员能够以双方都能理解的方式沟通业务流程。

我们要使用的流程定义为：

流程定义说明：

• 假设启动过程需要提供一些信息，如员工名称、请假时间和说明。当然，这些可以单独建模为流程的第一步。 但是，如果将其作为流程的“输入信息”，则可以确保只有在实际请求中才能建立流程实例。否则(将提交作为流程的第一步)，用户可能会在提交前改变主意并取消，但已经创建了流程实例。 在某些情况下，根据业务目标，可能会影响重要指标（例如，有多少应用程序已经启动，但尚未完成）。
• 左边的圆圈称为启动事件(start event)。这是一个流程实例的起点。
• 第一个矩形是用户任务(user task)。这是用户操作过程中的步骤。在这个例子中，经理需要批准或拒绝申请
• 排他网关取决于经理的决定(exclusive gateway) (带叉的菱形)将流程实例路由批准或拒绝路径
• 如果批准，您需要将申请注册为外部系统，并根据另一个用户任务通知申请人经理的决定。当然，您也可以更改为发送电子邮件。
• 如果拒绝，给员工发邮件通知他。

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

BPMN与上面显示的流程图对应 2.0 XML显示在下面。请注意，这只包含“过程部分”。如果使用图形建模工具，实际的XML文件还将包含“可视化部分”来描述图形信息，如过程定义中各元素的坐标（XML中包含的所有图形信息）BPMNDiagram作为标签definitions标签的子元素)。

保存下面的XMLsrc/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 XML文件需要部署***(deploy)\****到引擎。部署一个过程定义意味着：

• 流程引擎将XML文件存储在数据库中，以便在必要时获得它
• 将流程定义转换为内部可执行的对象模型，使其能够启动流程实例。

将流程定义部署需要使用Flowable引擎RepositoryService，其可以从ProcessEngine获取对象。使用RepositoryService，可以通过XML文件的路径创建新的路径部署(Deployment)，并调用*deploy()*实际实施方法:

/**     * 部署流程     */    @Test    public void testDeploy(){        // 配置数据库相关信息 获取 ProcessEngineConfiguration        ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()                .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn2serverTimezone=UTC&nullCatalogMeansCurrent=true")                .setJdbcUsername("root")                .setJdbcPassword("123456")                .setJdbcDriver("com.mysql.cj.jdbc.Driver")                .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);        // 获取流程引擎对象        ProcessEngine processEngine = cfg.buildProcessEngine();        // 部署流程 RepositoryService对象获得        RepositoryService repositoryService = processEngine.getRepositoryService();        Deployment deployment = repositoryService.createDeployment()// 创建Deployment对象                .addClasspathResource("holiday-request.bpmn20.xml") // 添加流程部署文件                .name(“请求流程”) // 设置部署过程的名称                .deploy(); // 执行部署操作        System.out.println("deployment.getId() = " + deployment.getId());        System.out.println("deployment.getName() = " + deployment.getName());    }

然后成功执行该方法的日志操作：

相关信息也可以在后台表结构中看到

act_re_deployment: 每次部署过程定义部署表时，添加一个记录

act_re_procdef ：对于流程定义表，部署每个新的流程定义将在此表中添加一个记录

act_ge_bytearray ：流程资源表、流程部署 本表将保存bpmn文件和png图片

  通过API查询验证流程定义，我们现在可以部署在引擎中(并学习一些API)。通过RepositoryService创建的ProcessDefinitionQuery对象实现。

/**     * 查看流程定义     */    @Test    public void testDeployQuery(){        // 配置数据库相关信息 获取 ProcessEngineConfiguration        ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()                .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn2serverTimezone=UTC&nullCatalogMeansCurrent=true")                .setJdbcUsername("root")                .setJdbcPassword("123456")                .setJdbcDriver("com.mysql.cj.jdbc.Driver")                .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);        // 获取流程引擎对象        ProcessEngine processEngine = cfg.buildProcessEngine();        // 部署流程 RepositoryService对象获得        RepositoryService repositoryService = processEngine.getRepositoryService();        // 获取流程定义对象        ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()                .deploymentId("2501")                .singleResult();        System.out.println("processDefinition.getId() = " + processDefinition.getId());        System.out.println("processDefinition.getName() = " + processDefinition.getName());        System.out.println("processDefinition.getDeploymentId() = " + processDefinition.getDeploymentId());        System.out.println("processDefinition.getDescription() = " + processDefinition.getDescription());    }

输出结果为：

processDefinition.getId() = holidayRequest:2:2503procesdefinition.getName() = Holiday RequestprocessDefinition.getDeploymentId() = 2501procesdefinition.getDescription() = null

  现在已经在流程引擎中了部署这个可以用于流程定义，因此流程定义启动“模板”流程实例。

  要启动流程实例，需要提供一些初始化流程变量。一般来说，当流程由其他系统自动触发时，可以通过向用户呈现表单或REST API，为了获得这些变量。在这个例子中，我们简化并直接在代码中定义，我们使用它RuntimeService启动一个流程实例。

/**     * 启动过程实例     */    @Test    public void testRunProcess(){        // 配置数据库相关信息 获取 ProcessEngineConfiguration        ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()                .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn2serverTimezone=UTC&nullCatalogMeansCurrent=true")                .setJdbcUsername("root")                .setJdbcPassword("123456")                .setJdbcDriver("com.mysql.cj.jdbc.Driver")                .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);        // 获取流程引擎对象        ProcessEngine processEngine = cfg.buildProcessEngine();        // 启动过程实例通过 RuntimeService 对象        RuntimeService runtimeService = processEngine.getRuntimeService();        // 施工过程变量        Map<String,Object> variables = new HashMap<>();        variables.put("employee"张三" ;// 谁申请请假        variables.put("nrOfHolidays",3); // 请几天假        variables.put("description“工作累了，想出去玩”); // 请假的原因        // 启动过程实例，第一个参数是流程定义的id        ProcessInstance processInstance = runtimeService                .startProcessInstanceByKey("holidayRequest", variables);// 启动过程实例        // 输出相关流程实例信息        System.out.println(”流程定义的ID：" + processInstance.getProcessDefinitionId());        System.out.println(”流程实例的ID：" + processInstance.getId());        System.out.println(”当前活动的ID：" + processInstance.getActivityId());    }

成功启动，输出结果如下：

流ID的程定义：holidayRequest:2:ID2503流程实例：5001当前活动的ID：null

相应的流程实例ID为：5001

启动过程实例中涉及的表结构：

• act_hi_actinst 流程实例执行历史
• act_hi_identitylink 参与用户历史信息的过程
• act_hi_procinst 历史信息的过程实例
• act_hi_taskinst 流程任务的历史信息
• act_ru_execution 流程执行信息
• act_ru_identitylink 参与用户信息的过程
• act_ru_task 任务信息

  以上员工发起了请假流程，然后转到总经理处理。我们以前没有指定经理的处理人。我们可以添加一个

  然后我们来看看lisi的任务

/**     * 查看任务     */    @Test    public void testQueryTask(){        // 配置数据库相关信息 获取 ProcessEngineConfiguration        ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()                .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn2serverTimeznotallow=UTC&nullCatalogMeansCurrent=true")                .setJdbcUsername("root")                .setJdbcPassword("123456")                .setJdbcDriver("com.mysql.cj.jdbc.Driver")                .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);        // 获取流程引擎对象        ProcessEngine processEngine = cfg.buildProcessEngine();        TaskService taskService = processEngine.getTaskService();        List<Task> list = taskService.createTaskQuery()                .processDefinitionKey("holidayRequestNew")                .taskAssignee("lisi")                .list();        for (Task task : list) {            System.out.println("task.getProcessDefinitionId() = " + task.getProcessDefinitionId());            System.out.println("task.getId() = " + task.getId());            System.out.println("task.getAssignee() = " + task.getAssignee());            System.out.println("task.getName() = " + task.getName());        }    }

输出结果为：

task.getProcessDefinitionId() = holidayRequestNew:1:10003task.getId() = 12508task.getAssignee() = lisitask.getName() = Approve or reject request

  现在李四这个角色可以完成当前的任务了

  在这里，我们将直接解决这个请假问题，然后通过发送拒绝邮件的过程，我们需要使用Javadelegate来触发。

我们定义了这样一个Java类

public class SendRejectionMail implements JavaDelegate {    /**     * 触发电子邮件的操作     * @param delegateExecution     */    @Override    public void execute(DelegateExecution delegateExecution) {        System.out.println(”拒绝请假，,,安心工作吧”);    }}

然后完成任务

/**     * 完成任务     */    @Test    public void testCompleteTask(){        // 配置数据库相关信息 获取 ProcessEngineConfiguration        ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()                .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn2serverTimeznotallow=UTC&nullCatalogMeansCurrent=true")                .setJdbcUsername("root")                .setJdbcPassword("123456")                .setJdbcDriver("com.mysql.cj.jdbc.Driver")                .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);        // 获取流程引擎对象        ProcessEngine processEngine = cfg.buildProcessEngine();        TaskService taskService = processEngine.getTaskService();        Task task = taskService.createTaskQuery()                .processDefinitionKey("holidayRequestNew")                .taskAssignee("lisi")                .singleResult();        // 添加工艺变量        Map<String,Object> variables = new HashMap<>();        variables.put("approved",false); // 拒绝请假        // 完成任务        taskService.complete(task.getId(),variables);    }

然后你可以看到Javadelegate触发

  有些过程已经没用了，我们需要删除，但也很简单

/**     * 删除流程     */    @Test    public void testDeleteProcess(){        // 配置数据库相关信息 获取 ProcessEngineConfiguration        ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()                .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn2serverTimeznotallow=UTC&nullCatalogMeansCurrent=true")                .setJdbcUsername("root")                .setJdbcPassword("123456")                .setJdbcDriver("com.mysql.cj.jdbc.Driver")                .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);        // 获取流程引擎对象        ProcessEngine processEngine = cfg.buildProcessEngine();        RepositoryService repositoryService = processEngine.getRepositoryService();        // 删除流程定义，如果流程定义已经有流程实例启动，则删除时报错误        // repositoryService.deleteDeployment("1");        // 设置为TRUE 级联删除流程定义，有实例及时启动流程，也可以删除，设置为false 非级联删除操作。        repositoryService.deleteDeployment("2501",true);    }

  选择使用Flowable等流程引擎的原因之一是它可以自动存储所有流程实例的审计数据或历史数据。这些数据可以用来创建报告并深入显示组织运行情况，瓶颈在哪里等等。

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

• 只选择具体流程实例的活动
• 只选择已完成的活动

  结果按结束时间排序，代表其执行顺序。

/**     * 查看历史     */    @Test    public void testQueryHistory(){        // 配置数据库相关信息 获取 ProcessEngineConfiguration        ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()                .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn2serverTimeznotallow=UTC&nullCatalogMeansCurrent=true")                .setJdbcUsername("root")                .setJdbcPassword("123456")                .setJdbcDriver("com.mysql.cj.jdbc.Driver")                .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);        // 获取流程引擎对象        ProcessEngine processEngine = cfg.buildProcessEngine();        HistoryService historyService = processEngine.getHistoryService();        List<HistoricActivityInstance> list = historyService.createHistoricActivityInstanceQuery()                .processDefinitionId("holidayRequestNew:1:10003")                .finished()                .orderByHistoricActivityInstanceEndTime().asc()                .list();        for (HistoricActivityInstance historicActivityInstance : list) {            System.out.println(historicActivityInstance.getActivityId() + " took "                    + historicActivityInstance.getDurationInMillis() + " milliseconds");        }    }

输出结果

startEvent took 1 millisecondsapproveTask took 837735 millisecondsdecision took 13 millisecondssendRejectionMail took 2 millisecondsrejectEnd took 1 milliseconds