activiti流程事件总结

红太狼 2023-07-11 05:37 11阅读 0赞

**边界事件和中间事件区别：边界事件与关联的节点有关，比如在一个节点上设置了一个定时边界事件，过了这个事件，该节点如果还没有审批，可选择取消活动即不需要审批流转到下一节点。中间事件是在一个节点后定义了一个事件，比如在一个节点后定义了一个中间定义事件，在节点审批完后，超过了定时时间会流转到下一节点。总结，边界事件是针对节点的，中间事件是针对流程的。**

## 1.消息事件 ##

消息事件会引用一个命名的消息。每个消息都有名称和内容。和信号不同， 消息事件总会直接发送个一个接受者。  
如果消息应该触发启动一个新流程实例， 在下面的RuntimeService的两个方法中选择一个执行：

//根据消息名称发起流程
    ProcessInstance startProcessInstanceByMessage(String messageName);
    //传入消息名称和流程变量发起流程
    ProcessInstance startProcessInstanceByMessage(String messageName, Map<String, Object> processVariables);
    //传入消息名称,流程变量和业务key发起流程
    ProcessInstance startProcessInstanceByMessage(String messageName, String businessKey, Map<String, Object> processVariables);

这些方法允许启动对应的消息流程实例。  
如果消息需要被运行中的流程实例处理，首先要根据消息找到对应的流程实例然后触发这个等待中的流程。 RuntimeService提供了如下方法可以基于消息事件的订阅来触发流程继续执行：

//根据消息名称和流程执行ID触发消息
    void messageEventReceived(String messageName, String executionId);
    void messageEventReceived(String messageName, String executionId, HashMap<String, Object> processVariables);

## \#查询消息事件的订阅 ##

Activiti支持消息开始事件和中间消息事件。  
消息开始事件的情况，消息事件订阅分配给一个特定的 processdefinition。这个消息订阅可以使用ProcessDefinitionQuery查询到：

ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery().
    messageEventSubscription("newCallCenterBooking").singleResult();

• 因为同时只能有一个流程定义关联到消息的订阅点，查询总是返回0或一个结果。 如果流程定义更新了， 那么只有最新版本的流程定义会订阅到消息事件上。  
• 中间捕获消息事件的情况，消息事件订阅会分配给特定的执行。 这个消息事件订阅可以使用ExecutionQuery查询到：

Execution execution = runtimeService.createExecutionQuery()
        .messageEventSubscriptionName("paymentReceived")
        .variableValueEquals("orderId", message.getOrderId()) .singleResult();

• 这个查询可以调用对应的查询，通常是流程相关的信息 （这里，最多只能有一个流程实例对应着orderId）。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70]  
消息定义是针对流程的，这里定义的消息，节点上就可以选择消息了。如图,此流程在提交申请后，流程在中间消息这里等待，直到收到了消息后会继续流转。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 1]

## 2.信号事件 ##

信号事件会引用一个已命名的信号。信号全局范围的事件（广播语义）。 会发送给所有激活的处理器。  
触发信号事件，既可以通过bpmn节点由流程实例触发一个信号，也可以通过API触发。 下面的org.activiti.engine.RuntimeService中的方法 可以用来手工触发一个信号。

RuntimeService.signalEventReceived(String signalName);
    RuntimeService.signalEventReceived(String signalName, String executionId);

signalEventReceived(String signalName);和 signalEventReceived(String signalName, String executionId);之间的区别是 第一个方法会把信号发送给全局所有订阅的处理器（广播语义）， 第二个方法只把信息发送给指定流程实例。  
捕获信号事件，信号事件可以被中间捕获信号事件或边界信息事件捕获。

查询信号事件的订阅，可以查询所有订阅了特定信号事件的执行：

List<Execution> executions = runtimeService.createExecutionQuery()
        .signalEventSubscriptionName("alert").list();

我们可以使用signalEventReceived(String signalName, String executionId)方法 吧信号发送给这些执行。

信号事件范围。默认，信号会在流程引擎范围内进行广播。就是说， 你可以在一个流程实例中抛出一个信号事件，其他不同流程定义的流程实例 都可以监听到这个事件。有时只希望在同一个流程实例中响应这个信号事件，可以使用信号事件定义的scope 属性 ，设置为流程实例。

定义信号时可以选择事件范围，是**全局或者流程实例**级别。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 2]  
**流程实例**的信号，必须在流程内抛出信号即定义中间信号抛出事件。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 3]

