在这个初步教程中，将构建一个简单的例子，以展示如何创建一个Flowable流程引擎，介绍一些核心概念，并展示如何使用API。 截图时使用的是IDEA，但实际上可以使用任何IDE。我们使用Maven获取Flowable依赖及管理构建
我们将构建的例子是一个简单的请假(holiday request)流程：
雇员(employee)申请几天的假期
经理(manager)批准或驳回申请
1.搭建环境
点击next
点击next
点击Finish
就生成了一个空的项目了
然后添加两个依赖：
Flowable流程引擎。使我们可以创建一个ProcessEngine流程引擎对象，并访问Flowable API。
MySQL的驱动
4.0.0
org.springframework.boot
spring-boot-starter-parent
2.3.0.RELEASE
com.jykj
flowable.boot
1.0-SNAPSHOT
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-web
mysql
mysql-connector-java
org.springframework.boot
spring-boot-starter-jdbc
org.flowable
flowable-spring-boot-starter
6.5.0
创建一个新的Java类，并添加标准的Java main方法：
package com.jykj.flow;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @author netgy
* @since 2020/9/10 15:13
*/
@SpringBootApplication(scanBasePackages="com.jykj")
public class FlowBootApplication {
public static void main(String[] args) {
SpringApplication.run(FlowBootApplication.class,args);
}
}
在resource下面添加application.yml
spring:
application:
name: flow
datasource:
url: jdbc:mysql://60.169.77.40:3306/flowable?useSSL=false&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&transformedBitIsBoolean=true&tinyInt1isBit=false&allowMultiQueries=true&serverTimezone=GMT%2B8&allowPublicKeyRetrieval=true
username: root
password: 801682
main:
allow-bean-definition-overriding: true #当遇到同样名字的时候，是否允许覆盖注册
server:
port: 7777
management:
endpoint:
flowable:
enabled: true
代码结构图如下：
点击右键启动
这样就得到了一个启动可用的流程引擎。接下来为它提供一个流程！
2.部署流程定义
我们要构建的流程是一个非常简单的请假流程。Flowable引擎需要流程定义为BPMN 2.0格式，这是一个业界广泛接受的XML标准。 在Flowable术语中，我们将其称为一个流程定义(process definition)。一个流程定义可以启动多个流程实例(process instance)。流程定义可以看做是重复执行流程的蓝图。 在这个例子中，流程定义定义了请假的各个步骤，而一个流程实例对应某个雇员提出的一个请假申请。
BPMN 2.0存储为XML，并包含可视化的部分：使用标准方式定义了每个步骤类型（人工任务，自动服务调用，等等）如何呈现，以及如何互相连接。这样BPMN 2.0标准使技术人员与业务人员能用双方都能理解的方式交流业务流程。
我们要使用的流程定义为：
这个流程应该已经十分自我解释了。但为了明确起见，说明一下几个要点：
我们假定启动流程需要提供一些信息，例如雇员名字、请假时长以及说明。当然，这些可以单独建模为流程中的第一步。 但是如果将它们作为流程的“输入信息”，就能保证只有在实际请求时才会建立一个流程实例。否则（将提交作为流程的第一步），用户可能在提交之前改变主意并取消，但流程实例已经创建了。 在某些场景中，就可能影响重要的指标（例如启动了多少申请，但还未完成），取决于业务目标。
左侧的圆圈叫做启动事件(start event)。这是一个流程实例的起点。
第一个矩形是一个用户任务(user task)。这是流程中人类用户操作的步骤。在这个例子中，经理需要批准或驳回申请。
取决于经理的决定，排他网关(exclusive gateway) (带叉的菱形)会将流程实例路由至批准或驳回路径。
如果批准，则需要将申请注册至某个外部系统，并跟着另一个用户任务，将经理的决定通知给申请人。当然也可以改为发送邮件。
如果驳回，则为雇员发送一封邮件通知他。
一般来说，这样的流程定义使用可视化建模工具建立，如Flowable Designer(Eclipse)或Flowable Web Modeler(Web应用)。
flowable-modeler 流程设计器 点击可以访问
admin/test
PPT中已经详细介绍了流程XML了，这里就不再赘述了
现在我们已经有了流程BPMN 2.0 XML文件，下来需要将它部署(deploy)到引擎中。部署一个流程定义意味着：
流程引擎会将XML文件存储在数据库中，这样可以在需要的时候获取它。
流程定义转换为内部的、可执行的对象模型，这样使用它就可以启动流程实例。
将流程定义部署至Flowable引擎，需要使用RepositoryService，其可以从ProcessEngine对象获取。使用RepositoryService，可以通过XML文件的路径创建一个新的部署(Deployment)，并调用deploy()方法实际执行：
部署方式一：
RepositoryService repositoryService = processEngine.getRepositoryService();
Deployment deployment = repositoryService.createDeployment()
.addClasspathResource("holiday-request.bpmn20.xml")
.deploy();
部署方式二：使用flowable-modeler提供的部署工具，本质原理同上
我们现在可以通过API查询验证流程定义已经部署在引擎中（并学习一些API）。通过RepositoryService创建的ProcessDefinitionQuery对象实现。
ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
.deploymentId(deployment.getId())
.singleResult();
System.out.println("Found process definition : " + processDefinition.getName());
3.启动流程
现在已经在流程引擎中部署了流程定义，因此可以使用这个流程定义作为“蓝图”启动流程实例。
要启动流程实例，需要提供一些初始化流程变量。一般来说，可以通过呈现给用户的表单，
接下来，我们使用RuntimeService启动一个流程实例。收集的数据作为一个java.util.Map实例传递，其中的键就是之后用于获取变量的标识符。这个流程实例使用key启动。这个key就是BPMN 2.0 XML文件中设置的id属性，在这个例子里是holidayRequest。
RuntimeService runtimeService = processEngine.getRuntimeService();
Map variables = new HashMap();
variables.put("employee", employee);
variables.put("nrOfHolidays", nrOfHolidays);
variables.put("description", description);
ProcessInstance processInstance =
runtimeService.startProcessInstanceByKey("holidayRequest", variables);
在流程实例启动后，会创建一个执行(execution)，并将其放在启动事件上。从这里开始，这个执行沿着顺序流移动到经理审批的用户任务，并执行用户任务行为。这个行为将在数据库中创建一个任务，该任务可以之后使用查询找到。用户任务是一个等待状态(wait state)，引擎会停止执行，返回API调用处。
4.查询并完成任务
在更实际的应用中，会为雇员及经理提供用户界面，让他们可以登录并查看任务列表。其中可以看到作为流程变量存储的流程实例数据，并决定如何操作任务。在这个例子中，我们通过执行API调用来模拟任务列表，通常这些API都是由UI驱动的服务在后台调用的。
我们还没有为用户任务配置办理人。我们想将第一个任务指派给"经理(managers)"组，而第二个用户任务指派给请假申请的提交人。因此需要为第一个任务添加candidateGroups属性：
要获得实际的任务列表，需要通过TaskService创建一个TaskQuery。我们配置这个查询只返回’managers’组的任务：
TaskService taskService = processEngine.getTaskService();
List tasks = taskService.createTaskQuery().taskAssignee(assignee).list()
System.out.println("You have " + tasks.size() + " tasks:");
for (int i=0; i 经理现在就可以完成任务了。在现实中，这通常意味着由用户提交一个表单。表单中的数据作为流程变量传递。在这里，我们在完成任务时传递带有’approved’变量（这个名字很重要，因为之后会在顺序流的条件中使用！）的map来模拟：
variables = new HashMap
variables.put("approved", approved);
taskService.complete(task.getId(), variables);
现在任务完成，并会在离开排他网关的两条路径中，基于’approved’流程变量选择一条。
5.服务任务(service task)
在现实中，这个逻辑可以做任何事情：向某个系统发起一个HTTP REST服务调用，或调用某个使用了好几十年的系统中的遗留代码。我们不会在这里实现实际的逻辑，而只是简单的日志记录流程。
创建一个新的类CallExternalSystemDelegate作为类名。让这个类实现org.flowable.engine.delegate.JavaDelegate接口，并实现execute方法：
package com.jykj.flow.listener;
import org.flowable.engine.delegate.DelegateExecution;
import org.flowable.engine.delegate.JavaDelegate;
/**
* @author netgy
* @since 2020/9/10 15:59
*/
public class CallExternalSystemDelegate implements JavaDelegate {
public void execute(DelegateExecution execution) {
Object employee=execution.getVariable("employee");
Object nrOfHolidays=execution.getVariable("nrOfHolidays");
Object description=execution.getVariable("description");
Object comments=execution.getVariable("comments");
System.out.println("调用外部系统，为员工： "
+ employee);
System.out.println("请假天数： "
+ nrOfHolidays);
System.out.println("请假原因： "
+ description);
System.out.println("审批意见： "
+ comments);
}
}
创建一个新的类SendEmailDelegate作为类名。让这个类实现org.flowable.engine.delegate.JavaDelegate接口，并实现execute方法：
package com.jykj.flow.listener;
import org.flowable.engine.delegate.DelegateExecution;
import org.flowable.engine.delegate.JavaDelegate;
/**
* @author netgy
* @since 2020/9/10 15:59
*/
public class SendEmailDelegate implements JavaDelegate {
public void execute(DelegateExecution execution) {
Object employee=execution.getVariable("employee");
Object nrOfHolidays=execution.getVariable("nrOfHolidays");
Object description=execution.getVariable("description");
Object comments=execution.getVariable("comments");
System.out.println("驳回了，发邮件给员工： "
+ employee);
System.out.println("请假天数： "
+ nrOfHolidays);
System.out.println("请假原因： "
+ description);
System.out.println("审批意见： "
+ comments);
}
}
6.使用历史数据
选择使用Flowable这样的流程引擎的原因之一，是它可以自动存储所有流程实例的审计数据或历史数据。这些数据可以用于创建报告，深入展现组织运行的情况，瓶颈在哪里，等等。
例如，如果希望显示流程实例已经执行的时间，就可以从ProcessEngine获取HistoryService，并创建历史活动(historical activities)的查询。在下面的代码片段中，可以看到我们添加了一些额外的过滤条件：
只选择一个特定流程实例的活动
只选择已完成的活动
结果按照结束时间排序，代表其执行顺序。
HistoryService historyService = processEngine.getHistoryService();
List activities =
historyService.createHistoricActivityInstanceQuery()
.processInstanceId(processInstance.getId())
.finished()
.orderByHistoricActivityInstanceEndTime().asc()
.list();
for (HistoricActivityInstance activity : activities) {
System.out.println(activity.getActivityId() + " took "
+ activity.getDurationInMillis() + " milliseconds");
}
7进阶 将流程对外提供HTTP请求的支持
maven增加依赖
org.springframework.boot
spring-boot-starter-web
增加FlowController类
package com.jykj.flow.controller;
import com.jykj.flow.common.Result;
import com.jykj.flow.service.FlowService;
import com.jykj.flow.vo.TaskVo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
* @author netgy
* @since 2020/9/3 9:39
*/
@RestController
public class FlowController {
@Autowired
private FlowService flowService;
@GetMapping(value="/process")
public Result startProcessInstance(String key, Integer nrOfHolidays, String description, String employee) {
flowService.startProcess(key, nrOfHolidays, description, employee);
return Result.success("success");
}
@RequestMapping(value="/tasks", method= RequestMethod.GET, produces= MediaType.APPLICATION_JSON_VALUE)
public List getTasks(@RequestParam String assignee) {
return flowService.getTasks(assignee);
}
@RequestMapping(value="/completeTask", method= RequestMethod.GET, produces= MediaType.APPLICATION_JSON_VALUE)
public Result completeTask(String taskId, Integer approved,String comments){
flowService.completeTask(taskId,approved,comments);
return Result.success("success");
}
}
增加FlowService类
package com.jykj.flow.service;
import com.jykj.flow.vo.HolidayVo;
import com.jykj.flow.vo.TaskVo;
import org.flowable.engine.RuntimeService;
import org.flowable.engine.TaskService;
import org.flowable.engine.runtime.ProcessInstance;
import org.flowable.task.api.Task;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* @author netgy
* @since 2020/9/3 9:39
*/
@Service
public class FlowService {
@Autowired
private RuntimeService runtimeService;
@Autowired
private TaskService taskService;
@Transactional
public void startProcess(String key, Integer nrOfHolidays, String description, String employee) {
Map variables = new HashMap();
variables.put("employee", employee);
variables.put("nrOfHolidays", nrOfHolidays);
variables.put("description", description);
variables.put("approved", 0);
variables.put("comments", "");
runtimeService.startProcessInstanceByKey(key, variables);
List tasks = this.getTasks(employee);
if(tasks!=null&&!tasks.isEmpty()){
taskService.complete( tasks.get(0).getId());
}
}
@Transactional
public List getTasks(String assignee) {
List tasks = new ArrayList<>();
tasks.addAll(taskService.createTaskQuery().taskAssignee(assignee).list());
List dtos = new ArrayList();
for (Task task : tasks) {
TaskVo taskVo=new TaskVo(task.getId(), task.getName());
HolidayVo holidayVo=new HolidayVo();
holidayVo.setEmployee((String)taskService.getVariable(task.getId(),"employee"));
holidayVo.setNrOfHolidays((Integer)taskService.getVariable(task.getId(),"nrOfHolidays")+"");
holidayVo.setDescription((String)taskService.getVariable(task.getId(),"description"));
taskVo.setHolidayVo(holidayVo);
dtos.add(taskVo);
}
return dtos;
}
@Transactional
public void completeTask(String taskId, Integer approved,String comments) {
taskService.setVariable(taskId, "approved", approved);
taskService.setVariable(taskId, "comments", comments);
taskService.complete(taskId);
}
}