[Flowable工作流] 学习记录 [搭建简易模拟案例]
Posted 小智RE0
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了[Flowable工作流] 学习记录 [搭建简易模拟案例]相关的知识,希望对你有一定的参考价值。
🐵由于最近的工作需要用到flowable工作流相关的知识点,所以计划找点入门的教程,学习一下flowable的使用.
本次学习记录来自B站教学视频:【工作流】Flowable大合集-值得收藏
Flowable用户手册:
https://tkjohn.github.io/flowable-userguide/#_introduction
链接:Flowable用户手册
文章目录
1.什么是Flowable
Flowable作为是基于Java实现的BPMN, 当然,它也包括DMN决策表和CMMN Case管理引擎,是一款包含用户管理~微服务API…功能的服务平台.
2.搭建入门案例
2.1:获取ProcessEngine对象
搭建一个简单的demo项目开始学习:
(1)首先创建一个Maven项目;
(2)找到pom.xml
文件,引入依赖
<dependencies>
<!--mysql-java驱动依赖;注意和自己的mysql数据库版本匹配-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.27</version>
</dependency>
<!--引入flowable依赖-->
<dependency>
<groupId>org.flowable</groupId>
<artifactId>flowable-engine</artifactId>
<version>6.3.0</version>
</dependency>
<!--单元测试依赖-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13</version>
<scope>test</scope>
</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>
(3)在test文件夹下创建测试类 StartTest01
package org.xiaozhire0.flowabletest;
import org.flowable.engine.ProcessEngine;
import org.flowable.engine.ProcessEngineConfiguration;
import org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration;
import org.junit.Test;
/**
* @BelongsProject: flowable-study-start01
* @BelongsPackage: org.xiaozhire0.flowabletest
* @Author: 小智RE0 --- 学习记录
* @Date: 2022/9/10 22:29
* @Description: 测试使用
*/
public class StartTest01
/**
* 测试获取流程引擎对象
* ProcessEngine:flowable的核心API
*/
@Test
public void getProcessEngine()
ProcessEngineConfiguration processEngineConfiguration = new StandaloneProcessEngineConfiguration();
//配置数据库连接;
//驱动
processEngineConfiguration.setJdbcDriver("com.mysql.cj.jdbc.Driver");
//数据链接URL; 注意数据库名和自己本地创建的一致;此处xiaozhire0_study_flowable_db为数据库名
processEngineConfiguration.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/xiaozhire0_study_flowable_db?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai");
//数据库用户;请使用自己本地的数据库用户名
processEngineConfiguration.setJdbcUsername("root");
//数据库密码;请使用自己本地的数据库密码
processEngineConfiguration.setJdbcPassword("数据库密码");
//设置数据库模式更新; [如果不存在该数据库/表结构,则自动创建]
processEngineConfiguration.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);
//构建ProcessEngine对象
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();;
(4)由于运行时,会出现未配置日志文件提示,那么此处先创建日志配置文件.
在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=%dyyyy-MM-dd-hh:mm:ss,SSS [%t] %-5p %c %x - %m%n
(5)点击运行,若出现数据库不存在的错误提示
可以将在设置URL链接处增加参数
processEngineConfiguration.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/xiaozhire0_study_flowable_db?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&nullCatalogMeansCurrent=true");
正常运行后图示:
(6)打开数据库可视化工具,[本人使用DBeaver
],可看到数据库xiaozhire0_study_flowable_db已经自动生成了这些数据表.
-
ACT_RE_*
: 'RE’代表repository。带有这个前缀的表包含“静态”信息,例如流程定义与流程资源(图片、规则等)。 -
ACT_RU_*
: 'RU’代表runtime。这些表存储运行时信息,例如流程实例(process instance)、用户任务(user task)、变量(variable)、作业(job)等。Flowable只在流程实例运行中保存运行时数据,并在流程实例结束时删除记录。这样保证运行时表小和快。 -
ACT_HI_*
: 'HI’代表history。这些表存储历史数据,例如已完成的流程实例、变量、任务等。 -
ACT_GE_*
: 通用数据。在多处使用。
2.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标签的子元素)。
代码实现
在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">
<!--holidayRequest:流程的主键Id-->
<process id="holidayRequest" name="模拟请假案例使用" isExecutable="true">
<startEvent id="startEvent"/>
<sequenceFlow sourceRef="startEvent" targetRef="approveTask"/>
<userTask id="approveTask" name="同意或拒绝请假这个请求"/>
<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="同意请假"
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="发出拒绝邮件"
flowable:class="org.flowable.SendRejectionMail"/>
<sequenceFlow sourceRef="sendRejectionMail" targetRef="rejectEnd"/>
<!--endEvent:流程终止-->
<endEvent id="approveEnd"/>
<endEvent id="rejectEnd"/>
</process>
</definitions>
创建测试类StartTest02
package org.xiaozhire0.flowabletest;
import org.flowable.engine.ProcessEngine;
import org.flowable.engine.ProcessEngineConfiguration;
import org.flowable.engine.RepositoryService;
import org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration;
import org.flowable.engine.repository.Deployment;
import org.junit.Before;
import org.junit.Test;
/**
* @BelongsProject: flowable-study-start02
* @BelongsPackage: org.xiaozhire0.flowabletest
* @Author: 小智RE0 --- 学习记录
* @Date: 2022/9/10 22:29
* @Description: 测试使用
*/
public class StartTest02
ProcessEngineConfiguration processEngineConfiguration = null;
/**
* 前置方法
*/
@Before
public void before()
//1.获取processEngineConfiguration对象
processEngineConfiguration = new StandaloneProcessEngineConfiguration();
//配置数据库连接;
//驱动
processEngineConfiguration.setJdbcDriver("com.mysql.cj.jdbc.Driver");
//数据链接URL; 注意数据库名和自己本地创建的一致;
processEngineConfiguration.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/xiaozhire0_study_flowable_db?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&nullCatalogMeansCurrent=true");
//数据库用户;请使用自己本地的数据库用户名
processEngineConfiguration.setJdbcUsername("root");
//数据库密码;请使用自己本地的数据库密码
processEngineConfiguration.setJdbcPassword("数据库密码");
//设置数据库模式更新; [如果不存在该数据库/表结构,则自动创建]
processEngineConfiguration.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);
/**
* 部署流程
*/
@Test
public void deploymentProcess()
//(1)获取ProcessEngine对象
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
//(2)获取RepositoryService
RepositoryService repositoryService = processEngine.getRepositoryService();
//(3)创建流程
Deployment deployment = repositoryService.createDeployment()
.addClasspathResource("holiday-request.bpmn20.xml")//添加配置流程文件
.name("模拟请求流程")//可设置该流程名称
.deploy();//执行流程
//查看流程部署ID
System.out.println("流程部署Id为: " + deployment.getId());
System.out.println("流程部署名称为: " + deployment.getName());
运行之;
再看下数据库;
# 查看流程
select * from act_re_deployment where ID_ = '5001'
# 查看流程详细文件表
select * from act_ge_bytearray where DEPLOYMENT_ID_ = '5001'
# 访问流程详细信息
select * from act_re_procdef where DEPLOYMENT_ID_ = '5001'
对流程的 [查询] 以及 [删除] 操作
在StartTest02
类中编写查询流程方法;
/**
* 查询流程
*/
@Test
public void toQueryProcess()
//(1)获取ProcessEngine对象
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
//(2)获取RepositoryService
RepositoryService repositoryService = processEngine.getRepositoryService();
//(3)获取流程查询对象
ProcessDefinitionQuery processDefinitionQuery = repositoryService.createProcessDefinitionQuery();
//(4)可设定要查询的流程Id来指定查询流程;
ProcessDefinition processDefinition = processDefinitionQuery.deploymentId("5001").singleResult();
System.out.println("获取流程Id:" + processDefinition.getDeploymentId());
System.out.println("获取流程名称:" + processDefinition.getName());
System.out.println("获取流程描述:" + processDefinition.getDescription());
运行之,可看到查询到流程的信息,
在StartTest02
类中编写删除流程方法;
- 可设定要删除流程的Id.
/**
* 删除指定流程,可指定流程Id.
*/
@Test
public void toDelProcessById()
//获取ProcessEngine对象
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
//获取RepositoryService
RepositoryService repositoryService = processEngine.getRepositoryService();
//参数1:指定要删除流程的Id,注:: 若该流程已启动,则无法删除.
repositoryService.deleteDeployment("5001");
当然,这个deleteDeployment
方法是有重载方法的.看看其他参数的含义.
/**
* 删除指定流程,无论流程是否启动
*/
@Test
public void toDelProcess()
//获取ProcessEngine对象
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
//获取RepositoryService
RepositoryService repositoryService = processEngine.getRepositoryService();
//参数1:指定要删除流程的Id,注:: 若该流程已启动,则无法删除.
//参数2:是否级联删除, 注:: true- 若该任务已启动,还是会被删除
repositoryService.deleteDeployment("5001",true);
2.3:启动流程实例
要启动流程实例,需要提供一些初始化流程变量。一般来说,可以通过呈现给用户的表单,或者在流程由其他系统自动触发时通过REST API,来获取这些变量。
当然,由于刚才或许已经删除了之前创建的流程;
那么,再次执行方法deploymentProcess()
来部署一个流程.
OK,我这里已经重新部署了流程,流程Id为10001
OK,在StartTest02
测试类中编写启动流程的方法
/**
* 启动流程实例
*/
@Test
public void startProcess()
//获取ProcessEngine对象
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
//获取流程运行对象
RuntimeService runtimeService = processEngine.getRuntimeService();
//构建流程变量; 实际使用时这些数据是动态获取的!
Map<String,Object> varProcess = new HashMap<>();
varProcess.put("student","小智RE0");
varProcess.put("numberOfDaysOff",5);
varProcess.put("reasonForLeave","休假");
//启动流程实例
//参数1:key-对应配置文件 参数2:具体流程变量
ProcessInstance holidayRequest = runtimeService.startProcessInstanceByKey("holidayRequest", varProcess);
System.out.println( "流程Id" + holidayRequest.getProcessDefinitionId());
System.out.println( "当前活跃的流程Id" + holidayRequest.getActivityId());
System.out.println( "获取当前Id" + holidayRequest.getId());
注意这个流程key
对应配置文件的设置
运行之,查看数据表,已被写入,流程已启动执行.
2.4:查询任务
首先打开配置文件holiday-request.bpmn20.xml
配置任务审批人
<userTask id="approveTask" name以上是关于[Flowable工作流] 学习记录 [搭建简易模拟案例]的主要内容,如果未能解决你的问题,请参考以下文章