Flowable定时器与实时流程图江南一点雨

灰太狼 2023-10-03 21:56 19阅读 0赞

### 1. 定时器 ###

#### 1.1. 流程定义定时激活 ####

在之前松哥给小伙伴们介绍流程定义的时候，流程都是定义好之后立马就激活了，其实在流程定义的这个过程中，我们还可以设置一个激活时间，也就是流程定义好之后，并不会立马激活（不激活就不能据此流程定义创建新流程），而是在延迟某一个固定时间之后，才会激活，代码如下：

@RestController
    public class ProcessDeployController {
    
        @Autowired
        RepositoryService repositoryService;
    
        @PostMapping("/deploy")
        public RespBean deploy(MultipartFile file,String tenantId) throws IOException {
            System.out.println(new Date());
            DeploymentBuilder deploymentBuilder = repositoryService.createDeployment()
                    .category("javaboy的工作流分类")
                    .name("javaboy的工作流名称")
                    .addInputStream("fff.bpmn", file.getInputStream())
                    .tenantId(tenantId)
                    .activateProcessDefinitionsOn(new Date(System.currentTimeMillis() + 1000 * 60))
                    .key("javaboy的工作流key666");
            Deployment deployment = deploymentBuilder
                    .deploy();
            return RespBean.ok("部署成功",deployment.getId());
        }
    }
    复制代码

`.activateProcessDefinitionsOn(new Date(System.currentTimeMillis() + 1000 * 60))` 表示流程在延迟一分钟之后，才激活。

此时，我们启动项目，然后调用该接口部署一个流程，部署完成之后，如果立马调用流程启动方法去启动流程，就会抛出如下异常：

![format_png][]

可以看到，这里也说的很明确了，这个流程定义目前是一个挂起的状态，无法启动。

这个时候，我们去查看 `ACT_RU_TIMER_JOB` 表，就会发现该表中多了一条定时任务执行计划：

![format_png 1][]

该表有一个 `DUEDATE_` 字段，这个字段描述了这个定时任务执行的具体时间，在到达时间后，定时任务会自动执行，将 `ACT_RE_PROCDEF` 表中，流程的状态字段 `SUSPENSION_STATE_` 由 2 改为 1。

#### 1.2. 流程实例定时挂起 ####

除了流程定义可以定时挂起外，流程实例也可以定时挂起。方式如下：

@Autowired
    RepositoryService repositoryService;
    @Test
    void test23() {
        repositoryService.suspendProcessDefinitionByKey("UserTaskDemo", true, new Date(System.currentTimeMillis() + 120 * 1000));
    }
    复制代码

这个执行完成后，也会在 `ACT_RU_TIMER_JOB` 表中添加一条定时任务，在两分钟之后，会自动挂起这个流程定义以及与之相对应的流程。实际上就是将对应表中的 `SUSPENSION_STATE_` 字段值由 1 改为 2。

#### 1.3. 定时任务执行过程 ####

前面两个小节，松哥都和大家提到，`ACT_RU_TIMER_JOB` 表中会保存定时任务信息，时间到了就会自动执行。

但是小伙伴们注意，定时任务每次执行的时候，其实并不是去 `ACT_RU_TIMER_JOB` 表中查询数据，而是去 `ACT_RU_JOB` 表中查询数据并执行。

当定时的时间到了后，Flowable 会自动将数据从 `ACT_RU_TIMER_JOB` 表中移动到 `ACT_RU_JOB` 表中，然后定时器查询到 `ACT_RU_JOB` 表中的数据之后，就立马自动执行了。大致上就是这样一个流程。

我给大家手动演示一个。

我现在的流程定义和流程实例都挂起了，我想要在 4 分钟之后，将之全部启动，代码如下：

@Test
    void test24() {
        repositoryService.activateProcessDefinitionByKey("UserTaskDemo", true, new Date(System.currentTimeMillis() + 240 * 1000));
    }
    复制代码

当这行代码执行之后，4 分钟之后，流程定义和流程实例就全部都启动了。但是我现在忽然就不想等四分钟了，我想立马执行，那么我们可以去 `ACT_RU_TIMER_JOB` 表中找到这个定时任务的 ID，然后执行如下代码：

@Autowired
    ManagementService managementService;
    @Test
    void test25() {
        managementService.moveTimerToExecutableJob("b7e9501d-5075-11ed-9706-acde48001122");
    }
    复制代码

