执行监听器、任务监听器

友情提示：

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

## [#](https://doc.iocoder.cn/bpm/listener/#_1-%E6%89%A7%E8%A1%8C%E7%9B%91%E5%90%AC%E5%99%A8)1. 执行监听器

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

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

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

学习文档：

* [《Flowable BPMN 用户手册 (v 6.3.0) —— 执行监听器》(opens new window)](https://tkjohn.github.io/flowable-userguide/#executionListeners)
* [《Flowable 服务任务执行的三种方式》(opens new window)](https://developer.aliyun.com/article/1233153)
* [《Flowable 服务任务类，表达式，委托表达式（代理表达式）》(opens new window)](https://blog.csdn.net/CCCout/article/details/132454867)

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

![执行监听器](/media/202404/2024-04-26_0111180.7702368801801164.png)

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

### [#](https://doc.iocoder.cn/bpm/listener/#_1-1-java-%E7%B1%BB%E7%9B%91%E5%90%AC%E5%99%A8)1.1 Java 类监听器

① 新建一个 [DemoDelegateClassExecutionListener **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/framework/flowable/core/listener/demo/exection/DemoDelegateClassExecutionListener.java) 类，需要实现 `org.flowable.engine.delegate.JavaDelegate` 接口，如下图所示：

![DemoDelegateClassExecutionListener](/media/202404/2024-04-26_0111180.8146866379127453.png)

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

![配置监听器](/media/202404/2024-04-26_0111180.7048296142521822.png)

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

### [#](https://doc.iocoder.cn/bpm/listener/#_1-2-%E5%A7%94%E6%89%98%E8%A1%A8%E8%BE%BE%E5%BC%8F%E7%9B%91%E5%90%AC%E5%99%A8)1.2 委托表达式监听器

① 新建一个 [DemoDelegateExpressionExecutionListener **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/framework/flowable/core/listener/demo/exection/DemoDelegateExpressionExecutionListener.java) 类，也需要实现 `org.flowable.engine.delegate.JavaDelegate` 接口，如下图所示：

![DemoDelegateExpressionExecutionListener](/media/202404/2024-04-26_0111180.4229282856020774.png)

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

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

![配置监听器](/media/202404/2024-04-26_0111180.5587259577417295.png)

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

### [#](https://doc.iocoder.cn/bpm/listener/#_1-3-spring-%E8%A1%A8%E8%BE%BE%E5%BC%8F%E7%9B%91%E5%90%AC%E5%99%A8)1.3 Spring 表达式监听器

① 新建一个 [DemoSpringExpressionExecutionListener **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/framework/flowable/core/listener/demo/exection/DemoSpringExpressionExecutionListener.java) 类，只需要声明成 Spring Bean，如下图所示：

![DemoSpringExpressionExecutionListener](/media/202404/2024-04-26_0111180.11434748752594026.png)

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

![配置监听器](/media/202404/2024-04-26_0111180.1482860671465105.png)

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

## [#](https://doc.iocoder.cn/bpm/listener/#_2-%E4%BB%BB%E5%8A%A1%E7%9B%91%E5%90%AC%E5%99%A8)2. 任务监听器

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

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

学习文档：

* [《Flowable BPMN 用户手册 (v 6.3.0) —— 任务监听器》(opens new window)](https://tkjohn.github.io/flowable-userguide/#taskListeners)

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

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

### [#](https://doc.iocoder.cn/bpm/listener/#_2-1-java-%E7%B1%BB%E7%9B%91%E5%90%AC%E5%99%A8)2.1 Java 类监听器

① 新建一个 [DemoDelegateClassTaskListener **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/framework/flowable/core/listener/demo/task/DemoDelegateClassTaskListener.java) 类，需要实现 `org.flowable.engine.delegate.TaskListener` 接口，如下图所示：

![DemoDelegateClassTaskListener](/media/202404/2024-04-26_0111180.20067108149008428.png)

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

![配置监听器](/media/202404/2024-04-26_0111180.8324031155065672.png)

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

### [#](https://doc.iocoder.cn/bpm/listener/#_2-2-%E5%A7%94%E6%89%98%E8%A1%A8%E8%BE%BE%E5%BC%8F%E7%9B%91%E5%90%AC%E5%99%A8)2.2 委托表达式监听器

① 新建一个 [DemoDelegateExpressionTaskListener **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/framework/flowable/core/listener/demo/task/DemoDelegateExpressionTaskListener.java) 类，也需要实现 `org.flowable.engine.delegate.TaskListener` 接口，如下图所示：

![DemoDelegateExpressionTaskListener](/media/202404/2024-04-26_0111180.6181216687284504.png)

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

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

![配置监听器](/media/202404/2024-04-26_0111180.41069774808061954.png)

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

### [#](https://doc.iocoder.cn/bpm/listener/#_2-3-spring-%E8%A1%A8%E8%BE%BE%E5%BC%8F%E7%9B%91%E5%90%AC%E5%99%A8)2.3 Spring 表达式监听器

① 新建一个 [DemoSpringExpressionTaskListener **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/framework/flowable/core/listener/demo/task/DemoSpringExpressionTaskListener.java) 类，只需要声明成 Spring Bean，如下图所示：

![DemoSpringExpressionTaskListener](/media/202404/2024-04-26_0111180.8169097149105508.png)

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

![配置监听器](/media/202404/2024-04-26_0111180.15652990736648098.png)

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

## [#](https://doc.iocoder.cn/bpm/listener/#_3-%E6%B5%81%E7%A8%8B%E7%9B%91%E5%90%AC%E5%99%A8%E7%9A%84%E6%A8%A1%E7%89%88)3. 流程监听器的模版

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

![流程监控器](/media/202404/2024-04-26_0111180.10349231002756476.png)

* 前端，对应 `views/bpm/processListener/index.vue` 提供界面
* 后端，对应 `BpmProcessListenerController` 提供接口

### [#](https://doc.iocoder.cn/bpm/listener/#_3-1-%E4%BD%BF%E7%94%A8%E5%9C%BA%E6%99%AF)3.1 使用场景

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

![选择监听器](/media/202404/2024-04-26_0111180.15505935272483728.png)

### [#](https://doc.iocoder.cn/bpm/listener/#_3-2-%E8%A1%A8%E7%BB%93%E6%9E%84)3.2 表结构

流程监听器表，是我们自己定义的 `bpm_process_instance_copy` 表，结构如下：

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

```sql
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 类的全路径、表达式、委托表达式。