Flowable實戰（一）啟動第一個完整流程

發現網上關于Flowable的資料基本都是淺嘗辄止，對如何建構一個企業級的流程應用說明很少，是以寫個實戰系列，希望對大家和自己，都有所幫助。Flowable是一個使用Java編寫的輕量級業務流程引擎。Flowable是Activiti的fork，即Flowable源自Activiti。是以可以看到，Flowable很多設計與實作，與Activiti是相同的。Flowable官網教程已經提供了一個很簡單的流程運作例子，是英文版。文章下面的例子内容來源于官網教程，已經看過的同學可以直接跳過到下一節内容。

一、前言：

發現網上關于Flowable的資料基本都是淺嘗辄止，對如何建構一個企業級的流程應用說明很少，是以寫個實戰系列，希望對大家和自己，都有所幫助。

二、認識Flowable

Flowable是一個使用Java編寫的輕量級業務流程引擎。

Flowable流程引擎可用于部署BPMN 2.0流程定義，建立這些流程定義的流程執行個體，進行查詢，通路運作中或曆史的流程執行個體與相關資料。

Flowable是Activiti的fork，即Flowable源自Activiti。是以可以看到，Flowable很多設計與實作，與Activiti是相同的。

開源Flowable官網：https://www.flowable.com/open-source/

三、完整執行個體

Flowable官網教程已經提供了一個很簡單的流程運作例子，是英文版。

下面的例子内容來源于官網教程，已經看過的同學可以直接跳過到下一節内容

。

我們将建構的例子是一個簡單的請假(holiday request)流程：

雇員(employee)申請幾天的假期
經理(manager)準許或駁回申請
我們會模拟将申請注冊到某個外部系統，并給雇員發送結果郵件

1.建立項目

打開IDEA，通過File -> New -> Project... -> Maven 建立一個新的Maven項目

在下一個界面，填入項目名Name，GroupId 和 ArtifactId 預設即可

這樣就建立了空的Maven項目。

2.建立流程引擎

為項目添加3個依賴：

Flowable流程引擎。使我們可以建立一個ProcessEngine流程引擎對象，并通路Flowable API。
一個記憶體資料庫。本例中為H2，因為Flowable引擎在運作流程執行個體時，需要使用資料庫來存儲執行與曆史資料。
日志架構。Flowable使用SLF4J作為内部日志架構。本例中，我們使用log4j作為SLF4J的實作。

在pom.xml檔案中添加下列行：

<dependencies>
  <dependency>
      <groupId>org.flowable</groupId>
      <artifactId>flowable-engine</artifactId>
      <version>6.7.2</version>
    </dependency>
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <version>1.3.176</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.21</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.7.21</version>
    </dependency>
</dependencies>

Log4j需要一個配置檔案。在src/main/resources檔案夾下添加log4j.properties檔案，并寫入下列内容：

log4j.rootLogger=INFO, CA

log4j.appender.CA=org.apache.log4j.ConsoleAppender
log4j.appender.CA.layout=org.apache.log4j.PatternLayout
log4j.appender.CA.layout.ConversionPattern= %d{hh:mm:ss,SSS} [%t] %-5p %c %x - %m%n

注意：關于Log4j 的遠端代碼執行漏洞問題，影響範圍是Apache Log4j 2.x <= 2.14.1 版本，是以上面的日志版本是安全的。

有時候，依賴JAR無法自動擷取，可以右鍵點選項目，并選擇 Maven ->Reload Project以強制手動重新整理。

建立一個新的Java類，并添加标準的Java main方法：

public class HolidayRequest {
    
    public static void main(String[] args) {

    }

}

首先要做的是初始化ProcessEngine流程引擎執行個體。建立一個ProcessEngineConfiguration執行個體，并配置資料庫JDBC連接配接。然後由ProcessEngineConfiguration建立ProcessEngine執行個體。

import org.flowable.engine.ProcessEngine;
import org.flowable.engine.ProcessEngineConfiguration;
import org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration;

public class HolidayRequest {

    public static void main(String[] args) {

        ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()
                .setJdbcUrl("jdbc:h2:mem:flowable;DB_CLOSE_DELAY=-1")
                .setJdbcUsername("sa")
                .setJdbcPassword("")
                .setJdbcDriver("org.h2.Driver")
                .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);

