SpringBoot集成Flowable工作流

墨蓝 2024-03-26 19:50 78阅读 0赞

#### SpringBoot + Flowable ####

*  SpringBoot集成Flowable工作流
 *   *  maven引入依赖
     *  数据库解释（版本不同，生成的表也会不一样）
     *  表结构具体展示
     *   *  ACT\_APP\_
         *  ACT\_CMMN\_
         *  ACT\_DMN\_
         *  ACT\_RU\_
         *  ACT\_HI\_
         *  ACT\_ID\_
         *  ACT\_FO\_FORM\_
         *  ACT\_GE\_
         *  ACT\_RE\_
         *  其他表
     *  idea 导入插件
     *  idea 创建bpmn文件并画流程图
     *   *  代码实例

## SpringBoot集成Flowable工作流 ##

之前项目中的工作流都比较简单，都用业务数据的状态来区分，这次的项目工作流的业务流程稍微复杂一些，所以决定使用Flowable来进行工作流的管理及发布。

### maven引入依赖 ###

首先呢，是引入flowable的maven依赖，这里使用的版本是6.4.1，引入依赖之后重启项目，会看到日志打印了很多sql,在数据库创建了很多表

<dependency>
                <groupId>org.flowable</groupId>
                <artifactId>flowable-spring-boot-starter</artifactId>
                <version>6.4.1</version>
            </dependency>

![工作流创建的数据表][f3cc3cf2d71941cbbe0b30e4aa5dd1b1.png]

### 数据库解释（版本不同，生成的表也会不一样） ###

1.  ACT\_APP\_ , 表示和应用程序相关的表。
2.  ACT\_CNMN\_, 表示这都是跟 CMMN 协议相关的表。
3.  ACT\_CO\_, CONTENT, 表示这都是跟内容引擎相关的表。
4.  ACT\_DMN\_, 表示这都是跟 DMN 协议相关的表。
5.  ACT\_EVT\_, EVT（EVENT）表示这都是跟事件相关的表。
6.  ACT\_FO\_, FO（FORM）表示这都是跟表单相关的表。
7.  ACT\_GE\_, GE（GENERAL）表示这都是通用表，适用于各种用例的。
8.  ACT\_HI\_ , HI（HISTORY）这些是包含历史数据的表。当从运行时表中删除数据时，历史表仍然包含这些已完成实例的所有信息。
9.  ACT\_ID\_, ID（IDENTITY）表示这都是跟用户身份认证相关的表。
10. ACT\_PROCDEF\_, PROCDEF（PROCESSDEFINE） 表示这都是跟记录流程定义相关的表。
11. ACT\_RE\_, RE（REPOSITORY）表示这都是跟流程的定义、流程的资源等等包含了静态信息相关的表。
12. ACT\_RU\_, RU（RUNTIME）代表运行时，这些是包含尚未完成的流程、案例等的运行时数据的运行时表。Flowable 仅在执行期间存储运行时数据，并在实例结束后删除记录，这使运行时表保持小而快。
13. liquibase生成的八张表（CHANGELOG及CHANGELOGLOCK）

### 表结构具体展示 ###

#### ACT\_APP\_ ####

APP开头的表负责应用引擎存储和应用部署定义。相关的表一共是五张，如下：  
![在这里插入图片描述][39720369bab94deea689288d6302c0b5.png]  
ACT\_APP\_APPDEF

应用程序模型产生应用程序定义。此定义，如流程/案例/等。是成功部署到应用引擎的应用模型的表示。

ACT\_APP\_DEPLOYMENT

当通过应用引擎部署应用模型时，会存储一条记录以保存此部署。部署的实际内容被存储在 ACT_APP_DEPLOYMENT_RESOURCE 表中，并从该表中引用。

ACT\_APP\_DEPLOYMENT\_RESOURCE

此表包含构成应用程序部署的实际资源（存储为字节）。当引擎需要实际模型时，将从该表中获取资源。

#### ACT\_CMMN\_ ####

