flowable中流程变量的概念(作用域)

news2025/6/3 7:56:55

核心概念:流程变量(Process Variables)

流程变量是 Flowable 工作流引擎中用于存储、传递和共享与业务流程相关的数据的机制。你可以将它们理解为附着在流程实例(或执行流、任务)上的键值对(Key-Value)数据。

关键特性与作用:

  1. 数据驱动流程: 流程的走向(网关决策)、任务处理逻辑、表单内容展示、监听器行为等都可以基于流程变量的值来决定。

  2. 状态持久化: Flowable 会自动将流程变量持久化到其数据库中。这意味着即使服务器重启,流程实例的状态(包括变量值)也能被恢复。

  3. 作用域(实例关系): 变量存在于特定的作用域内(流程实例、执行流、任务),这决定了它们的生命周期和可见性(后面详细解释)。

  4. 类型丰富: 支持多种 Java 基本类型及其包装类(String, Integer, Long, Double, Boolean, Date)、字节数组、以及实现了 java.io.Serializable 接口的复杂自定义对象。序列化后的自定义对象会以 BLOB 或 CLOB 形式存储在数据库中。

  5. 传递与共享: 在流程实例内部,变量可以在不同的活动和任务之间传递和共享(根据作用域规则),使得后续步骤能访问之前步骤产生的数据。

 流程变量的作用域(实例关系):

这是理解流程变量的关键!变量不是全局存在的,它们总是绑定在一个特定的“容器”上,这个容器决定了变量的生命周期和谁可以访问它:

  1. 流程实例作用域(Process Instance Scope)

    • 容器: 整个流程实例 (ProcessInstance)。

    • 生命周期: 从变量被设置开始,直到整个流程实例结束(完成或被删除)。

    • 可见性: 最高。该流程实例下的所有执行流(Execution)和所有任务(Task)都可以读取写入这些变量。它们是整个流程实例的“全局”数据。

    • 设置方式:

      • 启动流程时:runtimeService.startProcessInstanceByKey(..., variables)

      • 流程实例运行中:runtimeService.setVariable(executionId, variableName, value) 或 runtimeService.setVariables(executionId, variablesMap)

    • 获取方式:

      • runtimeService.getVariable(executionId, variableName)

      • runtimeService.getVariables(executionId) (获取该作用域所有变量)

      • taskService.getVariable(taskId, variableName) (任务也能获取流程实例变量)

      • taskService.getVariables(taskId) (任务也能获取流程实例变量)

  2. 执行流作用域(Execution Scope)

    • 容器: 一个具体的执行流 (Execution)。执行流代表流程当前正在活动的路径。一个流程实例在并行网关处可能分裂出多个并发执行流。

    • 生命周期: 从变量被设置开始,直到该执行流到达结束事件或流程实例结束

    • 可见性: 中等。变量只对绑定在该特定执行流上的活动和任务可见。同一个流程实例下的其他并行执行流通常无法直接访问这些变量(除非显式传递)。主要用于保存特定执行路径的临时状态。

    • 设置方式:

      • runtimeService.setVariableLocal(executionId, variableName, value) 或 runtimeService.setVariablesLocal(executionId, variablesMap) (注意 Local)

    • 获取方式:

      • runtimeService.getVariableLocal(executionId, variableName) (注意 Local)

      • runtimeService.getVariablesLocal(executionId) (获取该执行流作用域所有变量)

      • 任务关联的执行流:taskService.getVariableLocal(taskId, variableName) (如果任务绑定到该执行流) 

  3. 任务作用域(Task Scope)

    • 容器: 一个用户任务 (Task)。

    • 生命周期: 从变量被设置开始,直到该任务完成或被删除

    • 可见性: 最低。变量仅对该任务本身可见。即使是同一个流程实例或同一个执行流下的其他任务也无法直接访问这些变量。通常用于存储仅与该特定任务处理相关的临时数据(如表单提交的草稿、任务备注等)。

    • 设置方式:

      • taskService.setVariableLocal(taskId, variableName, value) 或 taskService.setVariablesLocal(taskId, variablesMap) (注意 Local)

    • 获取方式:

      • taskService.getVariableLocal(taskId, variableName) (注意 Local)

      • taskService.getVariablesLocal(taskId) (获取该任务作用域所有变量)

