ruoyi-vue-pro 开发指南 ruoyi-vue-pro 开发指南
  • 萌新必读
  • 后端手册
  • 中间件手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 会员手册
  • 商城手册
  • ERP 手册
  • CRM 手册
  • AI 大模型手册
  • IoT 物联网手册
  • 公众号手册
  • 系统手册
  • 运维手册
  • 前端手册 Vue 2.x
  • 前端手册 Vue 3.x
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 会员手册
  • 商城手册
  • ERP 手册
  • CRM 手册
  • AI 大模型手册
  • IoT 物联网手册
  • 公众号手册
  • 系统手册
视频教程
  • Vue3 + element-plus (opens new window)
  • Vue3 + vben(ant-design-vue) (opens new window)
  • Vue2 + element-ui (opens new window)
微服务版 (opens new window)
作者博客 (opens new window)
GitHub (opens new window)
  • 萌新必读
  • 后端手册
  • 中间件手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 会员手册
  • 商城手册
  • ERP 手册
  • CRM 手册
  • AI 大模型手册
  • IoT 物联网手册
  • 公众号手册
  • 系统手册
  • 运维手册
  • 前端手册 Vue 2.x
  • 前端手册 Vue 3.x
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 会员手册
  • 商城手册
  • ERP 手册
  • CRM 手册
  • AI 大模型手册
  • IoT 物联网手册
  • 公众号手册
  • 系统手册
视频教程
  • Vue3 + element-plus (opens new window)
  • Vue3 + vben(ant-design-vue) (opens new window)
  • Vue2 + element-ui (opens new window)