Flowable CMMN Engine 的数据库名称都以 ACT\_CMMN\_ 开头。这里涉及到一个东西就是 CMMN，CMMN 与 BPMN 协议一致，也是一种流程内容的规范，CMMN 这类表一般用于存储处理 BPMN 所不能适用的业务场景数据，CMMN 通常与 BPMN 搭配使用，不过只有符合 CMMN 规范的模型数据才会使用这类表。  
![在这里插入图片描述][c2f8ed07315540fda2d4b54add79e317.png]  
ACT\_CMMN\_CASEDEF  
ACT\_CMMN\_DEPLOYMENT  
ACT\_CMMN\_DEPLOYMENT\_RESOURCE

这三个都是没有附加前缀的表，主要定义了静态信息，例如 case 的定义和部署和以及相关的资源等。

接下来这些以 ACT\_CMMN\_HI\_ 开头的表代表历史数据，例如过去的案例实例、计划项目等。

ACT\_CMMN\_HI\_CASE\_INST

此表记录由 CMMN 引擎启动的每个案例实例的数据。

ACT\_CMMN\_HI\_MIL\_INST

此表记录了在案例实例中达到的每个里程碑的数据。

ACT\_CMMN\_HI\_PLAN\_ITEM\_INST

此表记录了作为案例实例执行的一部分创建的每个计划项实例的数据。

接下来以 ACT\_CMMN\_RU\_ 开始的表代表运行时的数据，这些数据包含案例实例、计划项等的运行时数据。Flowable 仅在案例实例执行期间存储运行时数据，并在案例实例结束时删除记录，这使运行时表保持小且查询速度快。

ACT\_CMMN\_RU\_CASE\_INST

此表包含每个已启动但尚未完成的案例实例的条目。

ACT\_CMMN\_RU\_MIL\_INST

此表包含作为运行案例实例的一部分达到的每个里程碑的条目。

ACT\_CMMN\_RU\_PLAN\_ITEM\_INST

案例实例执行由案例定义中定义的计划项的多个实例组成，此表包含在案例实例执行期间创建的每个实例的条目。

ACT\_CMMN\_RU\_SENTRY\_PART\_INST

计划项目实例可以有守卫状态转换的哨兵，这样的哨兵在状态改变之前可以包含多个部分，这个表就是专门用来存储这种哨兵。

#### ACT\_DMN\_ ####

Flowable DMN 的数据库名称都以 ACT\_DMN\_ 开头，这里涉及到的表一共是 6 张：  
![在这里插入图片描述][5d6682d173e0463ba15b6b87b1594d76.png]  
ACT\_DMN\_DEPLOYMENT  
ACT\_DMN\_DEPLOYMENT\_RESOURCE

这两个是就不需要我多说了，跟前面的都一样，只不过这里部署的是 DMN。

ACT\_DMN\_DECISION

此表包含已部署决策表的元数据，并与来自其他引擎的定义相对应。

ACT\_DMN\_HI\_DECISION\_EXECUTION

此表包含有关 DMN 决策表执行的审计信息。

#### ACT\_RU\_ ####

以 ACT\_RU\_ 开头的表都是和流程引擎运行时信息相关的一些表。涉及到的表一共有 12 张：  
![在这里插入图片描述][a07b2f69d2724f01b7b5aa7ba537a50f.png]  
ACT\_RU\_ACTINST

流程实例中的每个活动在此表中都有一行来指示活动的当前状态。

ACT\_RU\_TIMER\_JOB  
ACT\_RU\_SUSPENDED\_JOB  
ACT\_RU\_HISTORY\_JOB  
ACT\_RU\_DEADLETTER\_JOB

Flowable 引擎使用作业表来实现异步逻辑、计时器或历史处理。这些表存储每个作业所需的数据。

ACT\_RU\_ENTITYLINK

此表存储有关实例的父子关系的信息。例如，如果流程实例启动子案例实例，则此关系存储在此表中。这样可以轻松查询关系。

ACT\_RU\_EVENT\_SUBSCR