作用域查找规则:

当通过 getVariable(variableName) (不带 Local) 方法(无论是在 RuntimeService 还是 TaskService 上)查询一个变量时,Flowable 会按照以下从具体到宽泛的作用域顺序查找:

  1. 任务作用域 (Task Scope): 如果调用方是任务(通过 taskService.getVariable(taskId, name)),先查任务本地变量。

  2. 执行流作用域 (Execution Scope): 如果任务本地没找到(或者调用方直接提供的是 executionId),则查找任务所属的执行流的本地变量。

  3. 流程实例作用域 (Process Instance Scope): 如果执行流本地也没找到,则查找流程实例变量。

  4. 父执行流/父流程实例作用域: 如果当前执行流是子流程或调用活动产生的,引擎还会向上查找父执行流(然后是父执行流的流程实例变量)。这实现了变量从父流程到子流程的传递(默认是单向传递,子流程变量不会自动影响父流程)。

 假设一个简单的请假流程: 员工提交请假申请 (Start Event) -> 部门经理审批 (User Task) -> 人事存档 (Service Task) -> 结束 (End Event)

// 1. **启动流程实例 (设置流程实例变量)**
Map<String, Object> startVariables = new HashMap<>();
startVariables.put("applicant", "张三"); // 申请人 (String)
startVariables.put("startDate", new Date()); // 开始日期 (Date)
startVariables.put("days", 3); // 请假天数 (Integer)
startVariables.put("reason", "回家探亲"); // 原因 (String)
startVariables.put("approvalComment", ""); // 初始化审批意见 (String)

ProcessInstance processInstance = runtimeService.startProcessInstanceByKey(
    "leaveRequestProcess", // 流程定义Key
    businessKey, // 可选业务键 (如请假单号)
    startVariables
);
String processInstanceId = processInstance.getId();

// 此时,变量 `applicant`, `startDate`, `days`, `reason`, `approvalComment` 都是**流程实例作用域**的变量。
// 整个流程实例内部任何地方都可以访问它们。

// 2. **部门经理审批任务 (查询和设置变量)**
// 假设经理查询待办任务
Task managerTask = taskService.createTaskQuery()
    .taskAssignee("李经理")
    .processInstanceId(processInstanceId)
    .singleResult();

// 2.1 **查询流程实例变量** (经理需要看到申请人提交的信息)
String reason = (String) taskService.getVariable(managerTask.getId(), "reason"); // 查找规则:先Task Local -> 无 -> Execution Local (此时任务通常没有Execution本地变量) -> 无 -> Process Instance -> 找到
Integer days = (Integer) taskService.getVariable(managerTask.getId(), "days");

// 2.2 **设置流程实例变量** (经理更新审批意见 - 这个意见后续流程也需要)
taskService.setVariable(managerTask.getId(), "approvalComment", "情况属实,同意请假"); // 没有Local,默认设置到流程实例作用域
// 或者明确设置流程实例变量 (效果同上)
// runtimeService.setVariable(processInstanceId, "approvalComment", "情况属实,同意请假");

// 2.3 **设置任务本地变量** (经理添加一个仅供自己或本次任务使用的临时备注)
taskService.setVariableLocal(managerTask.getId(), "internalNote", "记得提醒张三回来后补交车票复印件");
// 这个 `internalNote` 变量只存在于这个任务上。当经理完成任务后,这个变量通常就不存在了(除非配置了历史记录)。人事存档任务或后续流程无法直接通过 `getVariable` 访问到它。

// 3. **经理完成任务**
taskService.complete(managerTask.getId());
// 完成任务后,任务本地变量 `internalNote` 生命周期结束(除非历史记录)。流程实例变量 `approvalComment` 被更新并继续存在。

