activiti学习笔记(九)RuntimeService

2018-10-02 本文已影响337人云师兄

RuntimeService 流程运行控制服务

启动流程及对流程数据的控制
流程实例(ProcessInstance)与执行流(Execution)的查询
触发流程操作,接收消息和信号

RuntimeService启动流程及变量管理

启动流程的常用方法(id,key,message)
启动流程可选参数(businessKey,variables,tenantId)
变量(variables)的设置和获取

示例

RuntimeService runtimeService = processEngine.getRuntimeService();

// 根据流程定义id启动流程实例
ProcessInstance processInstance = runtimeService.startProcessInstanceById(processDefinition.getId());

// 根据流程定义key启动流程实例
ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("second_approve");

// 启动流程实例时带上参数
Map<String,Object> variables = new HashMap<String, Object>();
variables.put("key1","value1");
ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("second_approve",variables);
        
// 根据ProcessInstanceBuilder启动流程实例
ProcessInstanceBuilder processInstanceBuilder = runtimeService.createProcessInstanceBuilder();
processInstanceBuilder.businessKey("second_approve")
                .processDefinitionKey("")
                .variables(variables)
                .start();

// 流程启动后获取变量
Map<String,Object> variables1 = runtimeService.getVariables(processInstance.getId());

// 设置变量
runtimeService.setVariable(processInstance.getId(),"key3","value3");

// 查询流程实例对象
runtimeService.createProcessInstanceQuery()
                .processInstanceId(processInstance.getId())
                .singleResult();

// 执行对象查询
List<Execution> executionList = runtimeService.createExecutionQuery()
                .listPage(0,100);

从示例中可以发现有多种方法可以启动流程，而通过key启动的流程实例每次都是根据最新版本的流程定义启动的，比使用流程定义id启动更加方便。
流程实例和流程定义和执行对象都一样，都有一个名称后有Query的对象作为查询使用，如果要获取单个结果则调用Query对象的singleResult方法，如果要获取列表数据则调用listPage方法。

流程实例与执行对象

流程实例ProcessInstance表示一次工作流业务的数据实体
执行流Execution表示流程实例中的具体工作路径
ProcessInstance类继承Execution类

流程触发

使用trigger触发ReceiveTask节点
触发信号捕获事件signalEventReceived
触发消息捕获事件 messageEventReceived

流程触发示例

首先编写流程文件如下

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" 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" xmlns:tns="http://www.activiti.org/test" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" expressionLanguage="http://www.w3.org/1999/XPath" id="m1536107421286" name="" targetNamespace="http://www.activiti.org/test" typeLanguage="http://www.w3.org/2001/XMLSchema">
  <process id="second_approve" isClosed="false" isExecutable="true" name="二级审批" processType="None">
    <startEvent id="startEvent" name="开始"/>
    <sequenceFlow id="flow1" sourceRef="startEvent" targetRef="someTask"/>
    <receiveTask id="someTask"></receiveTask>
    <sequenceFlow id="flow2" sourceRef="someTask" targetRef="endEvent"/>
    <endEvent id="endEvent" name="取消"/>
  </process>
</definitions>

流程为开始节点->receiveTask节点->结束节点。
后台实现如下：

ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("second_approve", variables);
Execution execution =runtimeService.createExecutionQuery()
                .activityId("someTask")
                .singleResult();
logger.info("execution={}",execution);
runtimeService.trigger(execution.getId());
execution = runtimeService.createExecutionQuery()
                .activityId("someTask")
                .singleResult();
logger.info("execution={}",execution);

当执行trigger方法后，就执行完receiveTask节点，所以执行前execution对象有值，执行后execution对象就为空了。

事件

事件用来表明流程的生命周期中发生了什么事。事件总是画成一个圆圈。在BPMN 2.0 中，事件有两大分类：捕获（catching）或触发（throwing）事件。

捕获（Catching）：当流程执行到事件，它会等待被触发。触发的类型是由内部图表或 XML 中的类型声明来决定的。捕获事件与触发事件在显示方面是根据内部图表是否被填充来区分的（白色的）。属于捕获的事件有
触发（Throwing）：当流程执行到事件，会触发一个事件。触发的类型是由内部图表或 XML 中的类型声明来决定的。触发事件与捕获事件在显示方面是根据内部图表是否被填充来区分的（被填充为黑色）。

