Activiti6.0 事件详解

系统管理员 2023-01-11 08:54 293阅读 0赞

文末提供 activiti学习视频下载

--------------------

### 文章目录 ###

*   *   *  1. 事件监听器实现
         *  2. 配置与安装
         *  3. 在运行阶段添加监听器
         *   *  3.1 自定义事件监听和发布
         *  4. 为流程定义添加监听器
         *   *  4.1 让监听器执行用户定义的逻辑
             *  4.2 监听抛出BPMN事件
             *  4.3 流程定义中监听器的注意事项
         *  5. 通过API分发事件
         *  6. 支持的事件类型
         *  7. 附加信息

Activiti引擎中的事件机制使您可以 **在引擎中发生各种事件时得到通知**，这是高级应用部分，可以让我们扩展一些我们的自定义逻辑，下面章节会有所有受支持的事件类型及其描述。

*  可以为**某些类型的事件**注册侦听器，而不是在分派任何类型的事件时得到通知。
 *  可以**通过配置**添加引擎范围的事件监听器。
 *  可以在**运行期间**用API添加范围的事件侦听器。
 *  可以在BPMN XML中添加事件侦听器。

所有分发的事件，都是`org.activiti.engine.delegate.event.ActivitiEvent`的子类。事件包含type`，`executionId`，`processInstanceId`和`processDefinitionId\`。 对应的事件会包含事件发生时对应上下文的额外信息。

### 1. 事件监听器实现 ###

实现事件监听器的唯一要求是实现`org.activiti.engine.delegate.event.ActivitiEventListener`。 下面是一个实现监听器的例子，它会把所有监听到的事件打印到标准输出中，包括job执行的事件异常：

@Component
    public class MyEventListener implements ActivitiEventListener { 
    
      @Override
      public void onEvent(ActivitiEvent event) { 
        switch (event.getType()) { 
    
          case JOB_EXECUTION_SUCCESS:
            System.out.println("A job well done!");
            break;
    
          case JOB_EXECUTION_FAILURE:
            System.out.println("A job has failed...");
            break;
    
          default:
            System.out.println("Event received: " + event.getType());
        }
      }
    
      @Override
      public boolean isFailOnException() { 
        // false 代表吞异常onEvent方法的异常，不往外抛出
        return false;
      }
    }

`isFailOnException()`方法决定了当事件分发时，`onEvent(..)`方法抛出异常时的行为。

*  返回的是`false`，会忽略异常。
 *  当返回`true`时，异常不会忽略，继续向上传播，迅速导致当前命令失败。 当事件是一个API调用的一部分时（或其他事务性操作，比如job执行）， 事务就会回滚。当事件监听器中的行为不是业务性时，建议返回`false`。

activiti提供了一些基础的实现，实现了事件监听器的常用场景。可以用来作为基类或监听器实现的样例：

*  **org.activiti.engine.delegate.event.BaseEntityEventListener**： 这个事件监听器的基类可以用来监听实体相关的事件，可以针对某一类型实体，也可以是全部实体。 它隐藏了类型检测，并提供了三个需要重写的方法：`onCreate(..)`, `onUpdate(..)` 和 `onDelete(..)`，当实体创建，更新，或删除时调用。对于其他实体相关的事件，会调用 `onEntityEvent(..)`。

### 2. 配置与安装 ###

如果在流程引擎配置中配置了事件侦听器，则事件引擎在流程引擎启动时将处于活动状态，并在后续引擎重新启动后保持活动状态。

`eventListeners`属性需要`org.activiti.engine.delegate.event.ActivitiEventListener`的实例列表。 通常，我们可以声明一个内部的bean定义，或使用`ref`引用已定义的bean。 下面的代码，向配置添加了一个事件监听器，任何事件触发时都会提醒它，无论事件是什么类型：

为了监听特定类型的事件，可以使用`typedEventListeners`属性，它需要一个map参数。 map的key是逗号分隔的事件名（或单独的事件名）。 map的value是`org.activiti.engine.delegate.event.ActivitiEventListener`列表。 下面的代码演示了向配置中添加一个事件监听器，可以监听job执行成功或失败：

分发事件的顺序是由监听器添加时的顺序决定的。首先，会调用所有普通的事件监听器（`eventListeners`属性），按照它们在`list`中的次序。 然后，会调用所有对应类型的监听器（`typedEventListeners`属性），如果对应类型的事件被触发了。

**对应Spring Boot配置如下**：

/** * 自定义扩展配置 */
    @Configuration
    public class ActivitiConfig implements ProcessEngineConfigurationConfigurer { 
     
        /** * * @param processEngineConfiguration processEngineConfiguration */
        @Override
        public void configure(SpringProcessEngineConfiguration processEngineConfiguration) { 
    
            // 生成流程图的字体 解決工作流生成图片乱码问题
            processEngineConfiguration.setActivityFontName("宋体");
            processEngineConfiguration.setAnnotationFontName("宋体");
            processEngineConfiguration.setLabelFontName("宋体");
            processEngineConfiguration.setEventListeners()//
            processEngineConfiguration.setTypedEventListeners()//
        }
    }

### 3. 在运行阶段添加监听器 ###

可以通过API（`RuntimeService`）在运行阶段添加或删除额外的事件监听器：

/** * Adds an event-listener which will be notified of ALL events by the dispatcher. * @param listenerToAdd the listener to add */
    void addEventListener(ActivitiEventListener listenerToAdd);
    
    /** * Adds an event-listener which will only be notified when an event occurs, which type is in the given types. * @param listenerToAdd the listener to add * @param types types of events the listener should be notified for */
    void addEventListener(ActivitiEventListener listenerToAdd, ActivitiEventType... types);
    
    /** * Removes the given listener from this dispatcher. The listener will no longer be notified, * regardless of the type(s) it was registered for in the first place. * @param listenerToRemove listener to remove */
     void removeEventListener(ActivitiEventListener listenerToRemove);

> 请注意，**重新启动引擎**时**不会保留**在运行时添加的侦听器。

#### 3.1 自定义事件监听和发布 ####

runtimeService.addEventListener(new ProcessEventListener());
    runtimeService.dispatchEvent(new ActivitiEventImpl(ActivitiEventType.CUSTOM));

### 4. 为流程定义添加监听器 ###

可以为特定流程定义添加监听器。监听器只会监听与这个流程定义相关的事件，以及这个流程定义上发起的所有流程实例的事件。 监听器实现可以使用，全类名定义，引用实现了监听器接口的表达式，或配置为抛出一个message/signal/error的BPMN事件。

#### 4.1 让监听器执行用户定义的逻辑 ####

下面代码为一个流程定义添加了两个监听器。

*  第一个监听器会接收所有类型的事件，它是通过全类名定义的。
 *  第二个监听器只接收作业成功或失败的事件，它使用了定义在流程引擎配置中的`beans`属性中的一个bean。

对于实体相关的事件，也可以设置为针对某个流程定义的监听器，实现只监听发生在某个流程定义上的某个类型实体事件。 下面的代码演示了如何实现这种功能。可以用于所有实体事件（第一个例子），也可以只监听特定类型的事件（第二个例子）。

`entityType`支持的值有：`attachment`, `comment`, `execution`,`identity-link`, `job`, `process-instance`, `process-definition`, `task`。

#### 4.2 监听抛出BPMN事件 ####

**试验阶段**

另一种处理事件的方法是抛出一个BPMN事件。请注意它只针对与抛出一个activiti事件类型的BPMN事件。 比如，抛出一个BPMN事件，在流程实例删除时，会导致一个错误。 下面的代码演示了如何在流程实例中抛出一个signal，把signal抛出到外部流程（全局），在流程实例中抛出一个消息事件， 在流程实例中抛出一个错误事件。除了使用`class`或`delegateExpression`， 还使用了`throwEvent`属性，通过额外属性，指定了抛出事件的类型。

如果需要声明额外的逻辑，是否抛出BPMN事件，可以扩展activiti提供的监听器类。在子类中重写`isValidEvent(ActivitiEvent event)`， 可以防止抛出BPMN事件。对应的类是`org.activiti.engine.test.api.event.SignalThrowingEventListenerTest`, `org.activiti.engine.impl.bpmn.helper.MessageThrowingEventListener` 和 `org.activiti.engine.impl.bpmn.helper.ErrorThrowingEventListener`.

#### 4.3 流程定义中监听器的注意事项 ####

*  事件监听器只能声明在`process`元素中，作为`extensionElements`的子元素。 监听器不能定义在流程的单个activity下。
 *  `delegateExpression`中的表达式无法访问execution上下文，这与其他表达式不同（比如gateway）。 它只能引用定义在流程引擎配置的`beans`属性中声明的bean，或者使用spring（未使用beans属性）中所有实现了监听器接口的spring-bean。
 *  在使用监听器的 `class` 属性时，只会创建一个实例。记住监听器实现不会依赖成员变量， 确认是多线程安全的。
 *  当一个非法的事件类型用在`events`属性或`throwEvent`中时，流程定义发布时就会抛出异常。（会导致部署失败）。如果`class`或`delegateExecution`由问题（类不存在，不存在的bean引用，或代理类没有实现监听器接口），会在流程启动时抛出异常（或在第一个有效的流程定义事件被监听器接收时）。所以要保证引用的类正确的放在classpath下，表达式也要引用一个有效的实例。

### 5. 通过API分发事件 ###

我们提供了通过API使用事件机制的方法，允许大家触发定义在引擎中的任何自定义事件。 建议（不强制）只触发类型为`CUSTOM`的`ActivitiEvents`。可以通过`RuntimeService`触发事件：

/** * Dispatches the given event to any listeners that are registered. * @param event event to dispatch. * * @throws ActivitiException if an exception occurs when dispatching the event or when the {@link ActivitiEventDispatcher} * is disabled. * @throws ActivitiIllegalArgumentException when the given event is not suitable for dispatching. */
     void dispatchEvent(ActivitiEvent event);

### 6. 支持的事件类型 ###

下面是引擎中可能出现的所有事件类型。每个类型都对应`org.activiti.engine.delegate.event.ActivitiEventType`中的一个枚举值。

<table> 
 <thead> 
  <tr> 
   <th>事件名称</th> 
   <th>描述</th> 
   <th>事件类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ENGINE_CREATED</td> 
   <td>监听器监听的流程引擎已经创建完毕，并准备好接受API调用。</td> 
   <td><code>org.activiti...ActivitiEvent</code></td> 
  </tr> 
  <tr> 
   <td>ENGINE_CLOSED</td> 
   <td>监听器监听的流程引擎已经关闭，不再接受API调用。</td> 
   <td><code>org.activiti...ActivitiEvent</code></td> 
  </tr> 
  <tr> 
   <td>ENTITY_CREATED</td> 
   <td>创建了一个新实体。实体包含在事件中。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>ENTITY_INITIALIZED</td> 
   <td>创建了一个新实体，初始化也完成了。如果这个实体的创建会包含子实体的创建，这个事件会在子实体都创建/初始化完成后被触发，这是与<code>ENTITY_CREATED</code>的区别。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>ENTITY_UPDATED</td> 
   <td>更新了已存在的实体。实体包含在事件中。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>ENTITY_DELETED</td> 
   <td>删除了已存在的实体。实体包含在事件中。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>ENTITY_SUSPENDED</td> 
   <td>暂停了已存在的实体。实体包含在事件中。会被ProcessDefinitions, ProcessInstances 和 Tasks抛出。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>ENTITY_ACTIVATED</td> 
   <td>激活了已存在的实体，实体包含在事件中。会被ProcessDefinitions, ProcessInstances 和 Tasks抛出。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>JOB_EXECUTION_SUCCESS</td> 
   <td>作业执行成功。job包含在事件中。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>JOB_EXECUTION_FAILURE</td> 
   <td>作业执行失败。作业和异常信息包含在事件中。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code> and <code>org.activiti...ActivitiExceptionEvent</code></td> 
  </tr> 
  <tr> 
   <td>JOB_RETRIES_DECREMENTED</td> 
   <td>因为作业执行失败，导致重试次数减少。作业包含在事件中。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>TIMER_FIRED</td> 
   <td>触发了定时器。job包含在事件中。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>JOB_CANCELED</td> 
   <td>取消了一个作业。事件包含取消的作业。作业可以通过API调用取消， 任务完成后对应的边界定时器也会取消，在新流程定义发布时也会取消。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>ACTIVITY_STARTED</td> 
   <td>一个节点开始执行</td> 
   <td><code>org.activiti...ActivitiActivityEvent</code></td> 
  </tr> 
  <tr> 
   <td>ACTIVITY_COMPLETED</td> 
   <td>一个节点成功结束</td> 
   <td><code>org.activiti...ActivitiActivityEvent</code></td> 
  </tr> 
  <tr> 
   <td>ACTIVITY_SIGNALED</td> 
   <td>一个节点收到了一个信号</td> 
   <td><code>org.activiti...ActivitiSignalEvent</code></td> 
  </tr> 
  <tr> 
   <td>ACTIVITY_MESSAGE_RECEIVED</td> 
   <td>一个节点收到了一个消息。在节点收到消息之前触发。收到后，会触发<code>ACTIVITY_SIGNAL</code>或<code>ACTIVITY_STARTED</code>，这会根据节点的类型（边界事件，事件子流程开始事件）</td> 
   <td><code>org.activiti...ActivitiMessageEvent</code></td> 
  </tr> 
  <tr> 
   <td>ACTIVITY_ERROR_RECEIVED</td> 
   <td>一个节点收到了一个错误事件。在节点实际处理错误之前触发。 事件的<code>activityId</code>对应着处理错误的节点。 这个事件后续会是<code>ACTIVITY_SIGNALLED</code>或<code>ACTIVITY_COMPLETE</code>， 如果错误发送成功的话。</td> 
   <td><code>org.activiti...ActivitiErrorEvent</code></td> 
  </tr> 
  <tr> 
   <td>UNCAUGHT_BPMN_ERROR</td> 
   <td>抛出了未捕获的BPMN错误。流程没有提供针对这个错误的处理器。 事件的<code>activityId</code>为空。</td> 
   <td><code>org.activiti...ActivitiErrorEvent</code></td> 
  </tr> 
  <tr> 
   <td>ACTIVITY_COMPENSATE</td> 
   <td>一个节点将要被补偿。事件包含了将要执行补偿的节点id。</td> 
   <td><code>org.activiti...ActivitiActivityEvent</code></td> 
  </tr> 
  <tr> 
   <td>VARIABLE_CREATED</td> 
   <td>创建了一个变量。事件包含变量名，变量值和对应的分支或任务（如果存在）。</td> 
   <td><code>org.activiti...ActivitiVariableEvent</code></td> 
  </tr> 
  <tr> 
   <td>VARIABLE_UPDATED</td> 
   <td>更新了一个变量。事件包含变量名，变量值和对应的分支或任务（如果存在）。</td> 
   <td><code>org.activiti...ActivitiVariableEvent</code></td> 
  </tr> 
  <tr> 
   <td>VARIABLE_DELETED</td> 
   <td>删除了一个变量。事件包含变量名，变量值和对应的分支或任务（如果存在）。</td> 
   <td><code>org.activiti...ActivitiVariableEvent</code></td> 
  </tr> 
  <tr> 
   <td>TASK_ASSIGNED</td> 
   <td>任务被分配给了一个人员。事件包含任务。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>TASK_CREATED</td> 
   <td>创建了新任务。它位于<code>ENTITY_CREATE</code>事件之后。当任务是由流程创建时， 这个事件会在TaskListener执行之前被执行。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>TASK_COMPLETED</td> 
   <td>任务被完成了。它会在<code>ENTITY_DELETE</code>事件之前触发。当任务是流程一部分时，事件会在流程继续运行之前， 后续事件将是<code>ACTIVITY_COMPLETE</code>，对应着完成任务的节点。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>TASK_TIMEOUT</td> 
   <td>任务已超时，在<code>TIMER_FIRED</code>事件之后，会触发用户任务的超时事件， 当这个任务分配了一个定时器的时候。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>PROCESS_COMPLETED</td> 
   <td>流程已结束。在最后一个节点的<code>ACTIVITY_COMPLETED</code>事件之后触发。 当流程到达的状态，没有任何后续连线时， 流程就会结束。</td> 
   <td><code>org.activiti...ActivitiEntityEvent</code></td> 
  </tr> 
  <tr> 
   <td>PROCESS_CANCELLED</td> 
   <td>进程已被取消。在从运行时删除流程实例之前调度。流程实例被API调用取消<code>RuntimeService.deleteProcessInstance</code></td> 
   <td><code>org.activiti…ActivitiCancelledEvent</code></td> 
  </tr> 
  <tr> 
   <td>MEMBERSHIP_CREATED</td> 
   <td>用户被添加到一个组里。事件包含了用户和组的id。</td> 
   <td><code>org.activiti...ActivitiMembershipEvent</code></td> 
  </tr> 
  <tr> 
   <td>MEMBERSHIP_DELETED</td> 
   <td>用户被从一个组中删除。事件包含了用户和组的id。</td> 
   <td><code>org.activiti...ActivitiMembershipEvent</code></td> 
  </tr> 
  <tr> 
   <td>MEMBERSHIPS_DELETED</td> 
   <td>所有成员被从一个组中删除。在成员删除之前触发这个事件，所以他们都是可以访问的。 因为性能方面的考虑，不会为每个成员触发单独的<code>MEMBERSHIP_DELETED</code>事件。</td> 
   <td><code>org.activiti...ActivitiMembershipEvent</code></td> 
  </tr> 
 </tbody> 
</table>

引擎内部所有`ENTITY_*`事件都是与实体相关的。下面的列表展示了实体事件与实体的对应关系：

*  **`ENTITY_CREATED, ENTITY_INITIALIZED, ENTITY_DELETED`**:
    
     *  Attachment, Comment, Deployment, Execution, Group, IdentityLink, Job, Model, ProcessDefinition, ProcessInstance, Task, User.
     *  附件，注释，部署，执行，组，IdentityLink，作业，模型，ProcessDefinition，ProcessInstance，任务，用户。
 *  **`ENTITY_UPDATED`**:
    
     *  Attachment, Deployment, Execution, Group, IdentityLink, Job, Model, ProcessDefinition, ProcessInstance, Task, User.
     *  附件，部署，执行，组，IdentityLink，作业，模型，ProcessDefinition，ProcessInstance，任务，用户。
 *  **`ENTITY_SUSPENDED, ENTITY_ACTIVATED`**:
    
     *  ProcessDefinition, ProcessInstance/Execution, Task.
     *  ProcessDefinition，ProcessInstance /执行，任务。

### 7. 附加信息 ###

只有同一个流程引擎中的事件会发送给对应的监听器。因此，如果您有不同的引擎（在同一个数据库上运行），则仅将源于监听器注册的引擎中的事件调度到该监听器。在另一个引擎中发生的事件不会分派给侦听器，无论它们是否在同一JVM中运行。

某些事件类型（与实体相关）公开了目标实体。根据类型或事件，这些实体无法再进行更新（例如，删除实体时）。如果可能，请使用`EngineServices`事件暴露的方式以安全的方式与引擎进行交互。即使这样，您仍需谨慎对待已调度事件中涉及的实体的更新/操作。

没有对应历史的实体事件，因为它们都有运行阶段的对应实体。

--------------------

**分享** **Activiti工作流高级视频教程** `全套视频`  
关注公众号【**Java大厂面试官**】,回复 ：**工作流**  
即可免费下载  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FidTkzNTAwOTA2Ng_size_16_color_FFFFFF_t_70]

QQ群【**837324215**】  
关注我的公众号【**Java大厂面试官**】，回复：**架构**、**资源**等关键词（更多关键词，关注后注意提示信息）获取更多免费资料。

公众号也会持续输出高质量文章，和大家共同进步。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FidTkzNTAwOTA2Ng_size_16_color_FFFFFF_t_70_pic_center][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FidTkzNTAwOTA2Ng_size_16_color_FFFFFF_t_70]: /images/20221119/1a8043693baa43f19dc7f9b421565c27.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FidTkzNTAwOTA2Ng_size_16_color_FFFFFF_t_70_pic_center]: /images/20221119/502c97af4085447d8d9c47f3553a1cfc.png