        ProcessEngine processEngine = cfg.buildProcessEngine();
    }

}

注意：記憶體H2資料庫在JVM重新開機後會消失。如果需要永久儲存資料，需要切換為持久化資料庫，并相應切換連接配接參數。

這樣就可以運作了。在IDEA中最簡單的方法是右鍵點選類檔案，選擇Run 'HolidayRequest.main()' ：

成功運作，應該可以看到關于引擎啟動與建立資料庫表結構的提示日志：

這樣就得到了一個啟動可用的流程引擎。接下來為它提供一個流程！

3.建立流程定義檔案

我們要建構的流程是一個非常簡單的請假流程。在Flowable術語中，我們将其稱為一個流程定義(process definition)。一個流程定義可以啟動多個流程執行個體(process instance)。流程定義可以看做是重複執行流程的藍圖。在這個例子中，流程定義定義了請假的各個步驟，而一個流程執行個體對應某個雇員提出的一個請假申請。

我們要使用的流程定義為：

為了明确起見，說明一下幾個要點：

啟動流程需要提供一些資訊，例如雇員名字、請假時長以及說明。。
左側的圓圈叫做啟動事件(start event)。這是一個流程執行個體的起點。
第一個矩形是一個使用者任務(user task)。這是流程中人類使用者操作的步驟。在這個例子中，經理需要準許或駁回申請。
取決于經理的決定，排他網關(exclusive gateway) (帶叉的菱形)會将流程執行個體路由至準許或駁回路徑。
如果準許，則需要将申請注冊至某個外部系統，并跟着另一個使用者任務，将經理的決定通知給申請人。
如果駁回，則為雇員發送一封郵件通知他。

注意：一般來說，這樣的流程定義使用可視化模組化工具建立，如Flowable Designer(Eclipse)或Flowable Web Modeler(Web應用)。IDEA沒有官方提供的可視化插件，可選插件為Flowable BPMN visualizer。

将下面的XML儲存在src/main/resources檔案夾下名為holiday-request.bpmn20.xml的檔案中。

<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  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:flowable="http://flowable.org/bpmn"
  typeLanguage="http://www.w3.org/2001/XMLSchema"
  expressionLanguage="http://www.w3.org/1999/XPath"
  targetNamespace="http://www.flowable.org/processdef">

  <process id="holidayRequest" name="Holiday Request" isExecutable="true">

    <startEvent id="startEvent"/>
    <sequenceFlow sourceRef="startEvent" targetRef="approveTask"/>

    <userTask id="approveTask" name="Approve or reject request"/>
    <sequenceFlow sourceRef="approveTask" targetRef="decision"/>

    <exclusiveGateway id="decision"/>
    <sequenceFlow sourceRef="decision" targetRef="externalSystemCall">
      <conditionExpression xsi:type="tFormalExpression">
        <![CDATA[
          ${approved}
        ]]>
      </conditionExpression>
    </sequenceFlow>
    <sequenceFlow  sourceRef="decision" targetRef="sendRejectionMail">
      <conditionExpression xsi:type="tFormalExpression">
        <![CDATA[
          ${!approved}
        ]]>
      </conditionExpression>
    </sequenceFlow>

    <serviceTask id="externalSystemCall" name="Enter holidays in external system"
        flowable:class="CallExternalSystemDelegate"/>
    <sequenceFlow sourceRef="externalSystemCall" targetRef="holidayApprovedTask"/>

    <userTask id="holidayApprovedTask" name="Holiday approved"/>
    <sequenceFlow sourceRef="holidayApprovedTask" targetRef="approveEnd"/>

    <serviceTask id="sendRejectionMail" name="Send out rejection email"
        flowable:class="SendRejectionMail"/>
    <sequenceFlow sourceRef="sendRejectionMail" targetRef="rejectEnd"/>

    <endEvent id="approveEnd"/>

    <endEvent id="rejectEnd"/>

  </process>

</definitions>

每一個步驟（在BPMN 2.0術語中稱作活動(activity)）都有一個id屬性，為其提供一個在XML檔案中唯一的辨別符。所有的活動都可以設定一個名字，以提高流程圖的可讀性。

活動之間通過順序流(sequence flow)連接配接，在流程圖中是一個有向箭頭。在執行流程執行個體時，執行(execution)會從啟動事件沿着順序流流向下一個活動。