如图，在主管审批后会抛出一个信号，捕获信号获取后就会继续执行。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 4]

## activiti源码分析 ##

for (SignalEventSubscriptionEntity signalEventSubscriptionEntity : signalEvents) { 
          // We only throw the event to globally scoped signals.
          // Process instance scoped signals must be thrown within the process itself
          //这里只实现了全局信号的抛出，流程实例级别的需要流程自己抛出
          if (signalEventSubscriptionEntity.isGlobalScoped()) { 
            
            if (executionId == null && Activiti5Util.isActiviti5ProcessDefinitionId(commandContext, signalEventSubscriptionEntity.getProcessDefinitionId())) { 
              Activiti5CompatibilityHandler activiti5CompatibilityHandler = Activiti5Util.getActiviti5CompatibilityHandler(); 
              activiti5CompatibilityHandler.signalEventReceived(signalEventSubscriptionEntity, payload, async);
              
            } else { 
              Context.getProcessEngineConfiguration().getEventDispatcher().dispatchEvent(
                  ActivitiEventBuilder.createSignalEvent(ActivitiEventType.ACTIVITY_SIGNALED, signalEventSubscriptionEntity.getActivityId(), eventName, 
                      payload, signalEventSubscriptionEntity.getExecutionId(), signalEventSubscriptionEntity.getProcessInstanceId(), 
                      signalEventSubscriptionEntity.getProcessDefinitionId()));
              
              eventSubscriptionEntityManager.eventReceived(signalEventSubscriptionEntity, payload, async);
            }
          }
        }

流程实例级别的信号实现主要

> org.activiti.engine.impl.bpmn.helper.SignalThrowingEventListener\#onEvent

public void onEvent(ActivitiEvent event) { 
        if (isValidEvent(event)) { 
    
          if (event.getProcessInstanceId() == null && processInstanceScope) { 
            throw new ActivitiIllegalArgumentException("Cannot throw process-instance scoped signal, since the dispatched event is not part of an ongoing process instance");
          }
    
          CommandContext commandContext = Context.getCommandContext();
          EventSubscriptionEntityManager eventSubscriptionEntityManager = commandContext.getEventSubscriptionEntityManager();
          List<SignalEventSubscriptionEntity> subscriptionEntities = null;
          if (processInstanceScope) { 
            subscriptionEntities = eventSubscriptionEntityManager.findSignalEventSubscriptionsByProcessInstanceAndEventName(event.getProcessInstanceId(), signalName);
          } else { 
            String tenantId = null;
            if (event.getProcessDefinitionId() != null) { 
              ProcessDefinition processDefinition = commandContext.getProcessEngineConfiguration().getDeploymentManager().findDeployedProcessDefinitionById(event.getProcessDefinitionId());
              tenantId = processDefinition.getTenantId();
            }
            subscriptionEntities = eventSubscriptionEntityManager.findSignalEventSubscriptionsByEventName(signalName, tenantId);
          }
    
          for (SignalEventSubscriptionEntity signalEventSubscriptionEntity : subscriptionEntities) { 
            eventSubscriptionEntityManager.eventReceived(signalEventSubscriptionEntity, null, false);
          }
        }
      }

感兴趣的可以看一下

## 3.事件网关 ##

事件网关允许根据事件判断流向。网关的每个外出顺序流都要连接到一个中间捕获事件。 当流程到达一个基于事件网关，网关会进入等待状态：会暂停执行。 与此同时，会为每个外出顺序流创建相对的事件订阅。  
注意基于事件网关的外出顺序流和普通顺序流不同。这些顺序流不会真的"执行"。 相反，它们让流程引擎去决定执行到基于事件网关的流程需要订阅哪些事件。 要考虑以下条件：  
• 基于事件网关必须有两条或以上外出顺序流。  
• 基于事件网关后，只能使用intermediateCatchEvent类型。 （activiti不支持基于事件网关后连接ReceiveTask。）  
• 连接到基于事件网关的intermediateCatchEvent只能有一条进入顺序流。

如图，此事件网关有两条出口，一条出口订阅了一个中间定时捕获事件，一条订阅了一个中间消息捕获事件。当超过设置的定时时间没有收到消息流程就会结束。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 5]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200303233105817.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200303232854677.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200303232807969.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200303233244455.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200303232731673.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200303233155996.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NzU4MDc0,size_16,color_FFFFFF,t_70