Flowable中AbstractFlowableEventListener什么时候被调用？

Question

在Flowable工作流引擎中，`AbstractFlowableEventListener` 是一个抽象类，用于监听流程中的事件。那么，`AbstractFlowableEventListener` 什么时候会被调用呢？它会在配置的事件类型触发时被调用，例如 `start`, `end`, 或 `activity` 等事件。具体来说，当流程实例、任务或活动达到某个状态或发生特定动作时，如果该监听器已注册并匹配到对应的事件类型，就会执行其 `onEvent` 方法。此外，只有当 `isFireOnEvent` 方法返回 `true` 时，`onEvent` 才会真正被执行。这使得开发者可以灵活控制哪些事件需要处理。通常，这类监听器可用于日志记录、业务逻辑扩展或外部系统集成等场景。因此，在实际开发中，明确需要监听的事件类型和条件是关键。

Answer 1

1. 初识 AbstractFlowableEventListener

在 Flowable 工作流引擎中，AbstractFlowableEventListener 是一个抽象类，它为开发者提供了一个监听流程事件的基础框架。通过继承这个类并实现其方法，我们可以捕获工作流中的关键事件，例如流程的启动 (start)、结束 (end) 或特定活动的发生 (activity)。

以下是常见的触发场景：

• Start Event: 当一个新的流程实例被创建时触发。
• End Event: 当流程实例完成或终止时触发。
• Activity Event: 当某个任务或活动被处理时触发。

要让监听器生效，必须确保以下条件：

1. 监听器已注册到 Flowable 引擎。
2. 监听器匹配了指定的事件类型。
3. isFireOnEvent 方法返回 true。

2. 深入分析调用机制

为了更深入地理解 AbstractFlowableEventListener 的调用时机，我们需要从以下几个方面进行剖析：

事件类型	触发条件	适用场景
Start	当调用 runtimeService.startProcessInstanceByKey() 创建流程实例时。	记录流程开始时间或初始化外部系统资源。
End	当流程到达终点事件或被显式终止时。	清理资源、生成报表或通知相关方。
Activity	当某个用户任务、服务任务或其他活动被执行时。	动态调整流程逻辑或同步业务数据。

值得注意的是，onEvent 方法是核心逻辑的入口点，但它的执行依赖于 isFireOnEvent 方法的判断结果。这意味着开发者可以通过重写 isFireOnEvent 来控制哪些事件需要进一步处理。

3. 实际开发中的应用案例

在实际项目中，AbstractFlowableEventListener 可以用于多种场景，例如：

• 日志记录: 捕获流程的关键事件并记录到数据库或文件中。
• 业务逻辑扩展: 根据流程状态动态调整后续步骤。
• 外部系统集成: 在特定事件发生时通知第三方系统。

下面是一个简单的代码示例，展示如何实现一个监听器：

public class CustomFlowableListener extends AbstractFlowableEventListener {
    @Override
    protected void onEvent(FlowableEngineEventType eventType, Object source) {
        if (eventType == FlowableEngineEventType.PROCESS_STARTED) {
            System.out.println("流程已启动: " + source);
        }
    }

    @Override
    protected boolean isFireOnEvent(FlowableEngineEventType eventType) {
        return eventType == FlowableEngineEventType.PROCESS_STARTED;
    }
}

此外，我们还可以通过流程图直观地展示事件监听器的工作流程：

graph TD;
    A[流程启动] --> B{是否注册监听器};
    B -- 是 --> C{是否匹配事件类型};
    C -- 是 --> D{isFireOnEvent 是否为 true};
    D -- 是 --> E[执行 onEvent 方法];