SpringBoot集成Flowable做工作流
什么是BPMN
工作流(引擎)介绍
在任何行业和企业中，都有各种各样的流程，例如：
- 请假流程
- 报销流程
- 入职流程
- 离职流程
- 出差流程
- 等等……
就算你自己没有设计过工作流，那么你每天肯定也在使用各种流程。
工作流引擎其实就是使用代码实现UML流程图中的各个步骤而已。
凡是需要多个人（或者多个部门）按照先后顺序去一级一级审批的业务都可以使用工作流来完成。
为什么要用 BPMN ？
业务流程建模与标注（Business Process Model and Notation，BPMN) ，描述流程的基本符号，包括这些图元如何组合成一个业务流程图（Business Process Diagram）。
对于流程控制，有一种比较初级的玩法是：在业务代码里面加入 Status（状态机） 字段维护流程状态，流程负责的审批人可能也是 Hard Code（硬编码），这种玩法实现流程初级会比较快，但是长远来看会出现几个问题：
- 流程健壮性差，但凡出现人员变动，或者组织结构调整，就需要修改代码，维护成本高
- 流程无法复用，当组织出现新的工作流程，又要重新写一套代码，开发成本非常高
- 流程和业务代码耦合，你中有我，我中有你（并不符合单一职责和解耦的设计原则）
认识BPMN基础元素
BPMN 2.0 只要充分了解以下四类基础元素，基本就能掌握BPMN 2.0 的核心：
- 流对象
- 数据
- 连接对象
- 泳道
流对象（Flow Objects）
是定义业务流程的主要图形元素，包括三种：事件、活动、网关
1、事件（Events）：指的是在业务流程的运行过程中发生的事情，分为：
- 开始：表示一个流程的开始
- 中间：发生的开始和结束事件之间，影响处理的流程
- 结束：表示该过程结束
2、活动（Activities）：包括任务和子流程两类。子流程在图形的下方中间外加一个小加号（+）来区分。
3、网关（Gateways）：用于表示流程的分支与合并。
- 排他网关：只有一条路径会被选择
- 并行网关：所有路径会被同时选择
- 包容网关：可以同时执行多条线路，也可以在网关上设置条件
- 事件网关：专门为中间捕获事件设置的，允许设置多个输出流指向多个不同的中间捕获事件。当流程执行到事件网关后，流程处于等待状态，需要等待抛出事件才能将等待状态转换为活动状态。
数据（Data）
数据主要通过四种元素表示：
- 数据对象（Data Objects）
- 数据输入（Data Inputs）
- 数据输出（Data Outputs）
- 数据存储（Data Stores）
连接对象（Connecting Objects）
流对象彼此互相连接或者连接到其他信息的方法主要有三种：
- 顺序流：用一个带实心箭头的实心线表示，用于指定活动执行的顺序
- 信息流：用一条带箭头的虚线表示，用于描述两个独立的业务参与者（业务实体/业务角色）之间发送和接受的消息流动
- 关联：用一根带有线箭头的点线表示，用于将相关的数据、文本和其他人工信息与流对象联系起来。用于展示活动的输入和输出
泳道（Swimlanes）
通过泳道对主要的建模元素进行分组，将活动划分到不同的可视化类别中来描述由不同的参与者的责任与职责。
BPMN实例
实例1：拍卖服务BPMN模板
实例2：书籍销售流程 BPMN
Flowable简介
目前最新版是Flowable 6.7.2（2022年05月09日）
官方网站：https://www.flowable.com/open-source
用户手册：https://tkjohn.github.io/flowable-userguide/
GitHub：https://github.com/flowable
Flowable是BPMN的一个基于java的软件实现，不过Flowable不仅仅包括BPMN，还有DMN决策表和CMMN Case管理引擎，并且有自己的用户管理、微服务API等一系列功能，是一个服务平台。
Flowable部署
1、下载
访问：https://github.com/flowable/flowable-engine/releases
选择下载版本，我这里下载的是 6.5.0
2、下载后解压，wars 文件目录里面共 5 个 war包：
- flowable-admin：后台管理
- flow-idm：用户组权限管理
- flow-modeler：流程定义管理
- flowable-rest：流程引擎对外提供的API接⼝
- flowable-task：用户任务管理
把它们放到tomact的 webapps 目录，然后找到 tomcat / bin / startup.bat 启动 tomcat，会等待一段时间。
3、修改配置文件
所有war包都解压后，找到每个项目中的，比如：\webapps\flowable-admin\WEB-INF\classes application-dev.properties 这样的配置文件
1）修改：改成自己的数据库链接地址，数据库名flowable自己创建，从flowable-6.5.0.zip里面database下面的creat/all 下的sql 脚本执行去建表 几十张表
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/flowable?serverTimezone=Asia/Shanghai&useUnicode=true&charcterEncoding=UTF-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=root
flowable.admin.app.server-config.process.port=9999
flowable.admin.app.server-config.cmmn.port=9999
flowable.admin.app.server-config.app.port=9999
flowable.admin.app.server-config.dmn.port=9999
flowable.admin.app.server-config.form.port=9999
flowable.admin.app.server-config.content.port=99992）修改\webapps\flowable-admin\WEB-INF\classes flowable-default.properties， 主要就是修改数据库链接上，改成mysql的
注意：
1）需要在每个项目的WEB-INF\lib目录下添加mysql的驱动包。
2）高版本的mysql驱动包，有些必须的连接参数需要配置。我使用的是mysql-connector-java-8.0.11.jar，配置如下：
jdbc:mysql://localhost:3306/flowable?serverTimezone=Asia/Shanghai&useUnicode=true&charcterEncoding=UTF-8&useSSL=false
server.port=9988
server.servlet.context-path=/flowable-admin
management.endpoints.jmx.unique-names=true
# This is needed to force use of JDK proxies instead of using CGLIB
spring.aop.proxy-target-class=false
spring.aop.auto=false
spring.application.name=flowable-ui-admin
spring.liquibase.enabled=false
spring.servlet.multipart.max-file-size=10MB
spring.banner.location=classpath:/org/flowable/spring/boot/flowable-banner.txt
# The default domain for generating ObjectNames must be specified. Otherwise when multiple Spring Boot applications start in the same servlet container
# all would be created with the same name (com.zaxxer.hikari:name=dataSource,type=HikariDataSource) for example
spring.jmx.default-domain=${spring.application.name}
# Expose all actuator endpoints to the web
# They are exposed, but only authenticated users can see /info and /health abd users with access-admin can see the others
management.endpoints.web.exposure.include=*
# Full health details should only be displayed when a user is authorized
management.endpoint.health.show-details=when_authorized
# Only users with role access-admin can access full health details
management.endpoint.health.roles=access-admin
# Spring prefixes the roles with ROLE_. However, Flowable does not have that concept yet, so we need to override that with an empty string
flowable.common.app.role-prefix=
# H2 example (default)
#spring.datasource.driver-class-name=org.h2.Driver
#spring.datasource.url=jdbc:h2:tcp://localhost/flowableadmin
#spring.datasource.url=jdbc:h2:~/flowable-db/db;AUTO_SERVER=TRUE;AUTO_SERVER_PORT=9091;DB_CLOSE_DELAY=-1
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/flowable?serverTimezone=Asia/Shanghai&useUnicode=true&charcterEncoding=UTF-8&useSSL=false
#spring.datasource.driver-class-name=org.postgresql.Driver
#spring.datasource.url=jdbc:postgresql://localhost:5432/flowableadmin
#spring.datasource.driver-class-name=com.microsoft.sqlserver.jdbc.SQLServerDriver
#spring.datasource.url=jdbc:sqlserver://localhost:1433;databaseName=flowableadmin
#spring.datasource.driver-class-name=oracle.jdbc.driver.OracleDriver
#spring.datasource.url=jdbc:oracle:thin:@localhost:1521:FLOWABLEADMIN
#spring.datasource.driver-class-name=com.ibm.db2.jcc.DB2Driver
#spring.datasource.url=jdbc:db2://localhost:50000/flowableadmin
spring.datasource.username=root
spring.datasource.password=root几个项目的都修改完，关闭之前运行的tomcat ，重新启动。
5、访问
需要时间会久点，都正常启动后
访问 http://127.0.0.1:8080/flowable-admin 用户名 admin 密码 test
访问 http://127.0.0.1:8080/flowable-idm 用户名 admin 密码 test
访问 http://127.0.0.1:8080/flowable-modeler 用户名 admin 密码 test
Flowable数据表
1、Flowable的所有数据库表都以ACT_开头。服务API的命名也大略符合这个规则。
2、ACT_RE_：'RE'代表repository。带有这个前缀的表包含“静态”信息，例如流程定义与流程资源（图片、规则等）。
3、ACT_RU_：'RU'代表runtime。这些表存储运行时信息，例如流程实例（process instance）、用户任务（user task）、变量（variable）、作业（job）等。Flowable只在流程实例运行中保存运行时数据，并在流程实例结束时删除记录。这样保证运行时表小和快。
4、ACT_HI_：'HI'代表history。这些表存储历史数据，例如已完成的流程实例、变量、任务等。
5、ACT_GE_：通用数据。在多处使用。
1）通用数据表（2个）
- act_ge_bytearray：二进制数据表，如流程定义、流程模板、流程图的字节流文件；
- act_ge_property：Flowable 相关的基本信息（不常用）。比如各个 module 使用的版本信息
2）历史表（8个，HistoryService接口操作的表）
- act_hi_actinst：历史节点表，存放流程实例运转的各个节点信息（包含开始、结束等非任务节点）；
- act_hi_attachment：历史附件表，存放历史节点上传的附件信息（不常用）；
- act_hi_comment：历史意见表；
- act_hi_detail：历史详情表，存储节点运转的一些信息（不常用）；
- act_hi_identitylink：历史流程人员表，存储流程各节点候选、办理人员信息，常用于查询某人或部门的已办任务；
- act_hi_procinst：历史流程实例表，存储流程实例历史数据（包含正在运行的流程实例）；
- act_hi_taskinst：历史流程任务表，存储历史任务节点；
- act_hi_varinst：流程历史变量表，存储流程历史节点的变量信息；
3）用户相关表（4个，IdentityService接口操作的表）
- act_id_group：用户组信息表，对应节点选定候选组信息；
- act_id_info：用户扩展信息表，存储用户扩展信息；
- act_id_membership：用户与用户组关系表；
- act_id_user：用户信息表，对应节点选定办理人或候选人信息；
4）流程定义、流程模板相关表（3个，RepositoryService接口操作的表）
- act_re_deployment：部属信息表，存储流程定义、模板部署信息；
- act_re_procdef：流程定义信息表，存储流程定义相关描述信息，但其真正内容存储在act_ge_bytearray表中，以字节形式存储；
- act_re_model：流程模板信息表，存储流程模板相关描述信息，但其真正内容存储在act_ge_bytearray表中，以字节形式存储；
5）流程运行时表（6个，RuntimeService接口操作的表）
- act_ru_task：运行时流程任务节点表，存储运行中流程的任务节点信息，重要，常用于查询人员或部门的待办任务时使用；
- act_ru_event_subscr：监听信息表，不常用；
- act_ru_execution：运行时流程执行实例表，记录运行中流程运行的各个分支信息（当没有子流程时，其数据与act_ru_task表数据是一一对应的）；
- act_ru_identitylink：运行时流程人员表，重要，常用于查询人员或部门的待办任务时使用；
- act_ru_job：运行时定时任务数据表，存储流程的定时任务信息；
- act_ru_variable：运行时流程变量数据表，存储运行中的流程各节点的变量信息；
Flowable流程设计器的使用
新建流程图
注意：这个key最好不要有中文，后期流程部署、启动、跳转都可能会用到它，所有不要定义的过于随意
根据业务需求画流程图
1、节点分类：开始节点、用户任务节点、结束节点
2、节点名称：可直接在“名称”处填写，也可以双击节点输入
3、分配用户（只针对用户任务节点）
为节点分配审批人（由于Flowable自带的的组织结构和我们的组织架构可能存在差异，所以我们一般用固定值）
4、任务监听器（只针对用户任务节点）
（1）任务监听器的分类：
- create：当任务被创建时会执行的监听器。
- assignment：当任务被签收时会执行的监听器。
- complete：当任务完成时执行的监听器。
- delete：当任务被删除时执行的监听器。
（2）常用的任务监听器以及使用场景
create：上面讲的给用户节点设置审批人只适用于办理人是固定的某一个人或多个候选人；如果一个用户节点办理人是不固定的话，我们可以用create任务监听器来实现
complete：当遇到一个用户任务办完需要抄送或者触发其他事物的时候，我们可以使用complete任务监听器；不同类型的任务监听器使用方法都一样。
5、多实例
Flowable支持一个节点多个实例；通俗讲就是你在流程图里只画了一个用户节点，但是通过多实例配置可以使流程运行时为这一个节点创建多个实例；这个类似于循环，而循环的次数取决于你设置的基数。
多实例还支持串行Sequential和并行parallel；通俗来讲所谓的串行就是顺序执行，并行就是不按顺序执行，但它俩的相同点都是必须要所有的实例都完成这个节点才算结束。
6、流程线
（1）流条件配置
审批流当中最常见的就是通过和驳回，这时候就需要为通过和驳回的流程线设置流转条件。
Flowable流条件是以占位符的方式存在的。
（2）跳过表达式
和流条件配置方式一样；流程启动后，当传入的流程变量值符合要求时会自动跳过。
7、常用的网关
（1）排他网关：通过它的流只能有一条。
注意：排他网关支持默认出口；流程启动后，当其他流程线都返回false时走默认流。
（2） 并行网关：只有所有要经过它的任务流都完成时才会进行下一步。
保存
保存后流程图相关数据会保存在act_de_model表内，并且每次更新并保存后，流程定义的版本会+1
下载
SpringBoot使用Flowable
基本用法
1、引入相关依赖
<!--web开发的起步依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- jdbc -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.11</version>
</dependency>
<!-- flowable工作流 -->
<dependency>
<groupId>org.flowable</groupId>
<artifactId>flowable-spring-boot-starter</artifactId>
<version>6.5.0</version>
</dependency>
<dependency>
<groupId>org.flowable</groupId>
<artifactId>flowable-json-converter</artifactId>
<version>6.5.0</version>
</dependency>
<!-- test -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
<scope>test</scope>
</dependency>
<!--fastjson-->
<dependency>
<groupId>com.alibaba.fastjson2</groupId>
<artifactId>fastjson2</artifactId>
<version>2.0.1</version>
</dependency>2、application.yml配置
server:
port: 9999
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/flowable?serverTimezone=Asia/Shanghai&useUnicode=true&charcterEncoding=UTF-8&useSSL=false
username: root
password: root
flowable:
#关闭定时任务JOB
async-executor-activate: false
#将databaseSchemaUpdate设置为true。当flowable发现库与数据库表结构不一致时，会自动将数据库表结构升级至新版本。
database-schema-update: true3、绘制BPMN流程图
这里用学生请假流程做例子，首先由学生发起请假申请，然后由老师进行审核，老师审核结束后进行判断：
- 如果请假天数大于2天，流转到校长处审核，然后流程结束。
- 如果请假天数不大于2天，流程结束。
部署流程需要一个.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:flowable="http://flowable.org/bpmn" 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" typeLanguage="http://www.w3.org/2001/XMLSchema" expressionLanguage="http://www.w3.org/1999/XPath" targetNamespace="http://www.flowable.org/processdef">
<process id="StudentLeave" name="学生请假流程" isExecutable="true">
<startEvent id="start" name="开始" flowable:formFieldValidation="true"></startEvent>
<userTask id="apply" name="请假申请" flowable:assignee="${studentUser}" flowable:formFieldValidation="true">
<extensionElements>
<modeler:initiator-can-complete xmlns:modeler="http://flowable.org/modeler"><![CDATA[false]]></modeler:initiator-can-complete>
</extensionElements>
</userTask>
<userTask id="teacherPass" name="老师审批" flowable:candidateGroups="teacher" flowable:formFieldValidation="true"></userTask>
<exclusiveGateway id="judgeTask" name="判断是否大于2天"></exclusiveGateway>
<endEvent id="end" name="结束"></endEvent>
<userTask id="principalPass" name="校长审批" flowable:candidateGroups="principal" flowable:formFieldValidation="true"></userTask>
<sequenceFlow id="principalCheck" name="通过" sourceRef="principalPass" targetRef="end">
<conditionExpression xsi:type="tFormalExpression"><![CDATA[${outcome=='通过'}]]></conditionExpression>
</sequenceFlow>
<sequenceFlow id="principalNotPassFlow" name="驳回" sourceRef="principalPass" targetRef="apply">
<conditionExpression xsi:type="tFormalExpression"><![CDATA[${outcome=='驳回'}]]></conditionExpression>
</sequenceFlow>
<sequenceFlow id="teacherPassFlow" name="通过" sourceRef="teacherPass" targetRef="judgeTask">
<conditionExpression xsi:type="tFormalExpression"><![CDATA[${outcome=='通过'}]]></conditionExpression>
</sequenceFlow>
<sequenceFlow id="teacherNotPassFlow" name="驳回" sourceRef="teacherPass" targetRef="apply">
<conditionExpression xsi:type="tFormalExpression"><![CDATA[${outcome=='驳回'}]]></conditionExpression>
</sequenceFlow>
<sequenceFlow id="startFlow" sourceRef="start" name="流程开始" targetRef="apply"></sequenceFlow>
<sequenceFlow id="applyFlow" sourceRef="apply" name="申请流程" targetRef="teacherPass"></sequenceFlow>
<sequenceFlow id="judgeLess" name="小于2天" sourceRef="judgeTask" targetRef="end">
<conditionExpression xsi:type="tFormalExpression"><![CDATA[${day <= 2}]]></conditionExpression>
</sequenceFlow>
<sequenceFlow id="judgeMore" name="大于2天" sourceRef="judgeTask" targetRef="principalPass">
<conditionExpression xsi:type="tFormalExpression"><![CDATA[${day > 2}]]></conditionExpression>
</sequenceFlow>
</process>
<bpmndi:BPMNDiagram id="BPMNDiagram_StudentLeave">
<bpmndi:BPMNPlane