// 4. **人事存档服务任务 (查询流程实例变量)**
// 服务任务逻辑通常在 JavaDelegate 的 execute 方法中实现
public class ArchiveTask implements JavaDelegate {
    @Override
    public void execute(DelegateExecution execution) {
        // 获取当前执行流的Execution Id
        String executionId = execution.getId();
        // 获取流程实例ID
        String processInstanceId = execution.getProcessInstanceId();

        // **查询流程实例变量** (获取审批结果和申请信息)
        String applicant = (String) runtimeService.getVariable(processInstanceId, "applicant"); // 直接按流程实例ID查
        String comment = (String) execution.getVariable("approvalComment"); // DelegateExecution 的 getVariable 方法会按作用域查找规则查找
        // ... 执行存档逻辑 (如写入数据库,发送通知等)

        // **设置一个执行流本地变量** (假设存档操作生成了一个存档ID,只在这个执行路径后续可能用到)
        String archiveId = generateArchiveId();
        execution.setVariableLocal("archiveRefId", archiveId);
        // 这个 `archiveRefId` 只在这个特定的执行流(当前存档任务所在的执行流)上可见。如果流程后面还有活动,它们可以访问(如果是同一个执行流)。但如果是并行分支,其他分支看不到它。
    }
}

// 5. **流程结束**
// 当流程到达结束事件,整个流程实例结束。
// 所有流程实例作用域的变量 (`applicant`, `startDate`, `days`, `reason`, `approvalComment`) 的生命周期结束。
// 所有执行流作用域的变量 (`archiveRefId`) 的生命周期也随着其执行流结束而结束。

 流程实例 (Process Instance) [ID: proc-123]
  ├── 流程实例变量 (Scope)
  │     ├── applicant: "张三"
  │     ├── startDate: 2023-10-27
  │     ├── days: 3
  │     ├── reason: "回家探亲"
  │     └── approvalComment: "情况属实,同意请假"
  │
  ├── 执行流 A (Execution) [ID: exec-100] (主执行流)
  │     ├── 执行流本地变量 (Scope) (可能为空)
  │     │
  │     ├── 用户任务:部门经理审批 [ID: task-789]
  │     │     └── 任务本地变量 (Scope):internalNote: "记得提醒..."
  │     │
  │     └── 服务任务:人事存档
  │           ├── (执行中) 设置执行流本地变量:archiveRefId: "ARC-001"
  │           └── (执行完成后) archiveRefId 随执行流结束而消失
  │
  └── (假设有并行网关) 执行流 B (Execution) [ID: exec-101] (并行分支)
        └── ... (无法看到 exec-100 的本地变量 archiveRefId)

关键点总结:

  1. 作用域是核心: 明确变量应该放在哪个作用域(流程实例、执行流、任务)决定了它的生命周期和谁能访问它。优先使用能满足需求的最小作用域(如任务本地变量),避免不必要的“全局”污染。

  2. setVariable vs setVariableLocal setVariable 方法(不带 Local)会尝试设置到流程实例作用域(如果找不到同名的更本地作用域的变量),而 setVariableLocal 则明确设置到当前调用点所属的最小作用域(任务或执行流)。

  3. getVariable 的查找规则: 理解 getVariable 方法按照 任务本地 -> 执行流本地 -> 流程实例 -> (父作用域) 的查找顺序非常重要,这解释了为什么任务能访问到流程实例变量。

  4. 变量驱动流程: 网关(如排他网关)的条件表达式 ${days > 5} 会使用查找规则找到 days 变量(通常是流程实例变量)的值来决定路径。服务任务、任务监听器、执行监听器都可以读取和设置变量来实现业务逻辑。

  5. 序列化: 存储复杂自定义对象时,务必确保它们实现了 java.io.Serializable 接口。

  6. 历史: Flowable 的历史服务 (HistoryService) 可以查询历史流程实例变量和历史任务变量,即使流程实例已经结束。这对于审计和报表至关重要。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2394603.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

微信小程序关于截图、录屏拦截

