2、Flowable基础表结构

男娘i 2024-03-26 23:53 10阅读 0赞

Flowable基础表结构

### 1.表结构讲解 ###

工作流程的相关操作都是操作存储在对应的表结构中，为了能更好的弄清楚Flowable的实现原理和细节，我们有必要先弄清楚Flowable的相关表结构及其作用。在Flowable中的表结构在初始化的时候会创建五类表结构，具体如下：

*  **ACT\_RE** ：'RE’表示 repository。 这个前缀的表包含了流程定义和流程静态资源 （图片，规则，等等）。
 *  **ACT\_RU**：'RU’表示 runtime。 这些运行时的表，包含流程实例，任务，变量，异步任务，等运行中的数据。 Flowable只在流程实例执行过程中保存这些数据， 在流程结束时就会删除这些记录。 这样运行时表可以一直很小速度很快。
 *  **ACT\_HI**：'HI’表示 history。 这些表包含历史数据，比如历史流程实例， 变量，任务等等。
 *  **ACT\_GE**： GE 表示 general。 通用数据， 用于不同场景下
 *  **ACT\_ID:** ’ID’表示identity(组织机构)。这些表包含标识的信息，如用户，用户组，等等。

具体的表结构的含义:

![在这里插入图片描述][54efcad03fa74cfea3ce3d4746b7c01f.png]

### 2.ProcessEngine讲解 ###

#### 2.1 硬编码的方式 ####

我们前面讲解案例的时候是通过ProcessEngineConfiguration这个配置类来加载的。

// 配置数据库相关信息 获取 ProcessEngineConfiguration
    ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()
        .setJdbcUrl("jdbc:mysql://localhost:3306/flowable-learn2?serverTimezone=UTC&nullCatalogMeansCurrent=true")
        .setJdbcUsername("root")
        .setJdbcPassword("123456")
        .setJdbcDriver("com.mysql.cj.jdbc.Driver")
        .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);
    // 获取流程引擎对象
    ProcessEngine processEngine = cfg.buildProcessEngine();

这种方式会调用buildProcessEngine()方法，里面的核心代码为：  
![在这里插入图片描述][a3445f52326b432ea1a639b1a106cb0b.png]

#### 2.2 配置文件 ####

除了上面的硬编码的方式外，我们还可以在resources目录下创建一个`flowable.cfg.xml`文件，注意这个名称是固定的哦。内容如下：

emsp; 在上面的配置文件中配置相关的信息。我们在Java代码中就可以简化为：

@Test
        public void test01(){
        
            // 获取流程引擎对象
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            System.out.println("processEngine = " + processEngine);
        }

emsp; 可以看下getDefaultProcessEngine的源码，在里面最终还是执行了和硬编码一样的代码

public static ProcessEngine getProcessEngine(String processEngineName) {
        
            if (!isInitialized()) {
        
                init(); // 完成初始化操作
            }
            return processEngines.get(processEngineName);
        }

进入init方法

public static synchronized void init() {
        
            if (!isInitialized()) {
        
                if (processEngines == null) {
        
                    // Create new map to store process-engines if current map is null
                    processEngines = new HashMap<>();
                }
                ClassLoader classLoader = ReflectUtil.getClassLoader();
                Enumeration<URL> resources = null;
                try {
        
                    resources = classLoader.getResources("flowable.cfg.xml"); // 加载flowable.cfg.xml配置文件
                } catch (IOException e) {
        
                    throw new FlowableIllegalArgumentException("problem retrieving flowable.cfg.xml resources on the classpath: " + System.getProperty("java.class.path"), e);
                }
    
                // Remove duplicated configuration URL's using set. Some
                // classloaders may return identical URL's twice, causing duplicate
                // startups
                Set<URL> configUrls = new HashSet<>();
                while (resources.hasMoreElements()) {
        
                    configUrls.add(resources.nextElement());
                }
                for (Iterator<URL> iterator = configUrls.iterator(); iterator.hasNext();) {
        
                    URL resource = iterator.next();
                    LOGGER.info("Initializing process engine using configuration '{}'", resource.toString());
                    initProcessEngineFromResource(resource); // 初始化ProcessEngine
                }
    
                try {
        
                    resources = classLoader.getResources("flowable-context.xml"); // 在整合Spring的情况下加载该文件
                } catch (IOException e) {
        
                    throw new FlowableIllegalArgumentException("problem retrieving flowable-context.xml resources on the classpath: " + System.getProperty("java.class.path"), e);
                }
                while (resources.hasMoreElements()) {
        
                    URL resource = resources.nextElement();
                    LOGGER.info("Initializing process engine using Spring configuration '{}'", resource.toString());
                    initProcessEngineFromSpringResource(resource); // 从Spring的资源文件中完成ProcessEngine的初始化
                }
    
                setInitialized(true);
            } else {
        
                LOGGER.info("Process engines already initialized");
            }
        }

