本文节选自《疯狂工作流讲义(第2版)》
京东购买地址:https://item.jd.com/12246565.html
疯狂Activiti电子书:https://my.oschina.net/JavaLaw/blog/1570397
工作流Activiti教学视频:https://my.oschina.net/JavaLaw/blog/1577577
任务监听器
Activiti提供了任务监听器,允许在任务执行的过程执行特定的Java程序或者表达式,目前任务监听器只能使用在User Task中,为BPMN2.0元素extensionElements加入activiti:taskListener元素来定义一个任务监听器。任务监听器并不属于BPMN规范的内容,属于Activiti对BPMN规范扩展的部分。Activiti对BPMN规范的扩展,XML约束可以在activiti-5.10\docs\xsd\activiti-bpmn-extensions-5.10.xsd文件中找到。
使用class指定监听器
在使用activiti:taskListener元素配置一个监听器时,可以使用class属性指定监听器的Java类,使用这种方式指定的监听器,Java类必须实现org.activiti.engine.delegate.TaskListener接口的notify方法,代码清单12-47为使用class指定监听器的User Task。
代码清单12-47:codes\12\12.6\task-listener\resource\bpmn\ClassTaskListener.bpmn
<userTask id="usertask1" name="User Task"> <extensionElements> <activiti:taskListener event="create" class="org.crazyit.activiti.PropertyConfigListener" /> </extensionElements> </userTask>
代码清单12-47中的粗体字代码,指定了监听器类为PropertyConfigListener,并且该监听器会在User Task创建的时候执行,此处所说的User Task创建后执行,是指User Task的数据写入数据库,并且将相应的属性都设置完成后,监听器才会执行。代码清单12-48为PropertyConfigListener类的实现。
代码清单12-48:
codes\12\12.6\task-listener\src\org\crazyit\activiti\PropertyConfigListener.java
public class PropertyConfigListener implements TaskListener { public void notify(DelegateTask delegateTask) { System.out.println("执行任务监听器"); } }
PropertyConfigListener类实现TaskListener,需要实现notify方法,该方法中可以获取DelegateTask实例,DelegateTask是一个接口,可以通过该对象可以直接操作当前的User Task。以下为运行代码:
// 创建流程引擎 ProcessEngine engine = ProcessEngines.getDefaultProcessEngine(); // 得到流程存储服务组件 RepositoryService repositoryService = engine.getRepositoryService(); // 得到运行时服务组件 RuntimeService runtimeService = engine.getRuntimeService(); // 部署流程文件 repositoryService.createDeployment() .addClasspathResource("bpmn/ClassTaskListener.bpmn").deploy(); // 启动流程 ProcessInstance pi = runtimeService.startProcessInstanceByKey("process1");
运行以上代码后,会自动执行任务监听器,输出结果如下:
执行任务监听器
使用expression指定监听器
除了可以使用class属性指定监听器外,还可以使用expression属性指定监听器。在12.4.3章节中,可以使用JUEL表达式为Service Task指定执行的JavaBean以及方法,同样地,任务监听器可以使用同样的方式,配置相应的表达式来指定监听器的JavaBean以及执行方法,这个JavaBean需要为流程变量(如果整合了Spring的话,也可以是Spring容器中的bean),因此还需要实现序列化接口。代码清单12-49为一个User Task的配置。
代码清单12-49:codes\12\12.6\task-listener\resource\bpmn\ExpressionTaskListener.bpmn
<process id="process1" name="process1"> <startEvent id="startevent1" name="Start"></startEvent> <userTask id="usertask1" name="User Task"> <extensionElements> <activiti:taskListener event="create" expression="${myBean.testBean(task)}"/> </extensionElements> </userTask> <endEvent id="endevent1" name="End"></endEvent> <sequenceFlow id="flow1" name="" sourceRef="startevent1" targetRef="usertask1"></sequenceFlow> <sequenceFlow id="flow2" name="" sourceRef="usertask1" targetRef="endevent1"></sequenceFlow> </process>
以上代码中使用了expression属性,指定了监听方法为myBean的testBean,并且将任务对象传入,task为此处内置的JUEL变量,类型为DelegateTask。本例中myBean是一个普通的JavaBean,如代码清单12-50。
代码清单12-50:codes\12\12.6\task-listener\src\org\crazyit\activiti\ExpressionBean.java
public class ExpressionBean implements Serializable { public void testBean(DelegateTask task) { System.out.println("执行ExpressionBean的 testBean方法: " + task.getId()); } }
ExpressionBean中只提供了一个testBean(DelegateTask task)的方法,方法实现为在控制台输出任务ID,代码清单12-51为运行代码。
代码清单12-51:
codes\12\12.6\task-listener\src\org\crazyit\activiti\ExpressionTaskListener.java
// 创建流程引擎 ProcessEngine engine = ProcessEngines.getDefaultProcessEngine(); // 得到流程存储服务组件 RepositoryService repositoryService = engine.getRepositoryService(); // 得到运行时服务组件 RuntimeService runtimeService = engine.getRuntimeService(); // 部署流程文件 repositoryService.createDeployment() .addClasspathResource("bpmn/ExpressionTaskListener.bpmn").deploy(); // 初始化参数 Map<String, Object> vars = new HashMap<String, Object>(); vars.put("myBean", new ExpressionBean()); // 启动流程 ProcessInstance pi = runtimeService.startProcessInstanceByKey("process1", vars);
代码清单的粗体部分,在流程启动类中,为流程设置名称为“myBean”、类型为ExpressionBean的流程变量,运行代码清单12-51可以看到ExpressionBean的输出。
使用delegateExpression指定监听器
与Service Task类似,同样可以使用delegateExpression配合JUEL指定任务监听器。使用delegateExpression配合JUEL指定的监听器,必须要实现TaskListener和Serializable接口(序列化接口),如${myTaskListener},Activiti会从流程中查找名称为“myTaskListener”的流程变量,并直接执行notify方法。代码清单12-52为User Task配置,代码清单12-53为相应的TaskLinstener和运行类。
代码清单12-52:
codes\12\12.6\task-listener\resource\bpmn\DelegateExpressionTaskListener.bpmn
<process id="process1" name="process1" isExecutable="true"> <startEvent id="startevent1" name="Start"></startEvent> <userTask id="usertask1" name="User Task"> <extensionElements> <activiti:taskListener event="create" delegateExpression="${myDelegate}"></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>
代码清单12-53:
codes\12\12.6\task-listener\src\org\crazyit\activiti\DelegateBean.java
codes\12\12.6\task-listener\src\org\crazyit\activiti\DelegateExpressionTaskListener.java
public class DelegateBean implements TaskListener, Serializable { public void notify(DelegateTask delegateTask) { System.out.println("使用DelegateBean"); } } public class DelegateExpressionTaskListener { public static void main(String[] args) { // 创建流程引擎 ProcessEngine engine = ProcessEngines.getDefaultProcessEngine(); // 得到流程存储服务组件 RepositoryService repositoryService = engine.getRepositoryService(); // 得到运行时服务组件 RuntimeService runtimeService = engine.getRuntimeService(); // 部署流程文件 repositoryService .createDeployment() .addClasspathResource( "bpmn/DelegateExpressionTaskListener.bpmn") .deploy(); // 初始化参数 Map<String, Object> vars = new HashMap<String, Object>(); vars.put("myDelegate", new DelegateBean()); // 启动流程 ProcessInstance pi = runtimeService.startProcessInstanceByKey( "process1", vars); } }
代码清单12-52中的User Task,使用了delegateExpression属性,指定对应的TaskLinstener为myDelegate,即使用流程变量中名称为“myDelegate”的对象作为任务监听器,在代码清单12-53中,启动流程时初始化一个DelegateBean设置到流程中,当流程到达User Task时,将会触发任务监听器(配置的event为create)。
监听器的触发
任务监听器会在任务的不同事件中触发,任务监听器会在以下事件中被触发:任务创建事件(create)、指定任务代理人事件(assignment)和任务完成事件(complete)。如果既提供了create事件的监听器,也提供了assignment事件的监听器时,会先执行后者,任务创建事件(create)的监听器,会在任务完成创建的最后才执行,而指定任务代理人,也是属于任务创建的一部分。代码清单12-54定义了一个含有3个监听器的User Task。
代码清单12-54:codes\12\12.6\task-listener\src\org\crazyit\activiti\ListenerFire.java
<process id="process1" name="process1" isExecutable="true"> <startEvent id="startevent1" name="Start"></startEvent> <userTask id="usertask1" name="User Task" activiti:assignee="crazyit"> <extensionElements> <activiti:taskListener event="create" class="org.crazyit.activiti.TaskListenerA"></activiti:taskListener> <activiti:taskListener event="assignment" class="org.crazyit.activiti.TaskListenerB"></activiti:taskListener> <activiti:taskListener event="complete" class="org.crazyit.activiti.TaskListenerC"></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>
流程文件ListenerFire.bpmn中的User Task,使用了activiti:assignee属性指定了任务代理人,并且为其定义3个任务监听器(均使用class属性指定),这3个任务监听器会在不同的任务事件中触发(activiti:taskListener的event属性),每个监听器都仅仅是输出一句话,没有其他实现。TaskListenerA会在任务create后触发,TaskListenerB会在assignment时触发,TaskListenerC会在complete前触发。代码清单12-55为运行代码。
代码清单12-55:codes\12\12.6\task-listener\src\org\crazyit\activiti\ListenerFire.java
// 创建流程引擎 ProcessEngine engine = ProcessEngines.getDefaultProcessEngine(); // 得到流程存储服务组件 RepositoryService repositoryService = engine.getRepositoryService(); // 得到运行时服务组件 RuntimeService runtimeService = engine.getRuntimeService(); // 得到任务服务组件 TaskService taskService = engine.getTaskService(); // 部署流程文件 repositoryService.createDeployment() .addClasspathResource("bpmn/ListenerFire.bpmn").deploy(); // 启动流程 ProcessInstance pi = runtimeService .startProcessInstanceByKey("process1"); // 查询并完成任务 Task task = taskService.createTaskQuery().processInstanceId(pi.getId()) .singleResult(); taskService.complete(task.getId());
运行代码清单12-55,可以看到输出结果如下:
任务监听器B 任务监听器A 任务监听器C
根据以上结果可以看出,assignment事件的监听器,在触发时,会先于create事件的监听器,当完成任务后,才会触发complete事件的监听器。
属性注入
往任务监听器注入属性,实现方式与JavaDelegate的属性注入类似,使用activiti:field元素即可,同样支持两种注入方式:字符串注入和JUEL表达式注入。使用以下的代码片断为一个TaskListener进行字符串注入:
<activiti:taskListener event="create" class="org.crazyit.activiti.task.listener.task.PropertyInjection"> <activiti:field name="userName" stringValue="crazyit" /> </activiti:taskListener>
为activiti:field元素加入name属性,以上代码片断中的name为“userName”,因此在相应的TaskListener中,需要有setUserName(Expression e)方法,以下的代码片断为一个TaskListener进行表达式注入:
<activiti:taskListener event="create" class="org.crazyit.activiti.task.listener.task.PropertyInjection"> <activiti:field name="userName"> <activiti:expression>${userName}</activiti:expression> </activiti:field> </activiti:taskListener>
以上的表达式中,将会从流程变量中查找变量名称为“userName”的变量,注入到任务监听器,同样地,监听器中也需要有setUserName(Expression e)方法,任务监听器的属性注入与JavaDelegate的属性注入类似,在此不再赘述。
本文节选自《疯狂工作流讲义(第2版)》
京东购买地址:https://item.jd.com/12246565.html
疯狂Activiti电子书:https://my.oschina.net/JavaLaw/blog/1570397
工作流Activiti教学视频:https://my.oschina.net/JavaLaw/blog/1577577
本书代码目录:https://gitee.com/yangenxiong/CrazyActiviti