微服务版 (opens new window)
作者博客 (opens new window)
GitHub (opens new window)
  • 萌新必读

    • 简介
    • 交流群
    • 视频教程
    • 功能列表
    • 快速启动(后端项目)
    • 快速启动(前端项目)
    • 接口文档
    • 技术选型
    • 项目结构
    • 代码热加载
    • 一键改包
    • 迁移模块(适合新项目)
    • 删除功能(以租户为例)
    • 表结构变更(版本升级)
    • 国产信创数据库(DM 达梦、大金、OpenGauss)
    • 如何去除 Redis 缓存
    • 内网穿透
    • 面试题、简历模版、简历优化
    • 项目外包
  • 后端手册

    • 新建模块
    • 代码生成【单表】(新增功能)
    • 代码生成【主子表】
    • 代码生成(树表)
    • 功能权限
    • 数据权限
    • 用户体系
    • 三方登录
    • OAuth 2.0(SSO 单点登录)
    • SaaS 多租户【字段隔离】
    • SaaS 多租户【数据库隔离】
    • WebSocket 实时通信
    • 异常处理(错误码)
    • 参数校验、时间传参
    • 分页实现
    • VO 对象转换、数据翻译
    • 文件存储(上传下载)
    • Excel 导入导出
    • 操作日志、访问日志、异常日志
    • MyBatis 数据库
    • MyBatis 联表&分页查询
    • 多数据源(读写分离)、事务
    • Redis 缓存
    • 本地缓存
    • 异步任务
    • 分布式锁
    • 幂等性(防重复提交)
    • 请求限流(RateLimiter)
    • HTTP 接口签名(防篡改)
    • 单元测试
    • 验证码
    • 工具类 Util
    • 配置管理
    • 数据库文档
  • 中间件手册

    • 定时任务
    • 消息队列(内存)
    • 消息队列(Redis)
    • 消息队列(RocketMQ)
    • 消息队列(RabbitMQ)
    • 消息队列(Kafka)
    • 限流熔断
  • 工作流手册

    • 工作流演示
    • 功能开启
    • 工作流(达梦适配)
    • 审批接入(流程表单)
    • 审批接入(业务表单)
    • 流程设计器(BPMN)
    • 流程设计器(钉钉、飞书)
    • 选择审批人、发起人自选
    • 会签、或签、依次审批
    • 流程发起、取消、重新发起
    • 审批通过、不通过、驳回
    • 审批加签、减签
    • 审批转办、委派、抄送
    • 执行监听器、任务监听器
      • 1. 执行监听器
        • 1.1 Java 类监听器
        • 1.2 委托表达式监听器
        • 1.3 Spring 表达式监听器
      • 2. 任务监听器
        • 2.1 Java 类监听器
        • 2.2 委托表达式监听器
        • 2.3 Spring 表达式监听器
      • 3. 流程监听器的模版
        • 3.1 使用场景
        • 3.2 表结构
    • 流程表达式
    • 流程审批通知
  • 大屏手册

    • 报表设计器
    • 大屏设计器
  • 支付手册

    • 功能开启
    • 支付宝支付接入
    • 微信公众号支付接入
    • 微信小程序支付接入
    • 支付宝、微信退款接入
    • 支付宝转账接入
    • 微信转账接入
    • 钱包充值、支付、退款
    • 模拟支付、退款
  • 会员手册

    • 功能开启
    • 微信公众号登录
    • 微信小程序登录
    • 微信小程序订阅消息
    • 微信小程序码
    • 会员用户、标签、分组
    • 会员等级、积分、签到
  • 商城手册

    • 商城演示
    • 功能开启
    • 商城装修
    • 在线客服
    • 【商品】商品分类
    • 【商品】商品属性
    • 【商品】商品 SPU 与 SKU
    • 【商品】商品评价
    • 【交易】购物车
    • 【交易】交易订单
    • 【交易】售后退款
    • 【交易】快递发货
    • 【交易】门店自提
    • 【交易】分销返佣
    • 【营销】优惠劵
    • 【营销】积分商城
    • 【营销】拼团活动
    • 【营销】秒杀活动
    • 【营销】砍价活动
    • 【营销】满减送活动
    • 【营销】限时折扣
    • 【营销】内容管理
    • 【统计】会员、商品、交易统计
  • ERP手册

    • ERP 演示
    • 功能开启
    • 【产品】产品信息、分类、单位
    • 【库存】产品库存、库存明细
    • 【库存】其它入库、其它出库
    • 【库存】库存调拨、库存盘点
    • 【采购】采购订单、入库、退货
    • 【销售】销售订单、出库、退货
    • 【财务】采购付款、销售收款
  • CRM手册

    • CRM 演示
    • 功能开启
    • 【线索】线索管理
    • 【客户】客户管理、公海客户
    • 【商机】商机管理、商机状态
    • 【合同】合同管理、合同提醒
    • 【回款】回款管理、回款计划
    • 【产品】产品管理、产品分类
    • 【通用】数据权限
    • 【通用】跟进记录、待办事项
  • AI大模型手册

    • AI 大模型演示
    • 功能开启
    • AI 聊天对话
    • AI 绘画创作
    • AI 知识库
    • AI 音乐创作
    • AI 写作助手
    • AI 思维导图
    • AI 工具(function calling)
    • AI 工作流
    • Dify 工作流
    • FastGPT 工作流
    • Coze 智能体
    • 【模型接入】OpenAI
    • 【模型接入】通义千问
    • 【模型接入】DeepSeek
    • 【模型接入】字节豆包
    • 【模型接入】腾讯混元
    • 【模型接入】硅基流动
    • 【模型接入】MiniMax
    • 【模型接入】月之暗灭
    • 【模型接入】百川智能
    • 【模型接入】文心一言
    • 【模型接入】LLAMA
    • 【模型接入】智谱 GLM
    • 【模型接入】讯飞星火
    • 【模型接入】微软 OpenAI
    • 【模型接入】谷歌 Gemini
    • 【模型接入】Stable Diffusion
    • 【模型接入】Midjourney
    • 【模型接入】Suno
  • IoT物联网手册

    • 功能开启
  • 公众号手册

    • 功能开启
    • 公众号接入
    • 公众号粉丝
    • 公众号标签
    • 公众号消息
    • 自动回复
    • 公众号菜单
    • 公众号素材
    • 公众号图文
    • 公众号统计
  • 系统手册

    • 短信配置
    • 邮件配置
    • 站内信配置
    • 数据脱敏、字段权限
    • 敏感词
    • 地区 & IP 库
  • 运维手册

    • 开发环境
    • Linux 部署
    • Docker 部署
    • Jenkins 部署
    • 宝塔部署
    • HTTPS 证书
    • 服务监控
  • 前端手册 Vue 3.x

    • 开发规范
    • 菜单路由
    • Icon 图标
    • 字典数据
    • 系统组件
    • 通用方法
    • 配置读取
    • CRUD 组件
    • 国际化
    • IDE 调试
    • 代码格式化
  • 前端手册 Vue 2.x

    • 开发规范
    • 菜单路由
    • Icon 图标
    • 字典数据
    • 系统组件
    • 通用方法
    • 配置读取
  • 更新日志

    • 【v2-6-0】开发中
    • 【v2.5.0】2025-05-13
    • 【v2.4.2】2025-04-12
    • 【v2.4.1】2025-02-09
    • 【v2.4.0】2024-12-31
    • 【v2.3.0】2024-10-07
    • 【v2.2.0】2024-08-02
    • 【v2.1.0】2024-05-05
    • 【v2.0.1】2024-03-01
    • 【v2.0.0】2024-01-26
  • 开发指南
  • 工作流手册
