Flowable 服务任务执行的三种方式

Posted 2023-03-05 JEECG官方博客

前面和小伙伴们分别聊了 Flowable 中的 ReceiveTask 和 UserTask，今天我们来看看另外一个比较常见的 Task --> ServiceTask。

1. ServiceTask

ServiceTask 从名字上看就是服务任务，它的图标一般是像下面这样：

ServiceTask 一般由系统自动完成，当流程走到这一步的时候，不会自动停下来，而是会去执行我们提前在 ServiceTask 中配置好的方法。

2. 实践

我们通过一个简单的例子来看一下 ServiceTask 要怎么玩。

假设我有如下一个简单的流程图：

中间这个就是一个 ServiceTask。

当流程执行到 ServiceTask 的时候，具体要做哪些事情？有三种不同的方式来设置这里的任务，我们分别来看。

2.1 监听类

首先我们可以设置一个监听类，这个监听类有一个硬性规定就是需要实现 JavaDelegate 接口，像下面这样：

public class MyServiceTask implements JavaDelegate 
    @Override
    public void execute(DelegateExecution execution) 
        System.out.println("========MyServiceTask==========");
    

在这个监听类中我们可以完成一些操作，通过这个 execution 也可以获取到在流程节点之间传输的变量。

这个类定义好之后，接下来我们在流程定义的时候，配置这个类的全路径即可，如下图：

 

这个配置对应的 XML 内容如下：

  <process id="demo01" name="测试流程" isExecutable="true">
    <documentation>测试流程</documentation>
    <startEvent id="startEvent1" flowable:formFieldValidation="true"></startEvent>
    <sequenceFlow id="sid-33A78082-C2FD-48BE-8B87-99FB20F0B331" sourceRef="startEvent1" targetRef="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8"></sequenceFlow>
    <serviceTask id="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8" flowable:class="org.javaboy.flowableidm.MyServiceTask"></serviceTask>
    <endEvent id="sid-A5F11956-15EA-4574-98D0-29A4E3DB5495"></endEvent>
    <sequenceFlow id="sid-0698809E-0A6C-4B92-A167-AE96A8CB75F2" sourceRef="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8" targetRef="sid-A5F11956-15EA-4574-98D0-29A4E3DB5495"></sequenceFlow>
  </process>

小伙伴们看到，在 ServiceTask 标签中的 flowable:class="org.javaboy.flowableidm.MyServiceTask" 就表示 ServiceTask 执行的服务类。

配置完成后，我们可以部署并启动这个流程，由于这个流程除了开始和结束，就这一个节点，所以流程一启动就自动结束了。不过在这个过程中，我们可以看到控制台打印出来了日志，说明这个 ServiceTask 确实是执行了。

2.2 委托表达式

我们也可以配置委托表达式。

委托表达式是指将一个实现了 JavaDelegate 接口的类注册到 Spring 容器中，然后我们在流程节点的配置中不用写完整的类名了，只需要写 Spring 容器中的 Bean 名称即可。

像下面这样：

@Component
public class MyServiceTask implements JavaDelegate 
    @Override
    public void execute(DelegateExecution execution) 
        System.out.println("========MyServiceTask==========");
    

这个类注册到 Spring 容器中的默认名称是类名首字母小写，即 myServiceTask。

现在我们在流程图中，可以按照如下方式进行配置：

 

对应的 XML 文件如下：

<process id="demo01" name="测试流程" isExecutable="true">
  <documentation>测试流程</documentation>
  <startEvent id="startEvent1" flowable:formFieldValidation="true"></startEvent>
  <sequenceFlow id="sid-33A78082-C2FD-48BE-8B87-99FB20F0B331" sourceRef="startEvent1" targetRef="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8"></sequenceFlow>
  <serviceTask id="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8" flowable:delegateExpression="$myServiceTask"></serviceTask>
  <endEvent id="sid-A5F11956-15EA-4574-98D0-29A4E3DB5495"></endEvent>
  <sequenceFlow id="sid-0698809E-0A6C-4B92-A167-AE96A8CB75F2" sourceRef="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8" targetRef="sid-A5F11956-15EA-4574-98D0-29A4E3DB5495"></sequenceFlow>