这个代码表示将 ID 为 `b7e9501d-5075-11ed-9706-acde48001122` 的记录由 `ACT_RU_TIMER_JOB` 表移动到 `ACT_RU_JOB` 表中，移动完成后，这个任务就会被立马执行。

当一个定时任务开启了，还能不能取消呢？当然可以！我们将这个定时任务放到私信队列表即可，私信队列表是 `ACT_RU_DEADLETTER_JOB`，具体操作方式如下：

@Test
    void test27() {
        managementService.moveJobToDeadLetterJob("6b95dc62-5081-11ed-a00f-acde48001122");
    }
    复制代码

上面这个方法执行的参数是 `ACT_RU_TIMER_JOB` 表中的任务 ID，执行完成后，`ACT_RU_TIMER_JOB` 表中对应的记录就会被移动到 `ACT_RU_DEADLETTER_JOB` 表中，所以定时任务就不会被执行了。

对于已经移动到私信队列的定时任务，也可以再通过如下方法移动回 `ACT_RU_JOB` 表中被立马执行（即使时间没到也会立马执行），如下：

@Test
    void test26() {
        managementService.moveDeadLetterJobToExecutableJob("6b95dc62-5081-11ed-a00f-acde48001122", 10);
    }
    复制代码

参数就是任务 ID。

好啦，几个简单的例子和小伙伴们分享了下 Flowable 中定时器的玩法。

### 2. 实时流程图 ###

在之前的文章中，松哥和大家展示过 Flowable 中的一个功能，就是我们可以绘制一张图片，来实时展示某一个流程走到哪一步了。不过当时没有跟大家详细介绍这个图片到底是如何绘制出来的，现在我们就来聊一聊这个话题。

#### 2.1. 效果图 ####

首先我们先来看一下绘制出来的效果图，如下：

![format_png 2][]

已经执行的节点和连线用红色标记出来。大致上就是这么一个效果，今天就跟大家聊一聊这里的实现细节。

#### 2.2. 实践 ####

将一个流程图绘制成图片，相关的 API 在 flowable 中其实都是有提供的，流程图片的绘制，是根据流程的定义来绘制的，所以只需要提供一个流程定义的 ID 即可，如下：

ProcessDefinition pd = repositoryService.createProcessDefinitionQuery().processDefinitionKey("ExclusiveGatewayDemo01").latestVersion().singleResult();
    BpmnModel bpmnModel = repositoryService.getBpmnModel(pd.getId());
    DefaultProcessDiagramGenerator generator = new DefaultProcessDiagramGenerator();
    InputStream inputStream = generator.generatePngDiagram(bpmnModel, 1.0, true);
    FileUtils.copyInputStreamToFile(inputStream, new File("/Users/sang/Downloads/1.png"));
    复制代码

这五行代码应该都好理解：

1.  查找到流程定义对象。
2.  根据流程定义对象，获取到一个 BpmnModel 对象。
3.  创建一个图片生成器对象 DefaultProcessDiagramGenerator。
4.  调用 generatePngDiagram 方法生成这个流程定义所对应的图片，参数有三个，分别是：前面查询到的 bpmnModel 对象；缩放因子以及是否在绘制流程图的时候，在连线上加上描述文字，generatePngDiagram 方法的返回值则是一个输入流。
5.  最后将这个输入流打印出来，就是一张图片了。

上面这个方法执行结果如下：

![format_png 3][]

可以看到，这就是普通的流程图，没有高亮。

如果希望已经执行的节点变成高亮的，那么可以使用如下方法：

![format_png 4][]

这个方法参数比较多，我们挨个来说下：

1.  流程的 bpmnModel 对象。
2.  生成的图片类型。
3.  高亮的活动节点。
4.  高亮的连线。
5.  缩放因子。
6.  是否在绘制连线的时候添加文字描述。

这里的关键就是第三个和第四个参数。这个流程图中哪些节点哪些连线需要高亮，我们将之列出来即可。

根据我们之前文章中的介绍，小伙伴们知道，一个流程在执行过程中的活动信息，都是保存在 `ACT_RU_ACTINST` 表中，所以我们只需要根据流程实例的 ID 在 `ACT_RU_ACTINST` 表中查询到即可，如下：