芋道源码
2024-03-26
目录

执行监听器、任务监听器

友情提示:

在 BPMN 设计流程图,配置完监听器后,一定要发布流程,否则监听器不会生效。

# 1. 执行监听器

执行监听器(execution listener),可以在流程执行中发生特定的事件时,执行外部 Java 代码或计算表达式。可以被捕获的事件有:

  • 流程实例的启动和结束
  • 流程执行转移
  • 活动的启动和结束
  • 网关的启动和结束
  • 中间事件的启动和结束
  • 启动事件的结束,和结束事件的启动

总结来说,可以监听的事件只有 start 开始、end 结束。

学习文档:

  • 《Flowable BPMN 用户手册 (v 6.3.0) —— 执行监听器》 (opens new window)
  • 《Flowable 服务任务执行的三种方式》 (opens new window)
  • 《Flowable 服务任务类,表达式,委托表达式(代理表达式)》 (opens new window)

我们可以在 BPMN 设计流程图时,给某个节点添加执行监听器,监听器可以是 Java 类、表达式、委托表达式。如下图所示:

执行监听器

这三种监听器怎么使用呢?我们逐个来看看。

# 1.1 Java 类监听器

① 新建一个 DemoDelegateClassExecutionListener (opens new window) 类,需要实现 org.flowable.engine.delegate.JavaDelegate 接口,如下图所示:

图片纠错:最新版本不区分 yudao-module-bpm-api 和 yudao-module-bpm-biz 子模块,代码直接合并到 yudao-module-bpm 模块的 src 目录下,更适合单体项目

DemoDelegateClassExecutionListener

② 在 BPMN 流程图中,配置 Java 类监听器,如下图所示:

配置监听器

注意,图中填写的是 cn.iocoder.yudao.module.bpm.framework.flowable.core.listener.demo.exection.DemoDelegateClassExecutionListener 全路径。

# 1.2 委托表达式监听器

① 新建一个 DemoDelegateExpressionExecutionListener (opens new window) 类,也需要实现 org.flowable.engine.delegate.JavaDelegate 接口,如下图所示:

图片纠错:最新版本不区分 yudao-module-bpm-api 和 yudao-module-bpm-biz 子模块,代码直接合并到 yudao-module-bpm 模块的 src 目录下,更适合单体项目

DemoDelegateExpressionExecutionListener

并且,需要声明成 Spring Bean!本质上,“委托表达式”是“Java 类”的特例,和 Spring 做了集成。

② 在 BPMN 流程图中,配置委托表达式监听器,如下图所示:

配置监听器

注意,图中填写的是 ${demoDelegateExpressionExecutionListener},这个是 Spring Bean 的名称。

# 1.3 Spring 表达式监听器

① 新建一个 DemoSpringExpressionExecutionListener (opens new window) 类,只需要声明成 Spring Bean,如下图所示:

DemoSpringExpressionExecutionListener

② 在 BPMN 流程图中,配置 Spring 表达式监听器,如下图所示:

配置监听器

注意,图中填写的是 ${demoSpringExpressionExecutionListener.execute(execution)},这个就是通过 Spring EL 表达式,实现对某个 Bean 的某个方法的调用。

# 2. 任务监听器

任务监听器(task listener),用于在特定的任务相关事件发生时,执行自定义的 Java 逻辑或表达式。

相比执行器来说,它只能监听 UserTask 用户任务,但是事件有 create 创建、assignment 指派、complete 完成、delete 删除、update 更新、timeout 超时。