在源码中提供了单独使用好整合Spring的配置加载方式。再进入到initProcessEngineFromResource(resource)方法中：  
![在这里插入图片描述][cd23c600cb6e43029045aca5ffbbbb0d.png]  
![在这里插入图片描述][06558197ff4a498284a5e6de8d849a93.png]  
![在这里插入图片描述][faff36d3aaec4c23a4b9968abe230f82.png]  
而且我们也可以看到ProcessEngine最终的实现是 ProcessEngineImpl对象。

#### 2.3 自定义配置文件 ####

最后我们如果要加载自定义名称的配置文件可以通过ProcessEngineConfiguration中的对应构造方法来实现

@Test
        public void test2() throws Exception{
        
            ProcessEngineConfiguration configuration = ProcessEngineConfiguration
                    .createProcessEngineConfigurationFromResource("flowable.cfg.xml");
            ProcessEngine processEngine = configuration.buildProcessEngine();
            System.out.println("processEngine = " + processEngine);
        }

### 3. Servcie服务接口 ###

Service是工作流引擎提供用于进行工作流部署、执行、管理的服务接口，我们使用这些接口可以就是操作服务对应的数据表  
![在这里插入图片描述][4cd3dd8c6de6429ca48ab01454260b71.png]

#### 3.1 Service创建方式 ####

通过ProcessEngine创建Service

方式如下：

RuntimeService runtimeService = processEngine.getRuntimeService();
    RepositoryService repositoryService = processEngine.getRepositoryService();
    TaskService taskService = processEngine.getTaskService();
    // ...

3.2 Service总览  
![在这里插入图片描述][60229b2734914cd68cd232420e266640.png]  
简单介绍：

**RepositoryService**

是activiti的资源管理类，提供了管理和控制流程发布包和流程定义的操作。使用工作流建模工具设计的业务流程图需要使用此service将流程定义文件的内容部署到计算机。

除了部署流程定义以外还可以：查询引擎中的发布包和流程定义。

暂停或激活发布包，对应全部和特定流程定义。 暂停意味着它们不能再执行任何操作了，激活是对应的反向操作。获得多种资源，像是包含在发布包里的文件， 或引擎自动生成的流程图。

获得流程定义的pojo版本， 可以用来通过java解析流程，而不必通过xml。

**RuntimeService**

Activiti的流程运行管理类。可以从这个服务类中获取很多关于流程执行相关的信息

**TaskService**

Activiti的任务管理类。可以从这个类中获取任务的信息。

**HistoryService**

Flowable的历史管理类，可以查询历史信息，执行流程时，引擎会保存很多数据（根据配置），比如流程实例启动时间，任务的参与者， 完成任务的时间，每个流程实例的执行路径，等等。 这个服务主要通过查询功能来获得这些数据。

**ManagementService**

Activiti的引擎管理类，提供了对Flowable 流程引擎的管理和维护功能，这些功能不在工作流驱动的应用程序中使用，主要用于 Flowable 系统的日常维护。

### 4.图标介绍 ###

BPMN 2.0是业务流程建模符号2.0的缩写。它由Business Process Management Initiative这个非营利协会创建并不断发展。作为一种标识，BPMN 2.0是使用一些**符号**来明确业务流程设计流程图的一整套符号规范，它能增进业务建模时的沟通效率。目前BPMN2.0是最新的版本，它用于在BPM上下文中进行布局和可视化的沟通。接下来我们先来了解在流程设计中常见的 符号。

BPMN2.0的**基本符合**主要包含：

#### 4.1 事件图标 ####

在Flowable中的事件图标启动事件，边界事件,中间事件和结束事件.  
![在这里插入图片描述][153108fcea914d2c94cfad47826a6fdc.png]

#### 4.2 活动(任务)图标 ####

活动是工作或任务的一个通用术语。一个活动可以是一个任务，还可以是一个当前流程的子处理流程； 其次，你还可以为活动指定不同的类型。常见活动如下:  
![在这里插入图片描述][0f33769d63764f739cac20c21295e9ff.png]

#### 4.3 结构图标 ####

结构图标可以看做是整个流程活动的结构，一个流程中可以包括子流程。常见的结构有：

#### 4.4 网关图标 ####

网关用来处理决策，有几种常用网关需要了解：  
![在这里插入图片描述][56a21ffb5aeb4bc49a77f57d2b3b3d30.png]

### 5.流程部署详解 ###

#### 5.1 部署实现 ####

