jBPM 定时器(Timer)实现了以下功能:
- timer 定义在 transition 元素中,当流程处于 state、task、sub-process 类型活动的等待状态时,会开始计算 timer 的时间,当时间耗尽时,就会触发转移。
- timer 也可以定义在用户代码活动中,负责事件监听的 on 元素支持 timeout 事件。当事件监听器 on 在监听 timeout 事件时,timer 元素必须是 on 元素的第一个子元素。当流程的执行(Execution)进入这个等待活动时,就会激活定时器。如果此活动的持续等待时间超过定时器指定的时间时(超时),就会触发事件;如果流程的执行在定时器指定的时间之内离开此活动,那么就会取消这个定时器。
timer 元素的属性:
属性 | 类型 | 默认值 | 是否必需 | 描述 |
---|---|---|---|---|
duedate | 持续时间表达式 | 无 | 必需 | 指定多长时间以后触发事件。如:15 分钟、2 天等 |
repeat | 持续时间表达式 | 无 | 可选 | 第一个触发事件后,每隔多长时间再触发事件,这是一个持续的过程。 |
1 持续时间表达式
持续时间表达式语法如下:
quantity [business]{
second | seconds | minute | minutes | hour | hours | day | days | week | weeks | month | months | year | years
}
关键字 | 是否可选 | 说明 |
---|---|---|
quantity | 否 | 正整数,描述时间的值。 |
business | 是 | 如果存在,则表示按照工作日历来计算时间;如果没有,则按照正常的公历来计算时间。工作日历会按照预先配置的规则,计算时会去除节假日与休息的时间,只考虑工作时间。 |
配好以上关键字之后,加上需要的时间单位即可。
2 工作日历
系统默认的工作日历配置文件是 jbpm.businesscalendar.cfg.xml,它存在 jbpm4.jar 的根目录下,内容为:
<?xml version="1.0" encoding="UTF-8"?>
<jbpm-configuration>
<process-engine-context>
<business-calendar>
<monday hours="9:00-12:00 and 12:30-17:00"/>
<tuesday hours="9:00-12:00 and 12:30-17:00"/>
<wednesday hours="9:00-12:00 and 12:30-17:00"/>
<thursday hours="9:00-12:00 and 12:30-17:00"/>
<friday hours="9:00-12:00 and 12:30-17:00"/>
<holiday period="01/07/2008 - 31/08/2008"/>
</business-calendar>
</process-engine-context>
</jbpm-configuration>
上面配置的工作时间为:周一到周五 9:00-12:00 与 12:30-17:00。01/07/2008 - 31/08/2008 为节假日时间。
工作日历的默认实现类是 BusinessCalendarImpl。
也可以通过实现 org.jbpm.pvm.internal.cal.BusinessCalendar 类来自定义的工作日历,需要实现以下两个方法:
方法 | 说明 |
---|---|
Date add(Date date, String duration) | 计算从一个时间点,经过 duration 后,到达的时间点。 |
Date subtract(Date date, String duration) | 计算从一个时间点,减去 duration 后,到达的时间点。这个方法不支持 business 模式。 |
字符串 duration 通过 new Duration(duration)
来构造出 Duration 对象,它就是持续时间表达式的对象。
在 jbpm.cfg.xml 中配置自定义的工作日历:
<process-engine-context>
<object class="xxx.xxx.CustomBusinessCalendar"/>
</process-engine-context>
3 定时转移
流程定义:
jPDL:
<?xml version="1.0" encoding="UTF-8"?>
<process name="TimerTransition" xmlns="http://jbpm.org/4.4/jpdl">
<start name="start1" g="124,206,48,48">
<transition to="处理(业务员)"/>
</start>
<state name="处理(业务员)" g="222,203,111,52">
<transition name="超时" to="处理(业务经理)" g="-34,-4">
<timer duedate="15 minutes"/>
</transition>
<transition name="继续" to="回复" g="-2,-22"/>
</state>
<state name="处理(业务经理)" g="214,305,124,52"/>
<state name="回复" g="422,205,92,52"/>
</process>
这里假设如果业务员在 15 分钟之内没有进行处理,那么将会发生超时转移,流程将流向 【处理(业务经理)】的活动节点。
单元测试:
//发起流程实例
Execution processInstance = executionService.startProcessInstanceByKey("TimerTransition");
//在 job 中会生成一条【定时器】信息
Job job = managementService.createJobQuery().timers().processInstanceId(processInstance
.getId()).uniqueResult();
//触发定时器(模拟)
managementService.executeJob(job.getId());
//断言流程进入【处理(业务经理)】活动
processInstance = executionService.findExecutionById(processInstance.getId());
assertEquals("处理(业务经理)", ((ExecutionImpl) processInstance).getActivityName());
4 定时事件
jPDL:
<?xml version="1.0" encoding="UTF-8"?>
<process name="TimerEvent" xmlns="http://jbpm.org/4.4/jpdl">
<start name="start1" g="138,204,48,48">
<transition to="等待"/>
</start>
<state name="等待" g="228,200,92,52">
<on event="timeout">
<timer duedate="15 minutes"/>
<event-listener class="net.deniro.jbpm.OvertimeEvent"/>
</on>
<transition to="下一步操作"/>
</state>
<state name="下一步操作" g="366,202,92,52"/>
</process>
timer 元素是 timeout 事件的必需元素,这里表示如果在【等待】活动上停留了 15 分钟,那么就会触发 timeout 事件。
自定义 timeout 事件:
public class OvertimeEvent implements EventListener {
@Override
public void notify(EventListenerExecution execution) throws Exception {
//设置流程变量,来表示触发了该事件
execution.setVariable("OvertimeEvent",Boolean.TRUE);
}
}
单元测试:
//发起流程实例
Execution processInstance = executionService.startProcessInstanceByKey("TimerEvent");
//在 job 中会生成一条【定时器】信息
Job job = managementService.createJobQuery().timers().processInstanceId(processInstance
.getId()).uniqueResult();
//触发定时器(模拟)
managementService.executeJob(job.getId());
//断言流程进入【等待】活动(因为我们在事件监听器中并没有发出执行信号)
processInstance = executionService.findExecutionById(processInstance.getId());
Set<String> expectedActivityNames = new HashSet<>();
expectedActivityNames.add("等待");
assertEquals(expectedActivityNames, processInstance.findActiveActivityNames());
//断言事件被触发
assertEquals(Boolean.TRUE, executionService.getVariable(processInstance.getId(), "OvertimeEvent"));
assertEquals("等待", ((ExecutionImpl) processInstance).getActivityName());
如果【等待】活动在 15 分钟之内被完成,那么就会取消自定义的 timeout 事件,相关的 Job 记录也会被删除。
5 工作日历上的定时转移
这个定时转移与我们第 3 节所说的定时转移类似,只不过在配置持续时间表达式时,加入了 business
关键字:
<process name="TimerTransition" xmlns="http://jbpm.org/4.4/jpdl">
...
<state name="处理(业务员)" g="222,203,111,52">
<transition name="超时" to="处理(业务经理)" g="-34,-4">
<timer duedate="15 business hours"/>
</transition>
...
</state>
...
</process>
这里表示如果当前活动停留了超过 15 个 “工作” 小时,那么就会发生超时转移。工作日历中可以配置每天的工作时间段。
6 定时重复
利用 timer 的 repeat 属性,可以不断地触发事件。
<process name="TimerRepeatEvent" xmlns="http://jbpm.org/4.4/jpdl">
...
<state name="等待" g="228,200,92,52">
<on event="timeout">
<timer duedate="15 minutes" repeat="15 seconds"/>
<event-listener class="net.deniro.jbpm.OvertimeEvent"/>
</on>
<transition to="下一步操作"/>
</state>
...
</process>
这里的定义表示:事件被触发后,每隔 15 s,会重复触发事件,直到发生转移。
网友评论