springboot整合flowable(工作流)
简介
Flowable 适用于开发人员,系统管理员和业务用户的紧凑且高效的工作流程和业务流程管理(BPM)平台。
Flowable的发布包里包含了大部分源码,以JAR文件方式提供。Flowable的源码也可以通过以下链接获得: https://github.com/flowable/flowable-engine
准备工作
pom.xml jar引入:
<dependency>
<groupId>org.flowable</groupId>
<artifactId>flowable-spring-boot-starter</artifactId>
<version>${flowable.version}</version>
</dependency>
项目要点
1.application.yml配置 添加以下属性
flowable:
#关闭定时任务JOB
async-executor-activate: false
# 将databaseSchemaUpdate设置为true。当Flowable发现库与数据库表结构不一致时,会自动将数据库表结构升级至新版本。
database-schema-update: true
2.创建OrderApproval.bpmn20.xml文件。( 之前使用activiti的时候eclipse集成的Activiti Diagram工具挺好用的,idea对bpmn画图工具集成不是很友好,activiti中也有自己的BPMN可视化工具,也还算友好)
将其放于项目中的resource目录下的processe,当此框架启动的时候它会默认加载resource目录下的processes时就可以将此流程配置加载到数据库进行持久化。
<?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:flowable="http://flowable.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" typeLanguage="http://www.w3.org/2001/XMLSchema" expressionLanguage="http://www.w3.org/1999/XPath" targetNamespace="http://www.flowable.org/processdef">
<process id="OrderApproval" name="OrderApproval" isExecutable="true">
<startEvent id="startEvent" name="成功提交采购订单审批"></startEvent>
<sequenceFlow id="sequenceFlow-31f46bc9-22c4-460f-b2a5-1426bb106d31" sourceRef="startEvent" targetRef="approveTask"></sequenceFlow>
<userTask id="approveTask" name="Order approval" flowable:assignee="${userId}"></userTask>
<exclusiveGateway id="decision"></exclusiveGateway>
<sequenceFlow id="sequenceFlow-90e6eadb-3a9e-4955-bad4-ec337a360fac" sourceRef="decision" targetRef="false">
<conditionExpression xsi:type="tFormalExpression"><![CDATA[${!approved}]]></conditionExpression>
</sequenceFlow>
<serviceTask id="success" name="success" flowable:class="com.honghh.bootfirst.delegate.ReviewApprove"></serviceTask>
<endEvent id="approveEnd"></endEvent>
<endEvent id="rejectEnd"></endEvent>
<sequenceFlow id="sequenceFlow-e94e21dd-7d79-4f42-9f59-6c21baa8ce29" sourceRef="success" targetRef="approveEnd"></sequenceFlow>
<sequenceFlow id="sequenceFlow-195d996c-ccbe-4834-881f-bafaf1393643" sourceRef="false" targetRef="rejectEnd"></sequenceFlow>
<serviceTask id="false" name="false" flowable:class="com.honghh.bootfirst.delegate.ReviewNoApprove"></serviceTask>
<sequenceFlow id="sequenceFlow-5587fdbe-fb00-420d-9711-1b1a81c086db" sourceRef="approveTask" targetRef="decision"></sequenceFlow>
<sequenceFlow id="sequenceFlow-c1d4f277-e5a7-492a-9768-a9161f18c116" sourceRef="decision" targetRef="success">
<conditionExpression xsi:type="tFormalExpression"><![CDATA[${approved}]]></conditionExpression>
</sequenceFlow>
</process>
<bpmndi:BPMNDiagram id="BPMNDiagram_OrderApproval">
<bpmndi:BPMNPlane bpmnElement="OrderApproval" id="BPMNPlane_OrderApproval">
<bpmndi:BPMNShape bpmnElement="startEvent" id="BPMNShape_startEvent">
<omgdc:Bounds height="30.0" width="30.0" x="0.0" y="95.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="approveTask" id="BPMNShape_approveTask">
<omgdc:Bounds height="60.0" width="100.0" x="75.0" y="75.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="decision" id="BPMNShape_decision">
<omgdc:Bounds height="40.0" width="40.0" x="230.0" y="90.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="success" id="BPMNShape_success">
<omgdc:Bounds height="60.0" width="100.0" x="320.0" y="0.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="approveEnd" id="BPMNShape_approveEnd">
<omgdc:Bounds height="28.0" width="28.0" x="620.0" y="16.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="rejectEnd" id="BPMNShape_rejectEnd">
<omgdc:Bounds height="28.0" width="28.0" x="570.0" y="175.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="false" id="BPMNShape_false">
<omgdc:Bounds height="60.0" width="100.0" x="315.0" y="150.0"></omgdc:Bounds>
</bpmndi:BPMNShape>
<bpmndi:BPMNEdge bpmnElement="sequenceFlow-5587fdbe-fb00-420d-9711-1b1a81c086db" id="BPMNEdge_sequenceFlow-5587fdbe-fb00-420d-9711-1b1a81c086db">
<omgdi:waypoint x="174.95" y="105.0"></omgdi:waypoint>
<omgdi:waypoint x="202.5" y="105.0"></omgdi:waypoint>
<omgdi:waypoint x="202.5" y="110.0"></omgdi:waypoint>
<omgdi:waypoint x="230.0" y="110.0"></omgdi:waypoint>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="sequenceFlow-c1d4f277-e5a7-492a-9768-a9161f18c116" id="BPMNEdge_sequenceFlow-c1d4f277-e5a7-492a-9768-a9161f18c116">
<omgdi:waypoint x="269.9189252336448" y="110.0"></omgdi:waypoint>
<omgdi:waypoint x="282.0" y="110.0"></omgdi:waypoint>
<omgdi:waypoint x="282.0" y="30.000000000000004"></omgdi:waypoint>
<omgdi:waypoint x="319.999999999994" y="30.0"></omgdi:waypoint>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="sequenceFlow-195d996c-ccbe-4834-881f-bafaf1393643" id="BPMNEdge_sequenceFlow-195d996c-ccbe-4834-881f-bafaf1393643">
<omgdi:waypoint x="414.95000000000005" y="180.0"></omgdi:waypoint>
<omgdi:waypoint x="460.0" y="180.0"></omgdi:waypoint>
<omgdi:waypoint x="460.0" y="189.0"></omgdi:waypoint>
<omgdi:waypoint x="570.0" y="189.0"></omgdi:waypoint>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="sequenceFlow-e94e21dd-7d79-4f42-9f59-6c21baa8ce29" id="BPMNEdge_sequenceFlow-e94e21dd-7d79-4f42-9f59-6c21baa8ce29">
<omgdi:waypoint x="419.94999999998697" y="30.0"></omgdi:waypoint>
<omgdi:waypoint x="620.0" y="30.0"></omgdi:waypoint>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="sequenceFlow-31f46bc9-22c4-460f-b2a5-1426bb106d31" id="BPMNEdge_sequenceFlow-31f46bc9-22c4-460f-b2a5-1426bb106d31">
<omgdi:waypoint x="29.949987029268733" y="110.0"></omgdi:waypoint>
<omgdi:waypoint x="52.5" y="110.0"></omgdi:waypoint>
<omgdi:waypoint x="52.5" y="105.0"></omgdi:waypoint>
<omgdi:waypoint x="74.99999999999241" y="105.0"></omgdi:waypoint>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="sequenceFlow-90e6eadb-3a9e-4955-bad4-ec337a360fac" id="BPMNEdge_sequenceFlow-90e6eadb-3a9e-4955-bad4-ec337a360fac">
<omgdi:waypoint x="269.9189252336448" y="110.0"></omgdi:waypoint>
<omgdi:waypoint x="282.0" y="110.0"></omgdi:waypoint>
<omgdi:waypoint x="282.0" y="180.0"></omgdi:waypoint>
<omgdi:waypoint x="314.9999999999916" y="180.0"></omgdi:waypoint>
</bpmndi:BPMNEdge>
</bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
</definitions>
3.创建FlowableController类
package com.honghh.bootfirst.controller;
import com.honghh.bootfirst.utils.R;
import org.flowable.bpmn.model.BpmnModel;
import org.flowable.engine.*;
import org.flowable.engine.runtime.Execution;
import org.flowable.engine.runtime.ProcessInstance;
import org.flowable.image.ProcessDiagramGenerator;
import org.flowable.task.api.Task;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* ClassName: FlowableController
* Description:
*
* @author honghh
* @date 2019/02/20 18:12
*/
@RestController
@RequestMapping("/flowable")
public class FlowableController {
@Autowired
private RepositoryService repositoryService;
@Autowired
private RuntimeService runtimeService;
@Autowired
private TaskService taskService;
@Autowired
private HistoryService historyService;
@Autowired
private ProcessEngine processEngine;
/**
* .提交采购订单的审批请求
*
* @param userId 用户id
*/
@PostMapping("/start/{userId}/{purchaseOrderId}")
public R startFlow(@PathVariable String userId, @PathVariable String purchaseOrderId) {
HashMap<String, Object> map = new HashMap<>();
map.put("userId", userId);
map.put("purchaseOrderId", purchaseOrderId);
ProcessInstance processInstance =
runtimeService.startProcessInstanceByKey("OrderApproval", map);
String processId = processInstance.getId();
String name = processInstance.getName();
System.out.println(processId + ":" + name);
return R.ok(processId + ":" + name);
}
/**
* .获取用户的任务
*
* @param userId 用户id
*/
@GetMapping("/getTasks/{userId}")
public R getTasks(@PathVariable String userId) {
List<Task> tasks = taskService.createTaskQuery().taskAssignee(userId).orderByTaskCreateTime().desc().list();
return R.ok(tasks.toString());
}
/**
* .审批通过
*/
@PostMapping("/success/{taskId}")
public R success(@PathVariable String taskId) {
Task task = taskService.createTaskQuery().taskId(taskId).singleResult();
if (task == null) {
return R.error("流程不存在");
}
//通过审核
HashMap<String, Object> map = new HashMap<>();
map.put("approved", true);
taskService.complete(taskId, map);
return R.ok("流程审核通过!");
}
/**
* .审批不通过
*/
@PostMapping("/faile/{taskId}")
public R faile(@PathVariable String taskId) {
Task task = taskService.createTaskQuery().taskId(taskId).singleResult();
if (task == null) {
return R.error("流程不存在");
}
//通过审核
HashMap<String, Object> map = new HashMap<>();
map.put("approved", false);
taskService.complete(taskId, map);
return R.ok();
}
@RequestMapping(value = "processDiagram")
public void genProcessDiagram(HttpServletResponse httpServletResponse, String processId) throws Exception {
ProcessInstance pi = runtimeService.createProcessInstanceQuery().processInstanceId(processId).singleResult();
//流程走完的不显示图
if (pi == null) {
return;
}
Task task = taskService.createTaskQuery().processInstanceId(pi.getId()).singleResult();
//使用流程实例ID,查询正在执行的执行对象表,返回流程实例对象
String InstanceId = task.getProcessInstanceId();
List<Execution> executions = runtimeService
.createExecutionQuery()
.processInstanceId(InstanceId)
.list();
//得到正在执行的Activity的Id
List<String> activityIds = new ArrayList<>();
List<String> flows = new ArrayList<>();
for (Execution exe : executions) {
List<String> ids = runtimeService.getActiveActivityIds(exe.getId());
activityIds.addAll(ids);
}
//获取流程图
BpmnModel bpmnModel = repositoryService.getBpmnModel(pi.getProcessDefinitionId());
ProcessEngineConfiguration engconf = processEngine.getProcessEngineConfiguration();
ProcessDiagramGenerator diagramGenerator = engconf.getProcessDiagramGenerator();
InputStream in = diagramGenerator.generateDiagram(bpmnModel, "png", activityIds, flows, engconf.getActivityFontName(), engconf.getLabelFontName(), engconf.getAnnotationFontName(), engconf.getClassLoader(), 1.0);
OutputStream out = null;
byte[] buf = new byte[1024];
int legth = 0;
try {
out = httpServletResponse.getOutputStream();
while ((legth = in.read(buf)) != -1) {
out.write(buf, 0, legth);
}
} finally {
if (in != null) {
in.close();
}
if (out != null) {
out.close();
}
}
}
}
4.配置FlowableConfig 为防止生成的流程图中中文乱码
package com.honghh.bootfirst.config;
import org.flowable.spring.SpringProcessEngineConfiguration;
import org.flowable.spring.boot.EngineConfigurationConfigurer;
import org.springframework.context.annotation.Configuration;
/**
* ClassName: FlowableConfig
* Description:
*
* @author honghh
* @date 2019/02/20 18:43
*/
@Configuration
public class FlowableConfig implements EngineConfigurationConfigurer<SpringProcessEngineConfiguration> {
@Override
public void configure(SpringProcessEngineConfiguration engineConfiguration) {
engineConfiguration.setActivityFontName("宋体");
engineConfiguration.setLabelFontName("宋体");
engineConfiguration.setAnnotationFontName("宋体");
}
}
演示效果
1.提交采购订单的审批请求
http://localhost:8080/flowable/start/1/1
2.获取用户的任务
http://localhost:8080/flowable/getTasks/1
3.审批通过 http://localhost:8080/flowable/success/11
4.生成当前流程图表 http://localhost:8080/flowable/processDiagram?processId=5
代码获取
https://gitee.com/honghh/boot-demo.git
参考文献
Flowable BPMN 用户手册 (v 6.3.0)
https://tkjohn.github.io/flowable-userguide/
采用springboot+flowable快速实现工作流
https://blog.csdn.net/puhaiyang/article/details/79845248
Activiti学习文档(三)之画流程图并部署流程
https://blog.csdn.net/samile6899/article/details/52578347