</process>

可以看到，flowable:delegateExpression="$myServiceTask" 就表示执行的一个表达式。

测试过程同 2.1 小节，我就不再赘述了。

最后总结一下，委托表达式，一定是 JavaDelegate 接口的实现类，将这个实现类注册到 Spring 容器中，然后在使用的时候，根据 Bean 的名称从 Spring 容器中查找即可。

2.3 表达式

我们也可以使用表达式。

表达式就是一个普通类的普通方法，将这个普通类注册到 Spring 容器中，然后表达式中还可以执行这个类中的方法，类似下面这样，任意定义一个 Java 类：

@Component
public class MyServiceTask2 
    public void hello() 
        System.out.println("========MyServiceTask2==========");
    

然后在流程图中按照如下方式进行配置：

 

表达式中有一部分内容隐藏了，完整的表达式是 $myServiceTask2.hello()。

对应的 XML 文件如下：

<process id="demo01" name="测试流程" isExecutable="true">
  <documentation>测试流程</documentation>
  <startEvent id="startEvent1" flowable:formFieldValidation="true"></startEvent>
  <sequenceFlow id="sid-33A78082-C2FD-48BE-8B87-99FB20F0B331" sourceRef="startEvent1" targetRef="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8"></sequenceFlow>
  <serviceTask id="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8" flowable:expression="$myServiceTask2.hello()"></serviceTask>
  <endEvent id="sid-A5F11956-15EA-4574-98D0-29A4E3DB5495"></endEvent>
  <sequenceFlow id="sid-0698809E-0A6C-4B92-A167-AE96A8CB75F2" sourceRef="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8" targetRef="sid-A5F11956-15EA-4574-98D0-29A4E3DB5495"></sequenceFlow>
</process>

可以看到，表达式的内容是 flowable:expression="$myServiceTask2.hello()。

测试方式同 2.1 小节，这里我不再赘述。

3. 类中字段

可能有小伙伴注意到，我们在绘制流程图的时候，还可以为类设置一个字段。

例如我想给 ServiceTask 的执行类设置一个 username 字段，如下：

 设置完成后，对应的 XML 如下：

<process id="demo01" name="测试流程" isExecutable="true">
  <documentation>测试流程</documentation>
  <startEvent id="startEvent1" flowable:formFieldValidation="true"></startEvent>
  <sequenceFlow id="sid-33A78082-C2FD-48BE-8B87-99FB20F0B331" sourceRef="startEvent1" targetRef="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8"></sequenceFlow>
  <serviceTask id="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8" flowable:delegateExpression="$myServiceTask">
    <extensionElements>
      <flowable:field name="username">
        <flowable:string><![CDATA[javaboy]]></flowable:string>
      </flowable:field>
    </extensionElements>
  </serviceTask>
  <endEvent id="sid-A5F11956-15EA-4574-98D0-29A4E3DB5495"></endEvent>
  <sequenceFlow id="sid-0698809E-0A6C-4B92-A167-AE96A8CB75F2" sourceRef="sid-6FA66E2A-F8E6-4F10-8FA2-6450408E17D8" targetRef="sid-A5F11956-15EA-4574-98D0-29A4E3DB5495"></sequenceFlow>
</process>

可以看到，这里通过 extensionElements 节点描述了额外的信息。

接下来，我们就可以在 Java 类中访问到这个变量了，如下：

@Component
public class MyServiceTask implements JavaDelegate 
    Expression username;
    @Override
    public void execute(DelegateExecution execution) 
        System.out.println("username.getExpressionText() = " + username.getExpressionText());
        System.out.println("username.getValue(execution) = " + username.getValue(execution));
        System.out.println("========MyServiceTask==========");
    

想要获取到 username 对应的值，上面这段代码中，松哥给大家演示了两种方式。

不过需要注意，这种设置类中字段的方式，适用于 2.1 和 2.2 小节的情况，不适用于 2.3 小节的情况。