执行监听器与任务监听器的基本使用

本文介绍执行监听器与任务监听器的基本原理和使用方法。当流程途径连线或者节点的时候，会触发对应的事件类型。执行监听器与任务监听器在生产中经常会用在几个方面：

• 动态分配节点处理人。通过前一个节点设置的变量，在运行到下一个节点时设置对应的处理人；
• 当流程运行到某个节点时，发送邮件或短信给待办用户；
• 统计流程处理时长，是否超时等；
• 业务层面数据处理。

任务监听器顾名思义是监听任务的。任务监听器的生命周期如下图所示，会经历assignment、create、complete、delete。当流程引擎触发这四种事件类型时，对应的任务监听器会捕获其事件类型，再按照监听器的处理逻辑进行处理。

 

 

 

执行监听器则监听流程的所有节点和连线。主要有start、end、take事件。其中节点有start、end两种事件，而连线则有take事件。下图是执行监听器的生命周期：

 

 

 

接下来通过代码去演示监听器效果。 首先我们创建一个执行监听器的类：

package listener;

import org.activiti.engine.delegate.DelegateExecution;
import org.activiti.engine.delegate.ExecutionListener;

public class MyExecutionListener implements ExecutionListener {

public void notify(DelegateExecution execution) throws Exception {
System.out.println("============executionListener start============");
String eventName = execution.getEventName();
String currentActivitiId = execution.getCurrentActivityId();
System.out.println("事件名称:" + eventName);
System.out.println("ActivitiId:" + currentActivitiId);
System.out.println("============executionListener end============");
}
}

 

自定义执行监听器需要实现ExecutionListener接口，并且实现notify方法。这里我们打印对应的事件和活动节点id

接下来创建一个自定任务监听器：

package listener;

import org.activiti.engine.delegate.DelegateTask;
import org.activiti.engine.delegate.TaskListener;

public class MyTaskListener implements TaskListener{

public void notify(DelegateTask delegateTask) {
System.out.println("============TaskListener start============");
String taskDefinitionKey = delegateTask.getTaskDefinitionKey();
String eventName = delegateTask.getEventName();
System.out.println("事件名称:" + eventName);
System.out.println("taskDefinitionKey:" + taskDefinitionKey);
System.out.println("============TaskListener end============");
}
}

 

自定义任务监听器需要实现TaskListener接口，并且实现notify方法。这里我们打印对应的事件和任务节点键值（即bpmn图里userTask的id）。

之后新建一个bpmn图：

<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:activiti="http://activiti.org/bpmn" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:omgdc="http://www.omg.org/spec/DD/20100524/DC" xmlns:omgdi="http://www.omg.org/spec/DD/20100524/DI" typeLanguage="http://www.w3.org/2001/XMLSchema" expressionLanguage="http://www.w3.org/1999/XPath" targetNamespace="http://www.activiti.org/test">
<process id="listenerBpmProcess" name="My process" isExecutable="true">
<startEvent id="startevent1" name="Start"></startEvent>
<userTask id="usertask1" name="myTask1" activiti:assignee="张三">
<extensionElements>
<activiti:executionListener event="start" class="listener.MyExecutionListener"></activiti:executionListener>
<activiti:executionListener event="end" class="listener.MyExecutionListener"></activiti:executionListener>
<activiti:taskListener event="all" class="listener.MyTaskListener"></activiti:taskListener>
</extensionElements>
</userTask>
<endEvent id="endevent1" name="End"></endEvent>
<sequenceFlow id="flow1" sourceRef="startevent1" targetRef="usertask1"></sequenceFlow>
<sequenceFlow id="flow2" sourceRef="usertask1" targetRef="endevent1"></sequenceFlow>
</process>
<bpmndi:BPMNDiagram id="BPMNDiagram_listenerBpmProcess">
<bpmndi:BPMNPlane bpmnElement="listenerBpmProcess" id="BPMNPlane_listenerBpmProcess">
<bpmndi:BPMNShape bpmnElement="startevent1" id="BPMNShape_startevent1">
<omgdc:Bounds height="41.0" width="35.0" x="505.0" y="40.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="usertask1" id="BPMNShape_usertask1">
<omgdc:Bounds height="55.0" width="105.0" x="470.0" y="150.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="endevent1" id="BPMNShape_endevent1">
<omgdc:Bounds height="35.0" width="35.0" x="505.0" y="240.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNEdge bpmnElement="flow1" id="BPMNEdge_flow1">
<omgdi:waypoint x="522.0" y="81.0"></omgdi:waypoint>
<omgdi:waypoint x="522.0" y="150.0"></omgdi:waypoint>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="flow2" id="BPMNEdge_flow2">
<omgdi:waypoint x="522.0" y="205.0"></omgdi:waypoint>
<omgdi:waypoint x="522.0" y="240.0"></omgdi:waypoint>
</bpmndi:BPMNEdge>
</bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
</definitions>

 

这里我们给userTask1添加了执行监听器和任务监听器。部署bpmn图后，我们观察流程运转时监听器的触发时机和作用，启动流程：

public void startProcessById() {
RuntimeService runtimeService = pe.getRuntimeService();
ProcessInstance pi = runtimeService.startProcessInstanceById("listenerBpmProcess:1:4");
}

 

流程启动后，从开始节点运转到userTask1节点，观察控制台输出：

============executionListener start============
事件名称:start
ActivitiId:usertask1
============executionListener end============
============TaskListener start============
事件名称:assignment
taskDefinitionKey:usertask1
============TaskListener end============
============TaskListener start============
事件名称:create
taskDefinitionKey:usertask1
============TaskListener end============

可以看到流程走到userTask1节点时，首先触发start事件，调用我们自定义的执行监听器，随后触发assignment和create事件，执行自定义任务监听器的内容。注意这里是先触发assignment进行人员分配，再触发create事件，与一般的认知有些差异。

接下来通过taskService的complete方法完成userTask1节点上流程的提交，观察控制台输出：

 

============TaskListener start============
事件名称:complete
taskDefinitionKey:usertask1
============TaskListener end============
============TaskListener start============
事件名称:delete
taskDefinitionKey:usertask1
============TaskListener end============
============executionListener start============
事件名称:end
ActivitiId:usertask1
============executionListener end============

可以看到userTask1节点提交的时候，首先触发complete事件再触发delete事件，最后触发end事件。

以上就是执行监听器与任务监听器的基本使用方式。实际工程中，由于流程节点十分多，并且流程和业务常常需要进行微调，通常是不会在bpmn图上逐个节点添加监听器的，往往是在解析bpmn对象期间利用对象解析器动态添加监听器。这里涉及的原理比较复杂，留到后面的文章再讨论。

到本文为止，讲的都是activiti的入门用法，可以顺利跑通一个流程，还能在流程运行的途中进行一些监听和操作。activiti的入门概念不少，但使用并不复杂。

 原文链接：https://blog.csdn.net/sadoshi/article/details/104698749/