FlowableBPMN用户手册

一、Flowable介绍 

        Flowable是BPMN的一个基于java的软件实现&＃xff0c;不过Flowable不仅仅包含BPMN&＃xff0c;还有BMN决策表和CMMN Case管理引擎&＃xff0c;并且有自己的用户管理、微服务API等一系列功能&＃xff0c;是一个微服务平台。

二、Flowbale基础

官方&＃xff1a;Flowable BPMN 用户手册 (v 6.3.0)

1、创建流程引擎

引入依赖

org.flowableflowable-engine6.3.0mysqlmysql-connector-java8.0.21junitjunit4.13.2test

获取流程引擎对象

public class Test01 {/*** 获取流程引擎对象*/&＃64;Testpublic void testProcessEngine() {// 获取 ProcessEngineConfiguration 对象ProcessEngineConfiguration configuration &＃61; new StandaloneProcessEngineConfiguration();// 配置 相关的数据库连接信息configuration.setJdbcDriver("com.mysql.cj.jdbc.Driver");configuration.setJdbcUsername("root");configuration.setJdbcPassword("zq&＃64;123456");// UTC是统一标准世界时间configuration.setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn?serverTimezone&＃61;UTC");// 如果数据库中的表结构不存在就新建configuration.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);// 通过 ProcessEngineConfiguration 构建 processEngine 对象ProcessEngine processEngine &＃61; configuration.buildProcessEngine();}
}

控制台提示日志没有正确配置&＃xff1a;

Flowable使用SLF4J作为内部日志框架。因此在pom.xml文件中添加下列依赖&＃xff1a;

org.slf4jslf4j-api1.7.21org.slf4jslf4j-log4j121.7.21

Log4j需要一个配置文件。

在src/main/resources文件夹下添加log4j.properties文件&＃xff0c;并写入下列内容&＃xff1a;

log4j.rootLogger&＃61;DEBUG, CAlog4j.appender.CA&＃61;org.apache.log4j.ConsoleAppender
log4j.appender.CA.layout&＃61;org.apache.log4j.PatternLayout
log4j.appender.CA.layout.ConversionPattern&＃61; %d{hh:mm:ss,SSS} [%t] %-5p %c %x - %m%n

重新运行应用&＃xff0c;可以看到关于引擎启动与创建数据库表结构的提示日志&＃xff1a;

flowable-engine6.3.0生成的表&＃xff1a; 

flowable-engine6.7.2生成的表&＃xff1a; 

数据库表名说明&＃xff1a;

Flowable的所有数据库表都以ACT_开头。第二部分是说明表用途的两字符标示符。服务API的命名也大略符合这个规则。

• ACT_RE_*: &＃39;RE’代表repository。带有这个前缀的表包含“静态”信息&＃xff0c;例如流程定义与流程资源&＃xff08;图片、规则等&＃xff09;。

• ACT_RU_*: &＃39;RU’代表runtime。这些表存储运行时信息&＃xff0c;例如流程实例&＃xff08;process instance&＃xff09;、用户任务&＃xff08;user task&＃xff09;、变量&＃xff08;variable&＃xff09;、作业&＃xff08;job&＃xff09;等。Flowable只在流程实例运行中保存运行时数据&＃xff0c;并在流程实例结束时删除记录。这样保证运行时表小和快。

• ACT_HI_*: &＃39;HI’代表history。这些表存储历史数据&＃xff0c;例如已完成的流程实例、变量、任务等。

• ACT_GE_*: 通用数据。在多处使用。

2、部署流程

我们要构建的流程是一个非常简单的请假流程。

Flowable引擎需要流程定义为BPMN 2.0格式&＃xff0c;这是一个业界广泛接受的XML标准。 在Flowable术语中&＃xff0c;我们将其称为一个流程定义(process definition)。一个流程定义可以启动多个流程实例(process instance)。流程定义可以看做是重复执行流程的蓝图。

在这个例子中&＃xff0c;流程定义定义了请假的各个步骤&＃xff0c;而一个流程实例对应某个雇员提出的一个请假申请。

BPMN 2.0存储为XML&＃xff0c;并包含可视化的部分&＃xff1a;使用标准方式定义了每个步骤类型&＃xff08;人工任务&＃xff0c;自动服务调用&＃xff0c;等等&＃xff09;如何呈现&＃xff0c;以及如何互相连接。这样BPMN 2.0标准使技术人员与业务人员能用双方都能理解的方式交流业务流程。

我们要使用的流程定义为&＃xff1a;

将下面的XML保存在src/main/resources文件夹下名为holiday-request.bpmn20.xml的文件中。

2.1 部署流程具体实现

ProcessEngineConfiguration configuration &＃61; null;&＃64;Before// import org.junit.Before; 在一个类中最先执行的方法public void before(){// 获取 ProcessEngineConfiguration 对象configuration &＃61; new StandaloneProcessEngineConfiguration();// 配置 相关的数据库连接信息configuration.setJdbcDriver("com.mysql.cj.jdbc.Driver");configuration.setJdbcUsername("root");configuration.setJdbcPassword("zq&＃64;123456");// UTC是统一标准世界时间configuration.setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn?serverTimezone&＃61;UTC");// 如果数据库中的表结构不存在就新建configuration.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);}/*** 部署流程*/&＃64;Testpublic void testDeploy(){// 1、获取 ProcessEngine 对象ProcessEngine processEngine &＃61; configuration.buildProcessEngine();// 2、获取RepositoryServiceRepositoryService repositoryService &＃61; processEngine.getRepositoryService();// 3、完成流程的部署操作Deployment deploy &＃61; repositoryService.createDeployment().addClasspathResource("holiday-request.bpmn20.xml") // 关联要部署的流程文件.name("请假流程").deploy(); // 部署流程System.out.println("deploy.getId() &＃61; " &＃43; deploy.getId());System.out.println("deploy.getName() &＃61; " &＃43; deploy.getName());}

act_ge_bytearray、act_re_deployment、act_re_procdef表可查看到相关信息。

2.2 查询操作

/*** 查询流程定义的信息*/&＃64;Testpublic void testDeployQuery() {ProcessEngine processEngine &＃61; configuration.buildProcessEngine();RepositoryService repositoryService &＃61; processEngine.getRepositoryService();// 查询单个ProcessDefinition processDefinition &＃61; repositoryService.createProcessDefinitionQuery().deploymentId("1").singleResult();System.out.println("processDefinition.getName() &＃61; " &＃43; processDefinition.getName());System.out.println("processDefinition.getId() &＃61; " &＃43; processDefinition.getId());System.out.println("processDefinition.getDeploymentId() &＃61; " &＃43; processDefinition.getDeploymentId());System.out.println("processDefinition.getDescription() &＃61; " &＃43; processDefinition.getDescription());}

2.3 删除操作

/*** 删除流程定义*/&＃64;Testpublic void testDeleteDeploy() {ProcessEngine processEngine &＃61; configuration.buildProcessEngine();RepositoryService repositoryService &＃61; processEngine.getRepositoryService();// 删除部署的流程 第一个参数id&＃xff0c;如果部署的流程启动了就不允许删除
// repositoryService.deleteDeployment("1");// 第二个参数是级联删除&＃xff0c;如果部署的流程启动了 相关的任务会一并被删除repositoryService.deleteDeployment("1", true);}

删除后&＃xff1a;act_ge_bytearray、act_re_deployment、act_re_procdef表相关信息都被删除

3、启动流程实例

/*** 启动流程实例*/&＃64;Testpublic void testRunProcess() {ProcessEngine processEngine &＃61; configuration.buildProcessEngine();// 通过RuntimeService启动流程实例RuntimeService runtimeService &＃61; processEngine.getRuntimeService();// 构建流程变量Map variables &＃61; new HashMap();variables.put("employee", "zhangsan");variables.put("nrOfHolidays", 3);variables.put("description", "累了&＃xff0c;休息休息");// 流程key ProcessInstance holidayRequest &＃61; runtimeService.startProcessInstanceByKey("holidayRequest", variables);System.out.println("holidayRequest.getProcessDefinitionId() &＃61; " &＃43; holidayRequest.getProcessDefinitionId());System.out.println("holidayRequest.getActivityId() &＃61; " &＃43; holidayRequest.getActivityId());System.out.println("holidayRequest.getId() &＃61; " &＃43; holidayRequest.getId());System.out.println("holidayRequest.getName() &＃61; " &＃43; holidayRequest.getName());}

act_ru_variable、 act_ru_task、act_ru_execution表可查看到相关信息。

此流程的deploymentId为5001&＃xff0c;此流程已启动&＃xff0c;删除时需级联删除。
如&＃xff1a;repositoryService.deleteDeployment("5001", true);

4、查询任务

在更实际的应用中&＃xff0c;会为雇员及经理提供用户界面&＃xff0c;让他们可以登录并查看任务列表。

其中可以看到作为流程变量存储的流程实例数据&＃xff0c;并决定如何操作任务。

4.1 分配处理人

在这个例子中&＃xff0c;我们还没有为用户任务配置办理人。我们想将第一个任务指派给"经理(managers)"组&＃xff0c;而第二个用户任务指派给请假申请的提交人。

为第一个任务添加candidateGroups属性&＃xff08;’managers’使用的静态值&＃xff09;&＃xff1a;

为第二个任务添加assignee属性&＃xff08;使用一个流程变量动态指派&＃xff0c;这个流程变量是在流程实例启动时传递的&＃xff09;&＃xff1a;

4.2 重新部署流程并启动流程实例

部署流程&＃xff1a;

启动流程实例&＃xff1a;

4.3 查询“managers”组的任务

/*** 测试任务查询*/&＃64;Testpublic void testQueryTask() {ProcessEngine processEngine &＃61; configuration.buildProcessEngine();TaskService taskService &＃61; processEngine.getTaskService();// 查询“managers”组的任务List tasks &＃61; taskService.createTaskQuery().taskCandidateGroup("managers").list();System.out.println("You have " &＃43; tasks.size() &＃43; " tasks:");for (Task task : tasks) {System.out.println("task.getId() &＃61; " &＃43; task.getId());System.out.println("task.getProcessDefinitionId() &＃61; " &＃43; task.getProcessDefinitionId());System.out.println("task.getDescription() &＃61; " &＃43; task.getDescription());System.out.println("task.getTaskDefinitionId() &＃61; " &＃43; task.getTaskDefinitionId());System.out.println("task.getTaskLocalVariables() &＃61; " &＃43; task.getTaskLocalVariables());}}

5、处理任务

在BPMN 2.0 XML中&＃xff0c;这是一个服务任务(service task)&＃xff1a;

创建一个相关类填入org.flowable作为包名&＃xff0c;CallExternalSystemDelegate作为类名。让这个类实现org.flowable.engine.delegate.JavaDelegate接口&＃xff0c;并实现execute方法&＃xff1a;

package org.flowable;import org.flowable.engine.delegate.DelegateExecution;
import org.flowable.engine.delegate.JavaDelegate;public class CallExternalSystemDelegate implements JavaDelegate {&＃64;Overridepublic void execute(DelegateExecution execution) {// 触发执行的逻辑 请假申请通过System.out.println("请假申请通过");System.out.println("Calling the external system for employee "&＃43; execution.getVariable("employee"));}
}


创建一个相关类填入org.flowable作为包名&＃xff0c;SendRejectionMail 作为类名。让这个类实现org.flowable.engine.delegate.JavaDelegate接口&＃xff0c;并实现execute方法&＃xff1a;

package org.flowable;import org.flowable.engine.delegate.DelegateExecution;
import org.flowable.engine.delegate.JavaDelegate;public class SendRejectionMail implements JavaDelegate {&＃64;Overridepublic void execute(DelegateExecution execution) {// 触发执行的逻辑 被拒绝的员工发送通知的邮件System.out.println("不好意思&＃xff0c;你的请假申请被拒绝......安心工作");}
}


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

5.1 请假申请通过

/*** 完成当前任务*/&＃64;Testpublic void testCompleteTask() {ProcessEngine processEngine &＃61; configuration.buildProcessEngine();TaskService taskService &＃61; processEngine.getTaskService();Task task &＃61; taskService.createTaskQuery().processDefinitionId("holidayRequest:1:10003").taskCandidateGroup("managers").singleResult();// 创建流程bianlMap map &＃61; new HashMap<>();map.put("approved", true);// 完成taskService.complete(task.getId(), map);}

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

现在执行这个例子的时候&＃xff0c;就会显示出日志信息&＃xff0c;说明已经执行了自定义逻辑&＃xff1a;

5.2 请假申请不通过

/*** 完成当前任务*/&＃64;Testpublic void testCompleteTask() {ProcessEngine processEngine &＃61; configuration.buildProcessEngine();TaskService taskService &＃61; processEngine.getTaskService();Task task &＃61; taskService.createTaskQuery().processDefinitionId("holidayRequest:3:20003").taskCandidateGroup("managers").singleResult();// 创建流程bianlMap map &＃61; new HashMap<>();map.put("approved", false);// 完成taskService.complete(task.getId(), map);}

日志信息&＃xff1a;

6、历史任务查询

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

例如&＃xff0c;如果希望显示流程实例已经执行的时间&＃xff0c;就可以从ProcessEngine获取HistoryService&＃xff0c;并创建历史活动(historical activities)的查询。

/*** 获取流程任务的历史数据*/&＃64;Testpublic void testHistory() {ProcessEngine processEngine &＃61; configuration.buildProcessEngine();HistoryService historyService &＃61; processEngine.getHistoryService();List list &＃61; historyService.createHistoricActivityInstanceQuery().processDefinitionId("holidayRequest:3:20003").finished() // 查询历史记录的状态是已完成.orderByHistoricActivityInstanceEndTime().asc() // 指定排序的字段和顺序.list();for (HistoricActivityInstance historicActivityInstance : list) {System.out.println(historicActivityInstance.getId() &＃43; ":" &＃43; historicActivityInstance.getActivityName() &＃43; ":" &＃43; historicActivityInstance.getAssignee()&＃43; ":" &＃43; historicActivityInstance.getActivityId() &＃43; ":" &＃43; historicActivityInstance.getDurationInMillis() &＃43; "毫秒");}}

三、Flowable UI应用

1. 下载最新稳定版本的Apache Tomcat。

2. 下载最新稳定版本的Flowable 6。

3. 将Flowable发行包中&＃xff0c;wars文件夹下的flowable-admin.war、flowable-idm.war、flowable-modeler.war与flowable-task.war文件&＃xff0c;复制到Tomcat的webapps文件夹下。

4. 运行bin/startup.sh&＃xff08;在Mac OS或Linux下&＃xff09;&＃xff0c;或bin/startup.bat&＃xff08;在Windows下&＃xff09;脚本&＃xff0c;启动Tomcat服务器。

5. 打开web浏览器&＃xff0c;访问Flowable IDM&＃xff0c;默认账号admin 密码test