当流程定义使用事件（信号/消息/等或启动/中间/边界）时，引擎将对该表的引用存储在该表中。这简化了查询哪些实例正在等待某种类型的事件。

ACT\_RU\_EXECUTION

存储流程实例和指向流程实例当前状态的指针（称为执行）。

ACT\_RU\_IDENTITYLINK

此表存储有关用户或组的数据及其与（流程/案例/等）实例相关的角色。该表也被其他需要身份链接的引擎使用。

ACT\_RU\_TASK

此表包含正在运行的实例的每个未完成用户任务的条目。然后在查询用户的任务列表时使用此表。CMMN 引擎也使用此表。

ACT\_RU\_VARIABLE

此表存储与实例相关的变量。CMMN 引擎也使用此表。

#### ACT\_HI\_ ####

以 ACT\_HI\_\* 开头的表包含正在运行和已完成的实例的历史数据，这些表的名称遵循其运行时对应的名称，这里一共涉及到 10 张表：  
![在这里插入图片描述][021aa48be5574b3aa93f5ef26f4ffd4b.png]  
ACT\_HI\_ACTINST

历史活动信息。这里记录流程流转过的所有节点，与 ACT_HI_TASKINST 不同的是， ACT_HI_TASKINST 只记录 Task 内容。

ACT\_HI\_ATTACHMENT

历史附件表。

ACT\_HI\_COMMENT

流程的历史评论表。

ACT\_HI\_DETAIL

历史详情表：流程中产生的变量详细，包括控制流程流转的变量，业务表单中填写的流程需要用到的变量等。

ACT\_HI\_ENTITYLINK

历史参与的人员表。

ACT\_HI\_IDENTITYLINK

任务参与者数据表，主要存储历史节点参与者的信息，可能是 Group 也可能是 User。

ACT\_HI\_PROCINST

保存每一个历史流程，创建时就生成，一条流程实例对应一个记录。

ACT\_HI\_TASKINST

记录每一个历史节点，一个 Task 对应一个记录。

ACT\_HI\_TSK\_LOG

每一次执行可能会带上数据，存在这里。

ACT\_HI\_VARINST

流程历史变量表。

#### ACT\_ID\_ ####

以 ACT\_ID\_\* 开头的都是和用户身份相关的表，一共是有 9 张表：

![在这里插入图片描述][29218d483a264a56b8e12c9e53656f47.png]  
ACT\_ID\_BYTEARRAY

这是用户组的部署内容。

ACT\_ID\_GROUP

这是用户组的表。

ACT\_ID\_INFO

这是所有的用户的信息，账号密码。

ACT\_ID\_MEMBERSHIP

用户和用户组的关联表。

ACT\_ID\_PRIV

权限表。

ACT\_ID\_PRIV\_MAPPING

用户、用户组以及权限之间的关联表。

ACT\_ID\_PROPERTY

用户的变量表。

ACT\_ID\_TOKEN

用户访问记录表。

ACT\_ID\_USER

用户表。

#### ACT\_FO\_FORM\_ ####

以 ACT\_FO\_FORM\_ 开头的表存储表单引擎和围绕表单模型和这些表单的实例数据。  
![在这里插入图片描述][a4cb92525fdf4c16b0c04d37bfa31b2d.png]  
ACT\_FO\_FORM\_DEFINITION

表单定义表。

ACT\_FO\_FORM\_DEPLOYMENT

表单部署表。

ACT\_FO\_FORM\_INSTANCE

表单实例表。

ACT\_FO\_FORM\_RESOURCE

表单源数据表。

#### ACT\_GE\_ ####

以 ACT\_GE\_ 开头的表表示一些通用信息表，涉及到的表一共是两个。  
![在这里插入图片描述][23db026422d34fcfb7a7b1e2f5ac6dc1.png]  
ACT\_GE\_BYTEARRAY

存储每个流程的部署记录，bytes_ 字段中保存流程的具体内容。

ACT\_GE\_PROPERTY

存储 Flowable 自身的一些变量，主要是版本号。

#### ACT\_RE\_ ####