我们先来看下流程部署的具体过程。代码实现

/**
         * 部署流程
         */
        @Test
        public void test3(){
        
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            RepositoryService repositoryService = processEngine.getRepositoryService();
            Deployment deploy = repositoryService.createDeployment()
                    .addClasspathResource("holiday-request-new.bpmn20.xml")
                    .name("请假流程...")
                    .category("请假") // 分类
                    .tenantId("dpb") // 租户id
                    .deploy();
            System.out.println("deploy.getId() = " + deploy.getId());
            System.out.println("deploy.getName() = " + deploy.getName());
            System.out.println("deploy.getCategory() = " + deploy.getCategory());
        }

#### 5.2 部署涉及表结构 ####

涉及到的三张表：

部署资源表：act\_ge\_bytearray  
![在这里插入图片描述][c933cc02d9a14f708da9770591ca7b26.png]  
部署ID表：act\_re\_deployment  
![在这里插入图片描述][d89c107cbd7443b9bbbc42ca5bc96c86.png]  
流程表：act\_re\_procdef  
注意：

业务流程定义数据表。此表和ACT\_RE\_DEPLOYMENT是多对一的关系，即，一个部署的bar包里可能包含多个流程定义文件，每个流程定义文件都会有一条记录在ACT\_REPROCDEF表内，每个流程定义的数据，都会对于ACT\_GE\_BYTEARRAY表内的一个资源文件和PNG图片文件。和ACT\_GE\_BYTEARRAY的关联是通过程序用ACT\_GE\_BYTEARRAY.NAME与ACT\_RE\_PROCDEF.NAME\_完成的

#### 5.3 挂起和激活 ####

部署的流程默认的状态为激活，如果我们暂时不想使用该定义的流程，那么可以挂起该流程。当然该流程定义下边所有的流程实例全部暂停。

流程定义为挂起状态，该流程定义将不允许启动新的流程实例，同时该流程定义下的所有的流程实例都将全部挂起暂停执行。

/**
         * 挂起流程
         */
        @Test
        public void test05(){
        
            // 获取流程引擎对象
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            RepositoryService repositoryService = processEngine.getRepositoryService();
            ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
                    .processDefinitionId("holiday:1:4")
                    .singleResult();
            // 获取流程定义的状态
            boolean suspended = processDefinition.isSuspended();
            System.out.println("suspended = " + suspended);
            if(suspended){
        
                // 表示被挂起
                System.out.println("激活流程定义");
                repositoryService.activateProcessDefinitionById("holiday:1:4",true,null);
            }else{
        
                // 表示激活状态
                System.out.println("挂起流程");
                repositoryService.suspendProcessDefinitionById("holiday:1:4",true,null);
            }
        }

具体的实现其实就是更新了流程定义表中的字段  
而且通过REV\_字段来控制数据安全，也是一种乐观锁的体现了，如果要启动一个已经挂起的流程就会出现如下的错误  
![在这里插入图片描述][fb001561b70b4568aba5c36505f99a96.png]

### 6.启动流程实例 ###

然后我们来看看启动流程实例的过程。实现代码如下：

/**
         * 启动流程实例
         */
        @Test
        public void testRunProcess(){
        
            // 获取流程引擎对象
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            // 启动流程实例通过 RuntimeService 对象
            RuntimeService runtimeService = processEngine.getRuntimeService();
            // 构建流程变量
            Map<String,Object> variables = new HashMap<>();
            variables.put("employee","张三") ;// 谁申请请假
            variables.put("nrOfHolidays",3); // 请几天假
            variables.put("description","工作累了，想出去玩玩"); // 请假的原因
            // 启动流程实例，第一个参数是流程定义的id
            ProcessInstance processInstance = runtimeService
                    .startProcessInstanceById("holiday:1:4", variables);// 启动流程实例
            // 输出相关的流程实例信息
            System.out.println("流程定义的ID：" + processInstance.getProcessDefinitionId());
            System.out.println("流程实例的ID：" + processInstance.getId());
            System.out.println("当前活动的ID：" + processInstance.getActivityId());
        }

emsp; 当我们启动了一个流程实例后，会在ACT\_RU\_\*对应的表结构中操作,运行时实例涉及的表结构共10张：

*  ACT\_RU\_DEADLETTER\_JOB 正在运行的任务表
 *  ACT\_RU\_EVENT\_SUBSCR 运行时事件
 *  ACT\_RU\_EXECUTION 运行时流程执行实例
 *  ACT\_RU\_HISTORY\_JOB 历史作业表
 *  ACT\_RU\_IDENTITYLINK 运行时用户关系信息
 *  ACT\_RU\_JOB 运行时作业表
 *  ACT\_RU\_SUSPENDED\_JOB 暂停作业表
 *  ACT\_RU\_TASK 运行时任务表
 *  ACT\_RU\_TIMER\_JOB 定时作业表
 *  ACT\_RU\_VARIABLE 运行时变量表