離開排他網關(帶有X的菱形)的順序流很特别：都以表達式(expression)的形式定義了條件(condition) 。當流程執行個體的執行到達這個網關時，會計算條件，并使用第一個計算為true的順序流。這就是排他的含義：隻選擇一個。

這裡用作條件的表達式為"$ {approved}"，這是${approved == true}的簡寫。變量’approved’被稱作流程變量(process variable)。

現在我們已經有了流程BPMN 2.0 XML檔案，下來需要将它'部署(deploy)'到引擎中。

4.部署流程定義

将流程定義部署至Flowable引擎，需要使用RepositoryService，其可以從ProcessEngine對象擷取。使用RepositoryService，可以通過XML檔案的路徑建立一個新的部署(Deployment)，并調用deploy()方法實際執行：

RepositoryService repositoryService = processEngine.getRepositoryService();
Deployment deployment = repositoryService.createDeployment()
  .addClasspathResource("holiday-request.bpmn20.xml")
  .deploy();

我們現在可以通過API查詢驗證流程定義已經部署在引擎中。通過RepositoryService建立的ProcessDefinitionQuery對象實作。

ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
  .deploymentId(deployment.getId())
  .singleResult();
System.out.println("Found process definition : " + processDefinition.getName());

5.啟動流程執行個體

現在已經在流程引擎中部署了流程定義，是以可以使用這個流程定義作為“藍圖”啟動流程執行個體。

要啟動流程執行個體，需要提供一些初始化流程變量。一般來說，可以通過呈現給使用者的表單，或者在流程由其他系統自動觸發時通過REST API，來擷取這些變量。在這個例子裡，我們簡化為使用java.util.Scanner類在指令行輸入一些資料：

Scanner scanner= new Scanner(System.in);

System.out.println("Who are you?");
String employee = scanner.nextLine();

System.out.println("How many holidays do you want to request?");
Integer nrOfHolidays = Integer.valueOf(scanner.nextLine());

System.out.println("Why do you need them?");
String description = scanner.nextLine();

接下來，我們使用RuntimeService啟動一個流程執行個體。收集的資料作為一個java.util.Map執行個體傳遞，其中的鍵就是之後用于擷取變量的辨別符。這個流程執行個體使用key啟動。這個key就是BPMN 2.0 XML檔案中設定的id屬性，在這個例子裡是holidayRequest。

<process id="holidayRequest" name="Holiday Request" isExecutable="true">

RuntimeService runtimeService = processEngine.getRuntimeService();

Map<String, Object> variables = new HashMap<String, Object>();
variables.put("employee", employee);
variables.put("nrOfHolidays", nrOfHolidays);
variables.put("description", description);
ProcessInstance processInstance =
  runtimeService.startProcessInstanceByKey("holidayRequest", variables);

在流程執行個體啟動後，會建立一個執行(execution)，并将其放在啟動事件上。從這裡開始，這個執行沿着順序流移動到經理審批的使用者任務，并執行使用者任務行為。這個行為将在資料庫中建立一個任務，該任務可以之後使用查詢找到。使用者任務是一個等待狀态(wait state)，引擎會停止執行，傳回API調用處。

6.查詢與完成任務

我們還沒有為使用者任務配置辦理人。我們想将第一個任務指派給"經理(managers)"組，而第二個使用者任務指派給請假申請的送出人。是以需要為第一個任務添加candidateGroups屬性，修改流程xml配置檔案：

<userTask id="approveTask" name="Approve or reject request" flowable:candidateGroups="managers"/>

并如下所示為第二個任務添加assignee屬性。請注意我們沒有像上面的’managers’一樣使用靜态值，而是使用一個流程變量動态指派。這個流程變量是在流程執行個體啟動時傳遞的：

<userTask id="holidayApprovedTask" name="Holiday approved" flowable:assignee="${employee}"/>

要獲得實際的任務清單，需要通過TaskService建立一個TaskQuery。我們配置這個查詢隻傳回’managers’組的任務：

TaskService taskService = processEngine.getTaskService();
List<Task> tasks = taskService.createTaskQuery().taskCandidateGroup("managers").list();
System.out.println("You have " + tasks.size() + " tasks:");
for (int i=0; i<tasks.size(); i++) {
  System.out.println((i+1) + ") " + tasks.get(i).getName());
}