以 ACT\_RE\_ 开头的表表示这些表都是跟流程的定义、流程的资源等等包含了静态信息相关的表。  
![在这里插入图片描述][2d6ae5070be448879193c9bbb5ffc258.png]  
ACT\_RE\_DEPLOYMENT

流程部署记录，每次服务重启会部署一次，这里会新增一条记录。

ACT\_RE\_MODEL

创建模型时，额外定义的一些模型相关信息，存在这张表，默认不保存。

ACT\_RE\_PROCDEF

记录流程的变更，流程每变更一次存一条记录，version_ 字段加 1。

#### 其他表 ####

ACT\_PROCDEF\_INFO

流程定义信息，对流程的说明。

ACT\_CO\_CONTENT\_ITEM

每项内容在此表中都有个条目。

ACT\_EVT\_LOG

Flowable 引入了事件日志机制，默认会在数据库中创建 ACT_EVT_LOG 表保存事件日志，如果不使用事件日志，则可以删除这个表。

### idea 导入插件 ###

![在这里插入图片描述][119e7daa29934e338d037d88059217d3.png]  
当时下载了两个，建议使用第二个

### idea 创建bpmn文件并画流程图 ###

在resource目录下新建文件夹process,在process文件夹上右键新建，创建出来的文件是xml，项目在启动的时候会自动部署流程，无需手动部署  
![在这里插入图片描述][e63dcd6923e64122869127f2c846e79e.png]  
然后右键用模型设计器打开文件  
![在这里插入图片描述][66cecf7d810e4b16a34406d39c203217.png]  
在模型设计器里 右键 可以使用内置的一些模型，比如开始事件，及结束事件等  
![在这里插入图片描述][b798dba3b4724bbc9952396c7f9178ad.png]  
下图是我之前做好的一个简单的流程  
![在这里插入图片描述][bf933638c2ba43768e58f106d13a4398.png]  
![在这里插入图片描述][112f72ab8dc84d73904ac8bf2aba59a0.png]  
![在这里插入图片描述][973bb74f25e5439d83ad3f453d6a13b9.png]

#### 代码实例 ####

我将Flowable的代码封装了一下，这个是接口

public interface FlowableService {
        
    
        /**
         * 启动流程实例
         *
         * @param processInstanceKey 流程实例key
         * @param businessKey        业务key(业务id)
         * @param params             流程中所用到的一些参数
         * @return
         */
        void startProcess(String processInstanceKey, String businessKey, Map<String, Object> params);
    
    
        /**
         * 查询负责人当前任务列表
         *
         * @param assignee           负责人
         * @param processInstanceKey 流程实例key
         * @return 任务列表
         */
        List<Task> findPersonTaskList(String assignee, String processInstanceKey);
    
    
        /**
         * 完成任务
         *
         * @param businessKey 业务id
         * @param processInstanceKey 流程实例key
         */
        void completeTask(String processInstanceKey, String businessKey, Map<String,Object> params);
    
    }

下面是具体的实现

public class FlowableServiceImpl implements FlowableService {
        
    
    
        @Override
        public void startProcess(String processInstanceKey, String businessKey, Map<String, Object> params) {
        
            // 1、创建ProcessEngine
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            // 2、获取RunTimeService
            RuntimeService runtimeService = processEngine.getRuntimeService();
            // 3、根据流程定义Key启动流程
            runtimeService.startProcessInstanceByKey(processInstanceKey, businessKey, params);
        }
    
        @Override
        public List<Task> findPersonTaskList(String assignee, String processInstanceKey) {
        
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            // 创建TaskService
            TaskService taskService = processEngine.getTaskService();
            // 根据流程key 和 任务负责人 查询任务
            List<Task> list = taskService.createTaskQuery()
                    .processDefinitionKey(processInstanceKey) //流程Key
                    .taskAssignee(assignee) //只查询该任务负责人的任务
                    .list();
            return list;
        }
    