启动一个流程实例的时候涉及到的表有

*  ACT\_RU\_EXECUTION 运行时流程执行实例
 *  ACT\_RU\_IDENTITYLINK 运行时用户关系信息
 *  ACT\_RU\_TASK 运行时任务表
 *  ACT\_RU\_VARIABLE 运行时变量表

### 7.处理流程 ###

上面的流程已经流转到了zhangsan这个用户这里，然后可以开始审批了

// 获取流程引擎对象
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            TaskService taskService = processEngine.getTaskService();
            Task task = taskService.createTaskQuery()
                    .processDefinitionId("holiday:1:4")
                    .taskAssignee("zhangsan")
                    .singleResult();
            // 添加流程变量
            Map<String,Object> variables = new HashMap<>();
            variables.put("approved",false); // 拒绝请假
            // 完成任务
            taskService.complete(task.getId(),variables);

在正常处理流程中涉及到的表结构

*  ACT\_RU\_EXECUTION 运行时流程执行实例
 *  ACT\_RU\_IDENTITYLINK 运行时用户关系信息
 *  ACT\_RU\_TASK 运行时任务表
 *  ACT\_RU\_VARIABLE 运行时变量表

### 8.完成一个流程 ###

然后我们把第一个流程处理完成

ProcessEngine processEngine = cfg.buildProcessEngine();
    TaskService taskService = processEngine.getTaskService();
    Task task = taskService.createTaskQuery()
        .processDefinitionId("holiday:1:4")
        .taskAssignee("lisi")
        .singleResult();
    // 添加流程变量
    Map<String,Object> variables = new HashMap<>();
    variables.put("approved",false); // 拒绝请假
    // 完成任务
    taskService.complete(task.getId(),variables);

处理完了一个工作流程后，我们来看看相关的表结构信息

首先我们会发现

*  ACT\_RU\_EXECUTION 运行时流程执行实例
 *  ACT\_RU\_IDENTITYLINK 运行时用户关系信息
 *  ACT\_RU\_TASK 运行时任务表
 *  ACT\_RU\_VARIABLE 运行时变量表

这四张表中对应的数据都没有了，也就是这个流程已经不是运行中的流程了。然后在对应的历史表中我们可以看到相关的信息

*  ACT\_HI\_ACTINST 历史的流程实例
 *  ACT\_HI\_ATTACHMENT 历史的流程附件
 *  ACT\_HI\_COMMENT 历史的说明性信息
 *  ACT\_HI\_DETAIL 历史的流程运行中的细节信息
 *  ACT\_HI\_IDENTITYLINK 历史的流程运行过程中用户关系
 *  ACT\_HI\_PROCINST 历史的流程实例
 *  ACT\_HI\_TASKINST 历史的任务实例
 *  ACT\_HI\_VARINST 历史的流程运行中的变量信息

[54efcad03fa74cfea3ce3d4746b7c01f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/976a123e8dd34027a21601ae2e4236f1.png
[a3445f52326b432ea1a639b1a106cb0b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/e6aff95aea6c40a787dcf1c24324bd63.png
[cd23c600cb6e43029045aca5ffbbbb0d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/239e4a4fe3af4c828e807def3c51aff6.png
[06558197ff4a498284a5e6de8d849a93.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/2552ae787bf34063a6936d94a0f99f0d.png
[faff36d3aaec4c23a4b9968abe230f82.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/1b8d594581fe477a8ce23a255661252f.png
[4cd3dd8c6de6429ca48ab01454260b71.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/936ae883e7434b9abb681f82728520d4.png
[60229b2734914cd68cd232420e266640.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/a4eba8966c004afc9a220be6881dfd50.png
[153108fcea914d2c94cfad47826a6fdc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/9de4ac01ba6f4944ab0a3c20b17ea58b.png
[0f33769d63764f739cac20c21295e9ff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/2f76d2a0ba184ba58bcdb0c73e0d9ade.png
[56a21ffb5aeb4bc49a77f57d2b3b3d30.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/972938b456714a739ca42e361cba8e79.png
[c933cc02d9a14f708da9770591ca7b26.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/2bb1cdd95ab64f4da63c936264acf2f9.png
[d89c107cbd7443b9bbbc42ca5bc96c86.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/323079c2a841404ea40c170ae5b34480.png
[fb001561b70b4568aba5c36505f99a96.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/867b0b3f0f834aa8b6e9002c64fd282b.png