学习文档:

  • 《Flowable BPMN 用户手册 (v 6.3.0) —— 任务监听器》 (opens new window)

我们可以在 BPMN 设计流程图时,给某个节点添加任务监听器,监听器可以是 Java 类、表达式、委托表达式。如下图所示:

友情提示:任务监听器,和执行监听器的使用基本是一致的。

# 2.1 Java 类监听器

① 新建一个 DemoDelegateClassTaskListener (opens new window) 类,需要实现 org.flowable.engine.delegate.TaskListener 接口,如下图所示:

图片纠错:最新版本不区分 yudao-module-bpm-api 和 yudao-module-bpm-biz 子模块,代码直接合并到 yudao-module-bpm 模块的 src 目录下,更适合单体项目

DemoDelegateClassTaskListener

② 在 BPMN 流程图中,配置 Java 类监听器,如下图所示:

配置监听器

注意,图中填写的是 cn.iocoder.yudao.module.bpm.framework.flowable.core.listener.demo.task.DemoDelegateClassTaskListener 全路径。

# 2.2 委托表达式监听器

① 新建一个 DemoDelegateExpressionTaskListener (opens new window) 类,也需要实现 org.flowable.engine.delegate.TaskListener 接口,如下图所示:

图片纠错:最新版本不区分 yudao-module-bpm-api 和 yudao-module-bpm-biz 子模块,代码直接合并到 yudao-module-bpm 模块的 src 目录下,更适合单体项目

DemoDelegateExpressionTaskListener

并且,需要声明成 Spring Bean!本质上,“委托表达式”是“Java 类”的特例,和 Spring 做了集成。

② 在 BPMN 流程图中,配置委托表达式监听器,如下图所示:

配置监听器

注意,图中填写的是 ${demoDelegateExpressionTaskListener},这个是 Spring Bean 的名称。

# 2.3 Spring 表达式监听器

① 新建一个 DemoSpringExpressionTaskListener (opens new window) 类,只需要声明成 Spring Bean,如下图所示:

图片纠错:最新版本不区分 yudao-module-bpm-api 和 yudao-module-bpm-biz 子模块,代码直接合并到 yudao-module-bpm 模块的 src 目录下,更适合单体项目

DemoSpringExpressionTaskListener

② 在 BPMN 流程图中,配置 Spring 表达式监听器,如下图所示:

配置监听器

注意,图中填写的是 ${demoSpringExpressionTaskListener.notify(task)},这个就是通过 Spring EL 表达式,实现对某个 Bean 的某个方法的调用。

# 3. 流程监听器的模版

在 [工作流程 -> 流程管理 -> 流程监控器] 菜单,可以配置执行监听器、任务监听器的模版。如下图所示:

流程监控器

  • 前端,对应 views/bpm/processListener/index.vue 提供界面
  • 后端,对应 BpmProcessListenerController 提供接口

# 3.1 使用场景

当我们在 BPMN 流程图中,配置监听器时,可以选择模版,而不需要每次都填写监听器信息。如下图所示:

选择监听器

# 3.2 表结构

流程监听器表,是我们自己定义的 bpm_process_listener 表,结构如下:

省略 creator/create_time/updater/update_time/deleted/tenant_id 等通用字段

CREATE TABLE `bpm_process_listener` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT '编号',
  `name` varchar(30) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '监听器名字',
  
  `type` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '监听器类型',
  
  `status` tinyint NOT NULL COMMENT '监听器状态',
  
  `event` varchar(30) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '监听事件',
  
  `value_type` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '' COMMENT '监听器值类型',
  `value` varchar(1024) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '监听器值',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=119 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='BPM 流程监听器表';

① type 字段,表示监听器类型,可以是 execution 执行监听器、task 任务监听器。

② event 字段,表示监听事件,可以是执行监听器的 start 开始、end 结束,或者任务监听器的 create 创建、assignment 指派、complete 完成、delete 删除、update 更新、timeout 超时。

③ value_type 字段,表示监听器值类型,可以是 class Java 类、expression 表达式、delegateExpression 委托表达式。

value 字段,表示监听器值,可以是 Java 类的全路径、表达式、委托表达式。

审批转办、委派、抄送
流程表达式

← 审批转办、委派、抄送 流程表达式→

Theme by Vdoing | Copyright © 2019-2025 芋道源码 | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×