@Test
    void test01() throws IOException {
        ProcessDefinition pd = repositoryService.createProcessDefinitionQuery().processDefinitionKey("ExclusiveGatewayDemo01").latestVersion().singleResult();
        BpmnModel bpmnModel = repositoryService.getBpmnModel(pd.getId());
        ProcessInstance pi = runtimeService.createProcessInstanceQuery().singleResult();
        List<String> highLightedActivities = new ArrayList<>();
        List<String> hightLightedFlows = new ArrayList<>();
        double scaleFactor = 1.0;
        boolean drawSqquenceFlowNameWithNoLabelDI = true;
        if (pi == null) {
            return;
        }
        List<ActivityInstance> list = runtimeService.createActivityInstanceQuery().list();
        for (ActivityInstance ai : list) {
            if (ai.getActivityType().equals("sequenceFlow")) {
                hightLightedFlows.add(ai.getActivityId());
            } else {
                highLightedActivities.add(ai.getActivityId());
            }
        }
        DefaultProcessDiagramGenerator generator = new DefaultProcessDiagramGenerator();
        InputStream inputStream = generator.generateDiagram(bpmnModel, "PNG", highLightedActivities, hightLightedFlows, scaleFactor, drawSqquenceFlowNameWithNoLabelDI);
        FileUtils.copyInputStreamToFile(inputStream, new File("/Users/sang/Downloads/1.png"));
    }
    复制代码

小伙伴们看到，我们这里使用 `highLightedActivities` 和 `hightLightedFlows` 两个集合，分别存一个流程已经执行的活动 ID 和连线的 ID。

通过 `runtimeService.createActivityInstanceQuery().list();` 来查询到所有已经执行的活动，然后遍历，遍历的时候注意区分是不是 `sequenceFlow`，如果是 `sequenceFlow` 则将之添加到 `hightLightedFlows` 集合中，否则将之添加到 `highLightedActivities` 结合中。

最终，执行生成的图片就是本文已开始大家看到的图片。

按照上面这种方式，对于一个已经执行完毕的流程来说，似乎就画不出来流程图了，因为当一个流程执行完毕之后，`ACT_RU_ACTINST` 表中的数据就会自动清空。

不过。。。根据我们前面文章的介绍，执行完毕的活动信息还可以去 `ACT_HI_ACTINST` 表中进行查询，因此，我们这个流程图还可以这样画：

@Test
    void test05() throws IOException {
        ProcessDefinition pd = repositoryService.createProcessDefinitionQuery().processDefinitionKey("ExclusiveGatewayDemo01").latestVersion().singleResult();
        BpmnModel bpmnModel = repositoryService.getBpmnModel(pd.getId());
        HistoricProcessInstance hpi = historyService.createHistoricProcessInstanceQuery().singleResult();
        if (hpi == null) {
            return;
        }
        List<String> highLightedActivities = new ArrayList<>();
        List<String> hightLightedFlows = new ArrayList<>();
        double scaleFactor = 1.0;
        boolean drawSqquenceFlowNameWithNoLabelDI = true;
        List<HistoricActivityInstance> list = historyService.createHistoricActivityInstanceQuery().processInstanceId(hpi.getId()).list();
        for (HistoricActivityInstance hai : list) {
            if (hai.getActivityType().equals("sequenceFlow")) {
                hightLightedFlows.add(hai.getActivityId());
            } else {
                highLightedActivities.add(hai.getActivityId());
            }
        }
        DefaultProcessDiagramGenerator generator = new DefaultProcessDiagramGenerator();
        InputStream inputStream = generator.generateDiagram(bpmnModel, "PNG", highLightedActivities, hightLightedFlows, scaleFactor, drawSqquenceFlowNameWithNoLabelDI);
        FileUtils.copyInputStreamToFile(inputStream, new File("/Users/sang/Downloads/1.png"));
    }
    复制代码

可以看到，当一个流程实例执行完毕的时候，我们可以去历史表中查询这个流程实例，同时也去历史表中查询这个流程实例所执行过的活动 ID，找到之后，还是按照之前的办法，填充给 `hightLightedFlows` 和 `highLightedActivities` 两个变量。最终绘制出来的结果如下图：

![format_png 5][]

[format_png]: https://img-blog.csdnimg.cn/img_convert/ef3346e6679a41d9488d6df92d8cea84.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/17f5278dbee77fb805a195546229f7b9.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/a8cdd64701e1dbe967ab0f566f30fad7.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/91a7d2fbffc7e81aa8d981483abf694a.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/f27e4047bee0f1bf5f30d8fe7fd3fa26.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/9c3a8c1cec5686aee9dce477874620d3.webp?x-oss-process=image/format,png