        @Override
        public void completeTask(String processInstanceKey, String businessKey, Map<String,Object> params) {
        
            // 获取引擎
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            // 获取taskService
            TaskService taskService = processEngine.getTaskService();
            // 根据流程key 和 任务的负责人 查询任务
            // 返回一个任务对象
            Task task = taskService.createTaskQuery()
                    .processDefinitionKey(processInstanceKey) // 流程Key
                    .processInstanceBusinessKey(businessKey) // 业务id
                    .taskUnassigned()
                    .singleResult();
            // 完成任务,参数：任务id
            taskService.complete(task.getId(), params);
        }
    }

然后在车辆申请的时候是下面的代码

public ApiResult createVehicleApply(CreateVehicleApply createVehicleApply) {
        
            VehicleApplies vehicleApplies = new VehicleApplies();
            String s = StpUtil.getLoginId().toString();
            // 设置申请人id
            vehicleApplies.setUserId(Long.parseLong(StpUtil.getLoginId().toString()));
            BeanUtil.copyProperties(createVehicleApply, vehicleApplies);
            // 保存用车申请，取到业务id
            boolean save = save(vehicleApplies);
    
            SystemUser user = adminService.getUserById(Long.valueOf(StpUtil.getLoginId().toString()));
            if (Objects.isNull(user)) {
        
                log.error("当前用户不存在,请联系管理员");
                return ApiResult.make().failed("500", "当前用户不存在，请联系管理员");
            }
    
            // 查询上级审核部门 如果不存在则返回错误信息
            Integer deptId = user.getDeptId();
            SystemAuditors deptAuditor = auditorsService.getOneByDeptIdAndRoleId(Long.parseLong(deptId.toString()), SmartLogisticsConstant.DEPT_ADMIN_ROLE_ID);
            if (Objects.isNull(deptAuditor)) {
        
                return ApiResult.make().failed("500", "没有配置上级审核部门，请联系管理员");
            }
            // 查询对应的车管人员
            SystemAuditors vehicleAdmin = auditorsService.getOneByDeptIdAndRoleId(Long.parseLong(deptId.toString()), SmartLogisticsConstant.VEHICLE_ADMIN_ROLE_ID);
            if (Objects.isNull(vehicleAdmin)) {
        
                return ApiResult.make().failed("500", "没有配置车辆管理员，请联系管理员");
            }
    
            // 开始流程
            Map<String, Object> param = Maps.newHashMap();
            // 此处的几个枚举对应了，申请人、审核人员及最终审核人员的spel表达式里对应的参数
            param.put(SmartLogisticsConstant.VEHICLE_APPLY_USER, StpUtil.getLoginId().toString()); // 申请人
            param.put(SmartLogisticsConstant.VEHICLE_APPLY_DEPT_REVIEWER, deptAuditor.getUserId()); // 部门主任
            param.put(SmartLogisticsConstant.VEHICLE_APPLY_ADMIN_REVIEWER, vehicleAdmin.getUserId()); // 车队长
            flowableService.startProcess(SmartLogisticsConstant.VEHICLE_APPLY, vehicleApplies.getId().toString(), param);
            return ApiResult.make().ok(save);
        }

申请完了之后，只有指定的审核人才能看到需要审核的信息

@Override
        public ApiResult<List<VehicleApplyList>> vehicleApplyReviewList() {
        
            List<VehicleApplyList> objects = Lists.newArrayList();
    		// 此处查询任务列表
            List<Task> personTasks = flowableService.findPersonTaskList(StpUtil.getLoginId().toString(), SmartLogisticsConstant.VEHICLE_APPLY);
            for (Task personTask : personTasks) {
        
                String processInstanceId = personTask.getProcessInstanceId();
                if (StrUtil.isNotBlank(processInstanceId)) {
        
                    ProcessInstance processInstance = ProcessEngines.getDefaultProcessEngine().getRuntimeService().createProcessInstanceQuery().processInstanceId(processInstanceId).singleResult();
                    // 拿到业务id
                    String businessKey = processInstance.getBusinessKey();
                    VehicleApplies vehicleApplies = lambdaQuery().eq(VehicleApplies::getId, businessKey).one();
                    if (Objects.isNull(vehicleApplies)) {
        
                        continue;
                    }
                    VehicleApplyList applyList = new VehicleApplyList();
                    BeanUtil.copyProperties(vehicleApplies, applyList);
                    objects.add(applyList);
                }
            }
            return new ApiResult().ok(objects);
        }