1.安卓 安卓&#xff1a; 在需要禁止的页面添加 onShow() {if (wx.setVisualEffectOnCapture) {wx.setVisualEffectOnCapture({visualEffect: hidden,complete: function(res) {}})}},// 页面隐藏和销毁时需要释放防截屏录屏设置onHide() {if (wx.setVisualEffectOnCapture) {w…

基于51单片机的音乐盒键盘演奏proteus仿真

地址&#xff1a; https://pan.baidu.com/s/1tZCAxQQ7cvyzBfztQpk0UA 提取码&#xff1a;1234 仿真图&#xff1a; 芯片/模块的特点&#xff1a; AT89C52/AT89C51简介&#xff1a; AT89C51 是一款常用的 8 位单片机&#xff0c;由 Atmel 公司&#xff08;现已被 Microchip 收…

【unity游戏开发——编辑器扩展】EditorUtility编辑器工具类实现如文件操作、进度条、弹窗等操作

注意&#xff1a;考虑到编辑器扩展的内容比较多&#xff0c;我将编辑器扩展的内容分开&#xff0c;并全部整合放在【unity游戏开发——编辑器扩展】专栏里&#xff0c;感兴趣的小伙伴可以前往逐一查看学习。 文章目录 前言一、确认弹窗1、确认弹窗1.1 主要API1.2 示例 2、三按钮…

Android之ListView

1&#xff1a;简单列表(ArrayAdapter) 1&#xff1a;运行的结果&#xff1a; 2&#xff1a;首先在MyListView里面创建一个按钮&#xff0c;点击的时候进行跳转。 这里让我吃惊的是&#xff0c;Button里面可以直接设置onClick .java里面的方法。 也即是点击这个按钮之后就会去…

《Spring Cloud Gateway 快速入门:从路由到自定义 Filter 的完整教程》​

1.网关介绍 在前面的学习中&#xff0c;我们通过Eureka和Nacos解决了辅助注册&#xff0c;使用Spring Cloud LoadBalance解决了负载均衡的问题&#xff0c;使用OpenFeign解决了远程调用的问题。 但是当前的所有微服务的接口都是直接对外暴露的&#xff0c;外部是可以直接访问…

第3节 Node.js 创建第一个应用

Node.js 非常强大&#xff0c;只需动手写几行代码就可以构建出整个HTTP服务器。事实上&#xff0c;我们的Web应用以及对应的Web服务器基本上是一样的。 在我们创建Node.js第一个"Hello, World!"应用前&#xff0c;让我们先了解下Node.js应用是由哪几部分组成的&…

我们来学mysql -- “数据备份还原”sh脚本

数据备份&还原 说明执行db_backup_cover.sh脚本 说明 环境准备&#xff1a;来源数据库(服务器A)&#xff1b;目标数据库(服务器B)dbInfo.sh脚本记录基本信息 来源库、目标库的ip、port及执行路径 # MySQL 客户端和 mysqldump 的路径 MYSQL_CLIENT"/work/oracle/mysql…

【排序算法】快速排序详解--附详细流程代码

快速排序算法 介绍 快速排序&#xff08;Quick Sort&#xff09;是一种高效的分治排序算法&#xff0c;由英国计算机科学家 Tony Hoare 于 1960 年提出。它是实际应用中最常用的排序算法之一。快速排序的基本思想是&#xff1a;选择一个"基准"&#xff08;pivot&am…

解决各个系统报错TDengine:no taos in java.library.path问题

windows 系统解决办法 在本地上安装一个TD的Windows客户端&#xff0c;注意安装的客户端版本一定要和服务端TD版本完全一致。&#xff08;或者将 C:\TDengine\driver\taos.dll 拷贝到 C:\Windows\System32\ 目录下&#xff09; 客户端各个历史版本下载链接&#xff1a;TDengin…

java helloWord java程序运行机制 用idea创建一个java项目 标识符 关键字 数据类型 字节

