Flowable 流程定义（流程模板）的部署及设计的数据库表

news2024/11/25 2:34:38

一.简介

我们使用了 Spring Boot 之后，默认情况下流程是会自动部署的，基本上不需要我们额外做什么事情，我们称之为默认部署。
有的时候，我们的流程可能并不是提前设计好的，而是项目启动之后，动态部署的，例如项目启动成功之后，动态上传一个流程的 XML 文件进行部署，这也是一种比较常见的场景，我们称之为动态部署。

二.默认部署

默认情况下，我们放在 resources/processes 目录下的所有流程文件会自动被部署，流程文件的后缀有两种形式 bpmn20.xml 或者 bpmn。当然，无论是存放流程文件的位置，还是流程文件的格式，都是可以定制的，涉及到的属性主要有三个，可在 application.properties 中进行配置，代码如下：

flowable.check-process-definitions=false
flowable.process-definition-location-prefix=classpath*:/processes/
flowable.process-definition-location-suffixes=**.bpmn20.xml,**.bpmn

flowable.check-process-definitions：这个表示是否在项目启动的时候，去检查文件目录是否有对应的流程文件，该属性为 true 表示如果有流程文件就自动部署，false 表示不检查，那么也就不会自动部署。

flowable.process-definition-location-prefix：这个是流程文件的位置，默认就是 classpath*:/processes/，当然开发者也可以进行配置。

flowable.process-definition-location-suffixes：这个是流程文件的后缀，默认有两个，分别是 **.bpmn20.xml 和 **.bpmn，当然开发者也可以进行配置。

三.动态部署

有的时候，我们的流程可能并不是提前设计好的，而是项目启动之后，动态部署的，例如项目启动成功之后，动态上传一个流程的 XML 文件进行部署，这也是一种比较常见的场景，对于这种情况，我们可以按照如下方式进行部署，代码如下：

@RestController
public class ProcessDeployController {

    @Autowired
    RepositoryService repositoryService;

    @PostMapping("/deploy")
    public RespBean deploy(MultipartFile file) throws IOException {
        DeploymentBuilder deploymentBuilder = repositoryService.createDeployment()
                .category("javaboy的工作流分类")
                .name("javaboy的工作流名称")
                .addInputStream(file.getOriginalFilename(), file.getInputStream())
                .key("javaboy的工作流key");
        Deployment deployment = deploymentBuilder
                .deploy();
        return RespBean.ok("部署成功",deployment.getId());
    }
}

看下流程部署：

首先通过 repositoryService.createDeployment() 方法来创建一个流程部署构建器，即 DeploymentBuilder。

接下来为 DeploymentBuilder 设置分类、名称以及 key 等属性。

关键的方法是 addInputStream，通过该方法去指定流程文件。官方的提供的指定流程文件的方式有好几种；除了 addInputStream 之外，另外还有一个 addString，这个就是将流程文件转为一个字符串传入进来；addBytes 是将流程文件转为字节数组传进来；addClasspathResource 方法则是直接从 classpath 目录下去加载流程文件，这几个方法根据自己的使用场景选择一个合适的方法去调用即可。

这里有一个地方要注意，就是 addInputStream/addBytes/addString 等方法都需要设置资源名，这个名称是可以随意设置的，但是注意名称的后缀，需要是 bpmn20.xml 或者 bpmn，否则流程没有部署。

四.表分析

流程部署过程中，一共有三张表参与了，分别是ACT_RE_DEPLOYMENT，ACT_RE_PROCDEF，ACT_GE_BYTEARRAY。

1.ACT_RE_DEPLOYMENT

这个表是流程部署表，每部署一个流程，这张表中就会新增一条记录，用来描述我们刚刚定义好的流程：
在这里插入图片描述这里的 ID_、NAME_、CATEGORY_ 等等，就是我们在部署流程的时候设置的参数。

2.ACT_RE_PROCDEF

这是流程定义表，我们每定义的一个流程，都会记录在这张表中：

在这里插入图片描述

DEPLOYMENT_ID 字段，和 ACT_RE_DEPLOYMENT 表进行关联，所以 ACT_RE_DEPLOYMENT 和 ACT_RE_PROCDEF 表的关系，其实是一对一的关系，部署表中的一条记录对应定义表中的一条记录。

另外，该表中有一个 CATEGORY_ 的字段，这个字段表示流程的分类，注意这个和部署的分类可不一样，流程部署的分类参数第二小节的代码，流程的分类，说白了其实就是我们流程定义 XML 文件中的 targetNamespace 属性，如下图：

在这里插入图片描述

可根据自己的实际需求去修改 targetNamespace 属性的值，这个值改了之后，ACT_RE_PROCDEF 表中的 CATEGORY_ 字段也会跟着发生变化。

另外，该表中还有一个 VERSION_ 字段，这个看名字就知道是描述记录的版本号，当我们修改了流程的内容之后，重新部署的时候，ACT_RE_DEPLOYMENT 表和 ACT_RE_PROCDEF 表均会自动增加一条记录数，其中，流程定义表 ACT_RE_PROCDEF 中的记录的 VERSION_ 字段的值会自动加 1，这样我们就能够看到不同历史版本的流程定义。

那么系统是怎么识别修改后的流程和前一个流程是同一个呢？主要是靠流程的 id 属性，如下图：
在这里插入图片描述
这个流程的 id 属性，对应到表中，就是 ACT_RE_PROCDEF 表的 KEY_ 字段。

3.ACT_GE_BYTEARRAY

涉及到的第三张表是这个通用数据存储表，这个表的字段比较少，如下图：
在这里插入图片描述
这个表中有一个 DEPLOYMENT_ID 字段，这个就是跟 ACT_RE_DEPLOYMENT 表关联的字段，一条流程部署记录在 ACT_GE_BYTEARRAY 表中对应两条记录，分别是记录 XML 文件和记录流程图片。