可以使用任務Id擷取特定流程執行個體的變量，并在螢幕上顯示實際的申請：

System.out.println("Which task would you like to complete?");
int taskIndex = Integer.valueOf(scanner.nextLine());
Task task = tasks.get(taskIndex - 1);
Map<String, Object> processVariables = taskService.getVariables(task.getId());
System.out.println(processVariables.get("employee") + " wants " +
    processVariables.get("nrOfHolidays") + " of holidays. Do you approve this?");

運作結果像下面這樣：

經理現在就可以完成任務了。在現實中，這通常意味着由使用者送出一個表單。表單中的資料作為流程變量傳遞。在這裡，我們在完成任務時傳遞帶有’approved’變量（這個名字很重要，因為之後會在順序流的條件中使用！）的map來模拟：

boolean approved = scanner.nextLine().toLowerCase().equals("y");
variables = new HashMap<String, Object>();
variables.put("approved", approved);
taskService.complete(task.getId(), variables);

現在任務完成，并會在離開排他網關的兩條路徑中，基于’approved’流程變量選擇一條。

7.實作JavaDelegate

代碼還缺了一塊：我們還沒有實作申請通過後執行的自動邏輯。在BPMN 2.0 XML中，這是一個服務任務(service task)：

<serviceTask id="externalSystemCall" name="Enter holidays in external system"
    flowable:class="org.flowable.CallExternalSystemDelegate"/>

在現實中，這個邏輯可以做任何事情：向某個系統發起一個HTTP REST服務調用，或調用某個使用了好幾十年的系統中的遺留代碼。我們不會在這裡實作實際的邏輯，而隻是簡單的日志記錄流程。

建立一個新的JAVA類，CallExternalSystemDelegate作為類名。讓這個類實作org.flowable.engine.delegate.JavaDelegate接口，并實作execute方法：

import org.flowable.engine.delegate.DelegateExecution;
import org.flowable.engine.delegate.JavaDelegate;

public class CallExternalSystemDelegate implements JavaDelegate {
    public void execute(DelegateExecution execution) {
        System.out.println("Calling the external system for employee "
                + execution.getVariable("employee"));
    }
}

當執行到達服務任務時，會初始化并調用BPMN 2.0 XML中所引用的類。

現在執行這個例子的時候，就會顯示出日志資訊，說明已經執行了自定義邏輯：

注意：如果出現“org.flowable.common.engine.api.FlowableException: couldn't instantiate class CallExternalSystemDelegate”的報錯，說明包路徑未指定正确，在xml檔案中，根據自己CallExternalSystemDelegate類的實際路徑修改:
<serviceTask id="externalSystemCall" name="Enter holidays in external system"
                    flowable:class="CallExternalSystemDelegate"/>
           

8.使用曆史資料

Flowable可以自動存儲所有流程執行個體的資料。

例如，如果希望顯示流程執行個體已經執行的時間，就可以從ProcessEngine擷取HistoryService，并建立曆史活動(historical activities)的查詢。在下面的代碼片段中，可以看到我們添加了一些額外的過濾條件：

隻選擇一個特定流程執行個體的活動
隻選擇已完成的活動

結果按照結束時間排序，代表其執行順序。

HistoryService historyService = processEngine.getHistoryService();
List<HistoricActivityInstance> activities =
  historyService.createHistoricActivityInstanceQuery()
   .processInstanceId(processInstance.getId())
   .finished()
   .orderByHistoricActivityInstanceEndTime().asc()
   .list();

for (HistoricActivityInstance activity : activities) {
  System.out.println(activity.getActivityId() + " took "
    + activity.getDurationInMillis() + " milliseconds");
}

再次運作例子，可以看到控制台中顯示：

9.小結

這個教程介紹了很多Flowable與BPMN 2.0的概念與術語，也展示了如何程式設計使用Flowable API。

Flowable實戰（一）啟動第一個完整流程

一、前言：

二、認識Flowable

三、完整執行個體

1.建立項目

2.建立流程引擎

3.建立流程定義檔案

4.部署流程定義

5.啟動流程執行個體

6.查詢與完成任務

7.實作JavaDelegate

8.使用曆史資料

9.小結

繼續閱讀

關于Gradle配置的小結

Java小案例——随機數猜測随機數猜測

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method