Flowable中定时器的玩法详解

在Flowable中，定时器是一个非常有用的机制，通过它可以实现一些定时执行的任务，比如定时发送邮件、自动归档数据等等。本文将详细介绍Flowable中定时器的使用方法。

什么是定时器

定时器是在流程执行的某个节点上设置一个定时器，然后在设定的时间点上自动执行某些动作的机制。比如，我们可以设置一个定时器，在一个任务节点上，如果任务没有在设定的时间内被处理，那么就自动触发一些事情（比如将任务的状态改成“超时”）。

定时器的使用方法

在流程定义文件中，使用<timerEventDefinition>标签来定义一个定时器事件。下面是一个示例：

<userTask id="userTask1" name="Demo Task">
  <extensionElements>
    <activiti:taskListener event="create" class="com.example.MyTaskListener" />
  </extensionElements>
  <timerEventDefinition>
      <timeDuration>PT1M</timeDuration>
  </timerEventDefinition>
</userTask>

在上面的代码中，我们在“userTask1”任务节点上定义了一个定时器。该定时器使用元素来指定一个持续时间（PT1M），表示需要等待1分钟后才会触发定时器事件。

另外一个使用方式是使用<timeDate>元素来指定一个确切的日期和时间，如下示例：

<userTask id="userTask2" name="Demo Task">
  <extensionElements>
    <activiti:taskListener event="create" class="com.example.MyTaskListener" />
  </extensionElements>
  <timerEventDefinition>
      <timeDate>2022-01-01T00:00:00</timeDate>
  </timerEventDefinition>
</userTask>

在上面的代码中，我们在“userTask2”任务节点上定义了一个定时器。该定时器使用<timeDate>元素来指定一个确切的日期和时间，表示需要等到2022年1月1日0点0分0秒时才会触发定时器事件。

定时器事件监听器

当定时器事件触发后，我们需要定义一个事件监听器来处理这个事件。例如，我们可以使用<boundaryEvent>来定义事件监听器，如下示例：

<userTask id="userTask3" name="Demo Task">
  <extensionElements>
    <activiti:taskListener event="create" class="com.example.MyTaskListener" />
  </extensionElements>
  <boundaryEvent id="timerBoundaryEvent" attachedToRef="userTask3">
    <timerEventDefinition>
      <timeDuration>PT1M</timeDuration>
    </timerEventDefinition>
  </boundaryEvent>
</userTask>

在上面的代码中，我们为任务“userTask3”定义了一个定时器事件监听器。该监听器使用元素来定义，并绑定到了“userTask3”任务节点上。当任务在1分钟内没有被处理时，将触发定时器事件，并执行我们所定义的监听器逻辑。

使用Java代码启动定时器

除了在流程定义文件中定义定时器外，我们还可以使用Java代码来启动一个定时器。下面是一个示例：

ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
ProcessInstance processInstance = processEngine.getRuntimeService().startProcessInstanceByKey("myProcess");
TaskService taskService = processEngine.getTaskService();
TimerJobEntity timerJob = new TimerJobEntity();
timerJob.setJobHandlerType("message");
MessageJobDeclaration messageJobDeclaration = new MessageJobDeclaration("updateTaskList", "myTaskList", "Demo Task", new Date());
timerJob.setJobHandlerConfiguration(messageJobDeclaration.getJobHandlerConfiguration());
processEngine.getManagementService().scheduleTimerJob(timerJob);

在上面的代码中，我们使用ProcessEngine对象来获取运行时服务和任务服务。然后，我们创建一个TimerJobEntity对象，并使用jobHandlerType和jobHandlerConfiguration属性来设置定时器的类型和配置项。最后，我们使用ManagementService的scheduleTimerJob()方法来启动定时器，并将其绑定到当前流程实例上。

示例

下面是一个使用定时器来完成自动签收任务的示例：

<process id="autoClaimTask" name="自动签收任务">
  <startEvent id="startEvent1" />
  <userTask id="userTask1" name="Demo Task">
    <extensionElements>
      <activiti:taskListener event="create" class="org.activiti.examples.MyTaskListener" />
    </extensionElements>
    <extensionElements>
      <activiti:async>false</activiti:async>
    </extensionElements>
    <extensionElements>
      <activiti:taskListener event="assignment" class="org.activiti.examples.AutoClaimTaskListener" />
    </extensionElements>
    <timerEventDefinition>
      <timeDuration>PT1M</timeDuration>
    </timerEventDefinition>
  </userTask>

  <endEvent id="endEvent1" />
  <sequenceFlow id="flow1" sourceRef="startEvent1" targetRef="userTask1" />
  <sequenceFlow id="flow2" sourceRef="userTask1" targetRef="endEvent1" />
</process>

在Java代码中，我们创建了两个任务分配监听器。其中，第一个监听器MyTaskListener用来在任务创建时进行一些初始化操作，例如对任务的处理时间进行赋值。另外一个监听器AutoClaimTaskListener用于自动签收任务。

public class AutoClaimTaskListener implements TaskListener {

  public void notify(DelegateTask delegateTask) {
    delegateTask.setAssignee("kermit");
  }
}

在上面的代码中，我们通过在任务分配监听器中，将任务自动指派给“kermit”用户，使得任务在超时后会自动被“kermit”签收。