下面代码是审核的代码

@Override
        public ApiResult vehicleApplyAudit(VehicleApplyAuditReq vehicleApplyAuditReq) {
        
            Map<String, Object> params = Maps.newHashMap();
            // 在这里传入审核意见（通过还是拒绝，由流程去判断下一步该走到哪里）
            params.put(SmartLogisticsConstant.VEHICLE_APPLY_INSPECT_OPINION, vehicleApplyAuditReq.getInspectOpinion());
            params.put(SmartLogisticsConstant.VEHICLE_APPLY_ADMIN_REVIEWER, StpUtil.getLoginId().toString());
            if (Objects.nonNull(vehicleApplyAuditReq.getDriverId())) {
        
                params.put(SmartLogisticsConstant.VEHICLE_APPLY_DRIVER, vehicleApplyAuditReq.getDriverId());
            }
            flowableService.completeTask(SmartLogisticsConstant.VEHICLE_APPLY, vehicleApplyAuditReq.getId().toString(), params);
            // 拒绝->更新车辆申请拒绝理由
            if (SmartLogisticsConstant.VEHICLE_APPLY_INSPECT_OPINION_REJECT.equals(vehicleApplyAuditReq.getInspectOpinion())) {
        
                VehicleApplies vehicleApplies = lambdaQuery().eq(VehicleApplies::getId, vehicleApplyAuditReq.getId()).one();
                if (Objects.nonNull(vehicleApplies)) {
        
                    vehicleApplies.setAuditResult(vehicleApplyAuditReq.getResult());
                    updateById(vehicleApplies);
                }
            }
            return ApiResult.make().ok("审核完成");
        }

[f3cc3cf2d71941cbbe0b30e4aa5dd1b1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/efb8ee5dbe284190bf3e3b9bcfec931b.png
[39720369bab94deea689288d6302c0b5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/a09e66619e534e67808922dd90e77b21.png
[c2f8ed07315540fda2d4b54add79e317.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/356daa3564974d1e8abb7481b4ed6857.png
[5d6682d173e0463ba15b6b87b1594d76.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/9e476024585147c3b6be62502504ee61.png
[a07b2f69d2724f01b7b5aa7ba537a50f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/2f558ee861654de5b652a684dc5212a2.png
[021aa48be5574b3aa93f5ef26f4ffd4b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/97f33a0cd7624ac284b3014d1a1fc808.png
[29218d483a264a56b8e12c9e53656f47.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/84e64aaf0f0647da947eccd53d3abbd2.png
[a4cb92525fdf4c16b0c04d37bfa31b2d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/1e0165600eb3404b8d838ab3540bb1e4.png
[23db026422d34fcfb7a7b1e2f5ac6dc1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/43bf593796934d3295fdecad20f4f89b.png
[2d6ae5070be448879193c9bbb5ffc258.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/1557d4f71a1440b1adb1e62591f28b12.png
[119e7daa29934e338d037d88059217d3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/8e8f3228a1a2412091a8d20561b59e38.png
[e63dcd6923e64122869127f2c846e79e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/4d9b0ff2ba634b25b1af0202d974a3cd.png
[66cecf7d810e4b16a34406d39c203217.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/f0f200ec314d492e98feb316af46f6c8.png
[b798dba3b4724bbc9952396c7f9178ad.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/fc40e1497444490f812861e83970252c.png
[bf933638c2ba43768e58f106d13a4398.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/b7fb9100898b40f0a5cc529a0764fe57.png
[112f72ab8dc84d73904ac8bf2aba59a0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d927bddc4ab6492d89a558330b9b4515.png
[973bb74f25e5439d83ad3f453d6a13b9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/fef0d1a200aa4869ac542a1f663870cf.png