HelloWord public class Hello{public static void main(String[] args) {System.out.print("Hello,World!");} }java程序运行机制 用idea创建一个java项目 建立一个空项目 新建一个module 注释 标识符 关键字 标识符注意点 数据类型 public class Demo02 {public st…

免费文本转语音工具体验:祈风TTS使用

简介&#xff1a;语音生成的另一种方式 现在很多人通过视频记录生活&#xff0c;表达观点。拍摄剪辑不难&#xff0c;配音成了常见难题。部分人对自己的声音不够自信&#xff0c;也有人在特定场景下不便出声。文本转语音工具可以成为解决方案。 常见的TTS&#xff08;Text To…

JS和TS的区别

JavaScript 与 TypeScript 的主要区别和特性对比 1. 基础定义 JavaScript 是一种动态、弱类型的编程语言&#xff0c;广泛应用于前端开发以及通过 Node.js 扩展到后端开发。TypeScript 则是 JavaScript 的超集&#xff0c;它在 JavaScript 的基础上添加了静态类型系统和其他增…

Python实现P-PSO优化算法优化BP神经网络分类模型项目实战

说明&#xff1a;这是一个机器学习实战项目&#xff08;附带数据代码文档&#xff09;&#xff0c;如需数据代码文档可以直接到文章最后关注获取。 1.项目背景 随着人工智能技术的快速发展&#xff0c;神经网络在分类任务中展现了强大的性能。BP&#xff08;Back Propagation&…

Linux --进度条小程序更新

这里使用随机数来模拟下载量&#xff0c;来实现一个下载进度更新的小程序 main.c 的代码&#xff0c;其中downlod这个函数使用的是函数指针&#xff0c;如果有多个进度条函数可以传入进行多样化的格式下载显示&#xff0c;还需要传入一个下载总量&#xff0c;每次"下载以…

关于镜像如何装进虚拟机

本篇文章为感谢小仙猪老师特别编写 本篇文章仅以Ubuntu为例 目录 创建虚拟机 汉化 如果没有China选项 检查网络 创建虚拟机 第一步&#xff0c;创建虚拟机 因为&#xff0c;第一个选项是会把虚拟机的文件放在c盘因此&#xff0c;这里博主选择自定义&#xff0c;然后下一…

智慧体育馆数字孪生,场馆管理智能化

图扑数字孪生智慧体育馆可视化管理平台。通过高精度三维建模&#xff0c;对体育馆建筑结构、设施设备等进行 1:1 虚拟映射&#xff0c;全方位还原场馆物理实体。系统集成多维度传感器数据&#xff0c;实现对人流量、客流密度、区域拥堵指数等信息的实时采集与分析&#xff0c;动…

回归算法模型之线性回归

哈喽&#xff01;我是 我不是小upper&#xff5e; 今天来和大家聊聊「线性回归」—— 这是机器学习里最基础、最直观的算法之一&#xff0c;咱们用一个超简单的例子就能搞懂它&#xff01; 先看一个生活场景 假设你是房产中介&#xff0c;遇到一个灵魂拷问&#xff1a; 客户有…

【深度学习】10. 深度推理(含链式法则详解)RNN, LSTM, GRU,VQA

深度推理&#xff08;含链式法则详解&#xff09;RNN, LSTM, GRU&#xff0c;VQA RNN 输入表示方式 在循环神经网络&#xff08;Recurrent Neural Network, RNN&#xff09;中&#xff0c;我们处理的是一段文字或语音等序列数据。对于文本任务&#xff0c;输入通常是单词序列…

【Qt】Bug:findChildren找不到控件

使用正确的父对象调用 findChildren&#xff1a;不要在布局对象上调用 findChildren&#xff0c;而应该在布局所在的窗口或控件上调用。

【linux】linux进程概念(四)(环境变量)超详细版

小编个人主页详情<—请点击 小编个人gitee代码仓库<—请点击 linux系列专栏<—请点击 倘若命中无此运&#xff0c;孤身亦可登昆仑&#xff0c;送给屏幕面前的读者朋友们和小编自己! 目录 前言一、基本概念二、认识常见的几个环境变量echo $ 查看某个环境变量env 显示…