前言一、使用步骤
1.引入依赖2.初始化ProcessEngine流程引擎实例3.部署流程定义4.流程定义查询验证5.启动流程实例6.查看任务7.完成任务8.流程定义删除9.查看历史数据 总结
前言
以下内容皆是本人原创,创作不易,感谢帮忙点赞、转发,我是爱写代码的成成呀
Flowable是一个使用Java语言编写的轻量级业务流程引擎,该引擎可用于部署BPMN2.0流程定义XML文件。创建这些流程定义的流程实例,进行查询,访问运行中或历史的流程实例及相关数据。
当然我们可以用代码实现所有的流程控制,但是选择Flowable流引擎的优势是,我们可以通过UI图形化直观地展示,轻松共享对工作流程的理解,同时易于快速修改。
提示:以下是本篇文章正文内容,下面案例可供参考
一、使用步骤 1.引入依赖// Flowable流程引擎,是我们可以创建一个ProcessEngine流程引擎对象,来访问Flowable API2.初始化ProcessEngine流程引擎实例// MYSQL数据库驱动 org.flowable flowable-engine 6.3.0 mysql mysql-connector-java 8.0.21
ProcessEngine流程引擎对象,这是一个线程安全的对象,因此通常只需要在一个应用中初始化一次。processEngine实例由ProcessEngineConfiguration实例创建,该实例可以配置和调整流程引擎的参数设置。
方式一:可以通过配置XML的方式创建ProcessEngineConfiguration实例
方式二:通过main方法中编程实现ProcessEngineConfiguration实例初始化
// 获取 ProcessEngineConfiguration对象
ProcessEngineConfiguration processEngineConfiguration = new StandaloneProcessEngineConfiguration();
// 配置数据库
processEngineConfiguration.setJdbcDriver("com.mysql.cj.jdbc.Driver");
processEngineConfiguration.setJdbcUsername("root");
processEngineConfiguration.setJdbcPassword("root");
processEngineConfiguration.setJdbcUrl("");
// 如果数据库表结构方式不存在就新建
processEngineConfiguration.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);
// 通过 ProcessEngineConfiguration构建我们需要的 processEngine对象
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
System.out.println("processEngine = " + processEngine);
在mysql8.0中执行上述代码可能会出现下图错误,出现这种情况只需要在mysql的连接字符串中添加上nullCatalogMeansCurrent=true,设置为只查当前连接的schema库即可。
Flowable使用SLF4J作为内部日志框架,因此我们需要在pom文件中添加以下依赖
org.slf4j slf4j-api 1.7.30 org.slf4j slf4j-log4j12 1.7.30
这里我们使用log4j12作为slf4j的实现,Log4j需要一个配置文件。在src/main/resources创建log4j.properties
重新启动服务,就可以看到引擎启动和相关数据库表创建的提示日志了
至此流程引擎初始化完成,紧接着需要给它提供一个可用的流程。
流程定义可以看作是重复执行流程的蓝图。在Flowable中,流程定义指的是定义为BPMN2.0格式的XML文件,一个流程定义可以启动多个流程实例。
- 左侧的圆圈叫做启动事件,start event,流程实例的起点;第一个矩形叫做用户任务,user task,这是流程中用户操作的步骤;带叉的菱形叫做排他网关,exclusive gateway,它会将流程实例路由到同意或拒绝路径
BPMN 2.0 XML 包含了流程可视化和流程部分,以下BPMN2.0XML只包含了“流程部分”。如果使用图形化建模工具,实际的XML文件还会包括“流程可视化部分”,用于描述图形信息,如流程定义中各个元素的坐标(所有的图形化信息包含在XML的BPMNDiagram标签中,作为definitions标签的子元素),将下面的XML保存在src/main/resources文件夹下名为holiday-request.bpmn20.xml的文件中。
流程定义文件
紧接着我们需要流程定义文件部署(deploy)到流程引擎中,部署一个流程意味着:
流程引擎会将流程定义文件存储在数据库中,这样可以在需要的时候获取它;流程定义文件会被转换成内部的,可执行的对象模型,这样使用它就可以启动流程实例。
如何部署流程定义文件
将流程定义部署至Flowable引擎,需要使用RepositoryService,其可以从ProcessEngine对象获取。使用RepositoryService,可以通过XML文件的路径创建一个新的*部署(Deployment),并调用deploy()*方法实际执行。
@Test
public void testDeploy() {
// 1.获取ProcessEngine对象
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
// 2.获取RepositoryService
RepositoryService repositoryService = processEngine.getRepositoryService();
// 3.完成流程的部署操作
Deployment deploy = repositoryService.createDeployment()
// 关联要部署的流程文件
.addClasspathResource("holiday-request.bpmn20.xml")
.name("请求流程")
// 部署流程
.deploy();
System.out.println("deploy.getId() = " + deploy.getId());
System.out.println("deploy.getName() = " + deploy.getName());
}
在数据库表中也可以看到相关数据信息
act_re_deployment: 流程定义部署表,每部署一次就增加一条记录
act_re_procdef :流程定义表,部署每个新的流程定义都会在这张表中增加一条记录
act_ge_bytearray :流程资源表,流程部署的 bpmn文件和png图片会保存在该表中
流程定义已部署到流程引擎当中,我们可以通过API查询验证流程是否已经部署进流程引擎中,通过RepositoryService创建的ProcessDefinitionQuery对象实现。
@Test
public void testDeployQuery() {
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
RepositoryService repositoryService = processEngine.getRepositoryService();
ProcessDefinitionQuery processDefinitionQuery = repositoryService.createProcessDefinitionQuery();
ProcessDefinition processDefinition = processDefinitionQuery.deploymentId("1").singleResult();
System.out.println("processDefinition.getDeploymentId() = " + processDefinition.getDeploymentId());
System.out.println("processDefinition.getName() = " + processDefinition.getName());
System.out.println("processDefinition.getDescription() = " + processDefinition.getDescription());
System.out.println("processDefinition.getId() = " + processDefinition.getId());
// 输出结果为:
// processDefinition.getId() = holidayRequest:2:2503
// processDefinition.getName() = Holiday Request
// processDefinition.getDeploymentId() = 2501
// processDefinition.getDescription() = null
}
5.启动流程实例
现在流程引擎中部署了流程定义,因此可以使用这个流程定义作为"模板"启动流程实例。启动流程实例,需要提供一些初始化流程变量,一般来说,可以通过呈现给用户的表单,或者在流程由其他系统自动触发时通过REST API,来获取这些变量。
@Test
public void testRunProcess() {
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
// 我们需要runtimeService来启动流程实例
RuntimeService runtimeService = processEngine.getRuntimeService();
// 构建流程变量
Map varivales = new HashMap<>();
varivales.put("employee", "张三");
varivales.put("nrOfHoliday", 3);
varivales.put("description", "工作累了出去玩玩");
// 启动流程实例
ProcessInstance holidayRequest = runtimeService.startProcessInstanceByKey("holidayRequest", varivales);
// 流程定义Id
System.out.println("holidayRequest.getProcessDefinitionId() = " + holidayRequest.getProcessDefinitionId());
System.out.println("holidayRequest.getName() = " + holidayRequest.getName());
// 当前活动Id
System.out.println("holidayRequest.getActivityId() = " + holidayRequest.getActivityId());
// 流程实例Id
System.out.println("holidayRequest.getId() = " + holidayRequest.getId());
}
启动流程实例涉及到的表结构:
- act_hi_actinst 流程实例执行历史;act_hi_identitylink 流程的参与用户的历史信息;act_hi_procinst 流程实例历史信息 ;act_hi_taskinst 流程任务历史信息;act_ru_execution 流程执行信息;act_ru_identitylink 流程的参与用户信息;act_ru_task 任务信息。
上面员工发起了一个请假流程,接下来就会流转到总经理这儿来处理,之前我们没有指定经理这的处理人,我们可以加一个。
@Test
public void testQueryTask() {
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
TaskService taskService = processEngine.getTaskService();
List list = taskService.createTaskQuery()
// 指定查询的流程key
.processDefinitionKey("holidayRequest")
// 查询这个任务的处理人
.taskAssignee("zhangsan")
.list();
for (Task task : list) {
System.out.println("task.getProcessDefinitionId() = " + task.getProcessDefinitionId());
System.out.println("task.getAssignee() = " + task.getAssignee());
System.out.println("task.getName() = " + task.getName());
System.out.println("task.getDescription() = " + task.getDescription());
}
}
7.完成任务
在此处我们直接解决掉这个请假,然后会走发送拒绝邮件的流程,这块我们需要用到JavaDelegate来触发。
package org.flowable;
import org.flowable.engine.delegate.DelegateExecution;
import org.flowable.engine.delegate.JavaDelegate;
public class SendRejectionMail implements JavaDelegate {
@Override
public void execute(DelegateExecution delegateExecution) {
// 触发执行的逻辑 按照在流程中定义的应该给被拒绝的员工发送通知的邮件
System.out.println("不好意思,你的请假申请未通过,请联系您的主管");
}
}
@Test
public void testCompleteTask() {
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
TaskService taskService = processEngine.getTaskService();
Task task = taskService.createTaskQuery()
// 指定查询的任务key
.processDefinitionKey("holidayRequest")
.taskAssignee("zhangsan")
.singleResult();
// 创建流程变量
Map map = new HashMap<>();
map.put("approved", false);
// 完成任务
taskService.complete(task.getId(), map);
}
8.流程定义删除
@Test
public void testDeleteDeploy() {
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
RepositoryService repositoryService = processEngine.getRepositoryService();
// 删除部署的流程 第一个参数是 id, 如果部署的流程启动了就不允许删除了
// repositoryService.deleteDeployment("1");
// 第二个参数是级联删除, 如果流程启动了,相关的任务一并被删除
// 对应的表是 act_re_deployment
repositoryService.deleteDeployment("1", true);
}
9.查看历史数据
@Test
public void testHistory() {
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
HistoryService historyService = processEngine.getHistoryService();
List list = historyService.createHistoricActivityInstanceQuery()
// 从 act_hi_actinst 找到 proc_def_id_ 字段
.processDefinitionId("holidayRequest:1:7503")
// 查询的历史记录状态是已经完成的
.finished()
// 指定排序的字段和顺序
.orderByHistoricActivityInstanceEndTime().asc()
.list();
for (HistoricActivityInstance historicActivityInstance : list) {
// 获取到活动名称 活动状态的id 这个节点所花费的时间
System.out.println(historicActivityInstance.getActivityName()+"historicActivityInstance.getActivityId() = " + historicActivityInstance.getActivityId()+":"+historicActivityInstance.getDurationInMillis());
}
}
总结
Flowable完整教程之基础篇更新到这里就结束了,以上内容皆是本人原创,创作不易,感谢帮忙点赞、转发,我是爱写代码的成成呀
投食请扫下方二维码,打赏有惊喜呦,一块两块不嫌少,十块八块不嫌多