Event Definitions 事件定义

事件定义决定了事件的语义。如果没有事件定义，这个事件就不做什么特别的事情。没有设置事件定义的开始事件不会在启动流程时做任何事情。如果给开始事件添加了一个事件定义（比如定时器事件定义）我们就声明了开始流程的事件 “类型 ” （这时定时器事件监听器会在某个时间被触发）。比如错误事件定义(Error Event Definitions)由指定错误触发的。另外还有Signal Event Definitions即信号事件定义。

信号事件

信号事件会引用一个已命名的信号。信号全局范围的事件（广播语义）。会发送给所有激活的处理器。
信号事件定义使用 signalEventDefinition 元素。 signalRef 属性会引用 definitions 根节点里定义的 signal 子元素。
示例，首先看下流程定义文件xml:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" 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" xmlns:tns="http://www.activiti.org/test" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" expressionLanguage="http://www.w3.org/1999/XPath" id="m1536107421286" name="" targetNamespace="http://www.activiti.org/test" typeLanguage="http://www.w3.org/2001/XMLSchema">
  <signal id="signalStart" name="my-signal"></signal>
  <process id="second_approve" isClosed="false" isExecutable="true" name="二级审批" processType="None">
    <startEvent id="startEvent" name="开始"/>
    <intermediateCatchEvent id="signal-received">
      <signalEventDefinition signalRef="signalStart"/>
    </intermediateCatchEvent>
    <sequenceFlow id="flow1" sourceRef="startEvent" targetRef="signal-received"/>
    <sequenceFlow id="flow2" sourceRef="signal-received" targetRef="endEvent"/>
    <endEvent id="endEvent" name="取消"/>
  </process>
</definitions>

示例中事件用中间捕获事件封装:

    <intermediateCatchEvent id="myIntermediateCatchEvent" >
          <XXXEventDefinition/>
    </intermediateCatchEvent>

流程文件中定义了一个信号，ID为signalStart.流程启动后就处于等待状态，等待信号事件触发，触发后再继续往下走。
后台代码如下：

Execution execution = runtimeService.createExecutionQuery()
                .signalEventSubscriptionName("my-signal")
                .singleResult();
        logger.info("execution={}",execution);
        runtimeService.signalEventReceived("my-signal");
        execution = runtimeService.createExecutionQuery()
                .signalEventSubscriptionName("my-signal")
                .singleResult();

        logger.info("execution={}",execution);

当执行runtimeService.signalEventReceived方法后就会触发信号，所以执行前后，execution出现由有到无的过程。

消息事件

流程文件定义如下：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" 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" xmlns:tns="http://www.activiti.org/test" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" expressionLanguage="http://www.w3.org/1999/XPath" id="m1536107421286" name="" targetNamespace="http://www.activiti.org/test" typeLanguage="http://www.w3.org/2001/XMLSchema">
  <message id="messageStart" name="my-message"></message>
  <process id="second_approve" isClosed="false" isExecutable="true" name="二级审批" processType="None">
    <startEvent id="startEvent" name="开始"/>
    <intermediateCatchEvent id="message-received">
      <messageEventDefinition messageRef="messageStart"/>
    </intermediateCatchEvent>
    <sequenceFlow id="flow1" sourceRef="startEvent" targetRef="message-received"/>
    <sequenceFlow id="flow2" sourceRef="message-received" targetRef="endEvent"/>
    <endEvent id="endEvent" name="取消"/>
  </process>
</definitions>

可以看到大致结构和信号事件差不多。
后台代码如下：

Execution execution = runtimeService.createExecutionQuery()
                .messageEventSubscriptionName("my-message")
                .singleResult();
        logger.info("execution={}",execution);
        runtimeService.messageEventReceived("my-message",execution.getId());
        execution = runtimeService.createExecutionQuery()
                .signalEventSubscriptionName("my-message")
                .singleResult();
        logger.info("execution={}",execution);

可以看到信号事件和消息事件写法差不多，区别在于触发事件的时候，除了要传消息的名称外，还要传执行对象id，即不是将事件广播给所有节点，而是指定给某个执行对象。