Flowable 基础篇1
Flowable介绍
Flowable是BPMN的一个基于java的软件实现，不过Flowable不仅仅包括BPMN，还有DMN决策表和CMMN Case管理引擎，并且有自己的用户管理、微服务API等一系列功能，是一个服务平台。
Flowable基础
官方手册：Flowable BPMN 用户手册 (v 6.3.0)
1、创建工作流引擎ProcessEngine
创建一个基本的maven工程，可以是Eclipse也可以是其他IDEA。然后添加两个依赖
-
Flowable流程引擎。使我们可以创建一个ProcessEngine流程引擎对象，并访问Flowable API。
-
一个是MySQL的数据库驱动
org.flowable
flowable-engine
6.7.2
mysql
mysql-connector-java
8.0.29
首先要做的是创建ProcessEngine流程引擎实例。这是一个线程安全的对象，因此通常只需要在一个应用中初始化一次。 ProcessEngine由ProcessEngineConfiguration实例创建。该实例可以配置与调整流程引擎的设置。 通常使用一个配置XML文件创建ProcessEngineConfiguration，但是（像在这里做的一样）也可以编程方式创建它。 ProcessEngineConfiguration所需的最小配置，是数据库JDBC连接：
static ProcessEngine processEngine = null;
/**
* 创建工作流引擎
*/
@Before
public void createEngine(){
// 配置数据库相关信息 获取 ProcessEngineConfiguration
ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()
.setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn?serverTimezone=UTC&nullCatalogMeansCurrent=true")
.setJdbcUsername("root")
.setJdbcPassword("root")
.setJdbcDriver("com.mysql.cj.jdbc.Driver")
.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);
// 获取流程引擎对象
processEngine = cfg.buildProcessEngine();
}
然后应用运行没有问题，但也没有在控制台提供有用的信息，只有一条消息提示日志没有正确配置。Flowable使用SLF4J作为内部日志框架。在这个例子中，我们使用log4j作为SLF4J的实现。因此在pom.xml文件中添加下列依赖：
org.slf4j
slf4j-api
1.7.21
org.slf4j
slf4j-log4j12
1.7.21
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重新运行应用。应该可以看到关于引擎启动与创建数据库表结构的提示日志：同时可以看到创建了相关的表结构在数据库中
这样就得到了一个启动可用的流程引擎。接下来为它提供一个流程！
2、部署流程定义
接下来我们构建一个非常简单的请假流程，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标签的子元素）。
将下面的XML保存在src/main/resources文件夹下名为holiday-request.bpmn20.xml的文件中(.bpmn20.xml或.bpmn扩展名的BPMN文件)
现在我们已经有了流程BPMN 2.0 XML文件，下来需要将它部署(deploy)到引擎中。部署一个流程定义意味着：
-
流程引擎会将XML文件存储在数据库中，这样可以在需要的时候获取它
-
流程定义转换为内部的、可执行的对象模型，这样使用它就可以启动流程实例。
将流程定义部署至Flowable引擎，需要使用RepositoryService，其可以从ProcessEngine对象获取。使用RepositoryService，可以通过XML文件的路径创建一个新的部署(Deployment)，并调用deploy()方法实际执行：
/**
* 部署流程定义
*/
@Test
public void deploy(){
// 部署流程 获取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 deployQuery() {
// 部署流程 获取RepositoryService对象
RepositoryService repositoryService = processEngine.getRepositoryService();
// 通过流程部署id,获取流程定义对象
ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
.deploymentId("1")
.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:1:3
processDefinition.getName() = Holiday Request
processDefinition.getDeploymentId() = 1
processDefinition.getDescription() = null
3、启动流程实例
现在已经在流程引擎中部署了流程定义，因此可以使用这个流程定义作为“模板”启动流程实例。
要启动流程实例，需要提供一些初始化流程变量。一般来说，可以通过呈现给用户的表单，或者在流程由其他系统自动触发时通过REST API，来获取这些变量。在这个例子里，我们简化直接在代码中定义了，我们使用RuntimeService启动一个流程实例。
/**
* 启动流程实例
*/
@Test
public void runProcess(){
// 启动流程实例通过 RuntimeService 对象
RuntimeService runtimeService = processEngine.getRuntimeService();
// 构建流程变量
Map variables = new HashMap<>();
variables.put("employee","张三") ;// 谁申请请假
variables.put("nrOfHolidays",3); // 请几天假
variables.put("description","工作累了，想出去玩玩"); // 请假的原因
// 启动流程实例，第一个参数是流程定义的key
ProcessInstance processInstance = runtimeService
.startProcessInstanceByKey("holidayRequest", variables);// 启动流程实例
// 输出相关的流程实例信息
System.out.println("流程定义的ID：" + processInstance.getProcessDefinitionId());
System.out.println("流程实例的ID：" + processInstance.getId());
System.out.println("当前活动的ID：" + processInstance.getActivityId());
} 我们创建两个流程定义，并且key值相同
注 ：如果存在多个key相同的流程定义，则使用版本号最高的流程定义创建实例
启动成功，输出结果如下：
流程定义的ID：holidayRequest:2:2503
流程实例的ID：5001
当前活动的ID：null
流程实例存储在act_hi_procinst表
流程变量存储在act_ru_variable表
通过act_ru_execution表，可以查看流程实例执行到哪一步
启动流程实例涉及到的表结构：
-
act_hi_actinst 流程实例执行历史
-
act_hi_identitylink 流程的参与用户的历史信息
-
act_hi_procinst 流程实例历史信息
-
act_hi_taskinst 流程任务历史信息
-
act_ru_execution 流程执行信息
-
act_ru_identitylink 流程的参与用户信息
-
act_ru_task 任务信息
-
act_ru_variable 流程变量
4、查看任务
这里我们再创建一个流程实例，这里总共有2个流程实例，并且对应同一个流程定义
上面员工发起了一个请假流程实例，接下来就会流转到总经理这儿来处理，之前我们没有指定经理这的处理人，我们可以加一个
然后我们来查看下lisi的任务
/**
* 查看任务
*/
@Test
public void queryTask(){
TaskService taskService = processEngine.getTaskService();
List list = taskService.createTaskQuery()
.processDefinitionKey("holidayRequest")
.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());
}
} 输出结果为：
通过一个流程定义，创建了两个流程实例，每个实例有一个任务，所以总共有2个任务
task.getProcessDefinitionId() = holidayRequest:2:2503
task.getId() = 5009
task.getAssignee() = lisi
task.getName() = Approve or reject request
task.getProcessDefinitionId() = holidayRequest:2:2503
task.getId() = 7509
task.getAssignee() = lisi
task.getName() = Approve or reject request
实际对应的数据库表 ：act_ru_task
5、完成任务
现在李四这个角色可以来完成当前的任务了
在此处我们直接拒绝掉这个请假，然后会走发送拒绝邮件的流程，这块我们需要用到JavaDelegate来触发。
我们定义这样一个Java类
public class SendRejectionMail implements JavaDelegate {
/**
* 触发发送邮件的操作
* @param delegateExecution
*/
@Override
public void execute(DelegateExecution delegateExecution) {
System.out.println("请假被拒绝,,,安心工作吧");
}
}然后来完成任务
/**
* 完成任务
*/
@Test
public void completeTask(){
TaskService taskService = processEngine.getTaskService();
TaskQuery taskQuery = taskService.createTaskQuery();
Task task = taskQuery
.taskId("5009")
.singleResult();
// 添加流程变量
Map variables = new HashMap<>();
variables.put("approved",false); // 拒绝请假
// 完成任务
taskService.complete(task.getId(),variables);
} 然后可以看到JavaDelegate触发了
我们可以看到任务ID为5009的已经完成了(完成的任务自动删除)
6、流程的删除
有些流程已经没有用了，我们需要删除掉，其实也非常简单
/**
* 删除流程
*/
@Test
public void deleteProcess(){
RepositoryService repositoryService = processEngine.getRepositoryService();
// 删除流程定义，如果该流程定义已经有了流程实例启动则删除时报错
// repositoryService.deleteDeployment("1");
// 设置为TRUE 级联删除流程定义，及时流程有实例启动，也可以删除，设置为false 非级联删除操作。
repositoryService.deleteDeployment("1",true);
}可以看到已经删除了部署id为1的流程
7、查看历史信息
选择使用Flowable这样的流程引擎的原因之一，是它可以自动存储所有流程实例的审计数据或历史数据。这些数据可以用于创建报告，深入展现组织运行的情况，瓶颈在哪里，等等。
例如，如果希望显示流程实例已经执行的时间，就可以从ProcessEngine获取HistoryService，并创建历史活动(historical activities)的查询。在下面的代码片段中，可以看到我们添加了一些额外的过滤条件：
-
只选择一个特定流程实例的活动
-
只选择已完成的活动
结果按照结束时间排序，代表其执行顺序。
/**
* 查看历史
*/
@Test
public void queryHistory(){
HistoryService historyService = processEngine.getHistoryService();
List list = historyService.createHistoricActivityInstanceQuery()
.processDefinitionId("holidayRequest:2:2503")
.finished()
.orderByHistoricActivityInstanceEndTime().asc()
.list();
for (HistoricActivityInstance historicActivityInstance : list) {
System.out.println(historicActivityInstance.getActivityId() + " took "
+ historicActivityInstance.getDurationInMillis() + " milliseconds");
}
} 输出结果 ：
startEvent took 4 milliseconds
_flow_startEvent__approveTask took 0 milliseconds
startEvent took 4 milliseconds
_flow_startEvent__approveTask took 0 milliseconds
approveTask took 2857562 milliseconds
_flow_approveTask__decision took 0 milliseconds
decision took 24 milliseconds
_flow_decision__sendRejectionMail took 0 milliseconds
sendRejectionMail took 3 milliseconds
_flow_sendRejectionMail__rejectEnd took 0 milliseconds
rejectEnd took 3 milliseconds