SpringBoot整合flowable及其简单的使用实例教程_Java

1. 什么是flowable？

flowable是一个使用java编写的开源轻量级业务流程引擎，基于apache 2.0协议，支持bpmn 2.0规范。它提供了从流程建模、执行到监控的全生命周期管理能力，能够处理流程流转相关的业务，如审批流、工作流等。flowable由activiti项目发展而来，在保持原有功能的基础上进行了优化和扩展。

核心功能

流程定义与部署：支持bpmn 2.0流程定义的部署，可创建流程实例，进行查询以及访问运行中或历史的流程实例与相关数据。
任务管理：提供任务管理功能，允许用户查询、处理和完成任务，任务可以是人工任务或系统任务。
事件处理：支持事件处理机制，允许在流程执行过程中触发和监听各种事件，如开始事件、结束事件等。
表单管理：可与表单设计器配合使用，在流程中定义动态表单，并挂载表单数据。
实时监控与报告：提供丰富的监控功能，允许用户实时查看流程实例的执行状态、任务执行情况等。

核心组件

flowable idm：身份管理应用，提供单点登录认证功能，管理用户、组与权限。
flowable modeler：用于创建流程模型、表单、选择表与应用定义。
flowable task：运行时任务应用，提供启动流程实例、编辑任务表单等功能。
flowable admin：管理应用，查询bpmn、dmn等引擎，并提供修改流程实例等功能。
api服务：通过processengine与flowable交互，提供工作流/bpm方法。

使用场景

审批流程：如请假申请、报销审批等，可设计流程、部署定义、启动实例、处理任务。
工作流管理：适用于复杂多变的业务场景，根据业务流程建模，处理任务。
企业数字化转型：作为企业实现数字化转型的重要工具，提高业务处理的效率和灵活性。

特点

轻量级：以jar形式发布，可轻易加入任何java环境。
高性能：专注于提供高性能的业务流程管理解决方案。
灵活性：能够灵活地嵌入到各种应用和服务中。
扩展性：支持nosql、ldap等，具有良好的扩展性。

2. flowable的重要实现类

流程引擎相关

processengine：flowable的核心组件，负责解析bpmn 2.0流程定义文件，并执行其中的流程实例。它提供了丰富的api，方便开发者对流程实例进行各种操作，如启动、挂起、恢复、终止等。
processengineconfiguration：用于配置和初始化流程引擎，可以设置数据库连接、事务管理器、监听器等信息。
runtimeservice：提供运行时流程实例和执行的相关操作，如启动流程实例、查询运行时流程实例、获取流程变量等。
taskservice：与任务相关的服务类，用于管理任务的创建、分配、完成等操作。
repositoryservice：用于管理流程定义和部署，可以部署流程定义文件、查询流程定义、获取流程模型等。

事务管理相关

commandexecutorimpl：命令执行器的实现类，负责执行具体的命令。
springtransactioninterceptor：spring事务拦截器，用于处理事务的传播行为，确保流程操作在正确的事务上下文中执行。
transactioncontextinterceptor：事务上下文拦截器，用于管理事务上下文中的命令执行。

监听器相关

tasklistener：任务监听器接口，用于在任务的生命周期中监听特定事件，如任务创建、分配、完成等。
executionlistener：执行监听器接口，用于在流程执行的生命周期中监听特定事件。

流程图生成相关

processdiagramgenerator：流程图生成器，用于根据bpmn模型生成流程图。

身份管理相关

flowable idm：身份管理应用，为所有flowable ui应用提供单点登录认证功能，并且为拥有idm管理员权限的用户提供了管理用户、组与权限的功能。

建模与任务相关

flowable modeler：基于web的建模工具，可用于创建分别符合bpmn 2.0、cmmn和dmn规范的业务流程。
flowable task：运行时任务应用，提供了启动流程实例、编辑任务表单、完成任务，以及查询流程实例与任务的功能。

管理与监控相关

flowable admin：管理应用，让具有管理员权限的用户可以查询bpmn、dmn、form及content引擎，并提供了许多选项用于修改流程实例、任务、作业等。

3. springboot整合flowable

maven导入flowable

maven中引入flowable-spring-boot-starter的相关依赖，我导入的是6.6.0版本，然后再导入数据库相关依赖（flowable需要配合数据库使用，且支持多种数据库，我这里使用mysql8.0为例）

        <dependency>
            <groupid>org.flowable</groupid>
            <artifactid>flowable-spring-boot-starter</artifactid>
            <version>6.6.0</version>
        </dependency>
        <dependency>
            <groupid>mysql</groupid>
            <artifactid>mysql-connector-java</artifactid>
            <version>8.0.33</version>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-web</artifactid>
        </dependency>

制作流程图

在idea中安装bpmn流程图的制作工具 flowable bpmn visualizer

我这以intellij idea 2024.3.1.1 (ultimate edition)为例

左上角四横线图片--file--setting--plugins--installed，搜索 flowable bpmn visualizer后点击安装

在resource目录下新建processes文件夹（flowable默认读这个文件夹下的流程图），新建文件xxx.bpmn20.xml(流程图文件名必须以.bpmn20.xml或者bpmn结尾)，右键文件选择view bpmn

打开bpmn编辑页面就可以制作自己想要的流程图。

为了测试flowable我这里提供了一个简单的流程图

<?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">
  <!-- id为流程图名称要遵循xml的cname的起名规则  name为流程图中文名称 -->
  <process id="leave_flow" name="请假流程" isexecutable="true">
    <startevent id="startevent1"/>
    <!-- flowable:assignee="${usertask}"表示的意思是从哪个字段中获取申请人的名称   -->
    <usertask id="applyperson" name="申请人" flowable:assignee="${usertask}">
      <extensionelements>
        <modeler:initiator-can-complete xmlns:modeler="http://flowable.org/modeler"><![cdata[false]]></modeler:initiator-can-complete>
      </extensionelements>
    </usertask>
    <sequenceflow id="sid-78321d10-b222-41f2-a655-2550b97688e0" sourceref="startevent1" targetref="applyperson"/>
    <usertask id="manager" name="经理">
      <extensionelements>
        <!--  这是流程监听器所指定的审批人，class要指定监听      -->
        <flowable:tasklistener event="create" class="com.sd.tasklistener.managertasklistener"/>
      </extensionelements>
    </usertask>
    <sequenceflow id="sid-25a43afd-67c2-41f7-87df-25826aa220f8" sourceref="applyperson" targetref="manager"/>
    <usertask id="boss" name="老板">
      <extensionelements>
        <!--  这是流程监听器所指定的审批人，class要指定监听      -->
        <flowable:tasklistener event="create" class="com.sd.tasklistener.bosstasklistener"/>
      </extensionelements>
    </usertask>
    <endevent id="sid-27ae7469-ec65-4ef0-b85e-3a658bd85ee3"/>
    <!--  这里表示指定两个流程监听器的处理动作，同意/驳回  -->
    <sequenceflow id="refuse" name="驳回" sourceref="manager" targetref="applyperson">
      <conditionexpression xsi:type="tformalexpression"><![cdata[${result == "驳回"}]]></conditionexpression>
    </sequenceflow>
    <sequenceflow id="pass" name="通过" sourceref="manager" targetref="boss">
      <conditionexpression xsi:type="tformalexpression"><![cdata[${result == "同意"}]]></conditionexpression>
    </sequenceflow>
    <sequenceflow id="refuse2" name="驳回" sourceref="boss" targetref="applyperson">
      <conditionexpression xsi:type="tformalexpression"><![cdata[${result == "驳回"}]]></conditionexpression>
    </sequenceflow>
    <sequenceflow id="pass2" name="通过" sourceref="boss" targetref="sid-27ae7469-ec65-4ef0-b85e-3a658bd85ee3">
      <conditionexpression xsi:type="tformalexpression"><![cdata[${result == "同意"}]]></conditionexpression>
    </sequenceflow>
  </process>
  <bpmndi:bpmndiagram id="bpmndiagram_leave_flow">
    <bpmndi:bpmnplane bpmnelement="leave_flow" id="bpmnplane_leave_flow">
      <bpmndi:bpmnshape bpmnelement="startevent1" id="bpmnshape_startevent1">
        <omgdc:bounds height="30.0" width="30.0" x="100.0" y="163.0"/>
      </bpmndi:bpmnshape>
      <bpmndi:bpmnshape bpmnelement="applyperson" id="bpmnshape_applyperson">
        <omgdc:bounds height="80.0" width="100.0" x="175.0" y="138.0"/>
      </bpmndi:bpmnshape>
      <bpmndi:bpmnshape bpmnelement="manager" id="bpmnshape_manager">
        <omgdc:bounds height="80.0" width="100.0" x="345.0" y="138.0"/>
      </bpmndi:bpmnshape>
      <bpmndi:bpmnshape bpmnelement="boss" id="bpmnshape_boss">
        <omgdc:bounds height="80.0" width="100.0" x="510.0" y="138.0"/>
      </bpmndi:bpmnshape>
      <bpmndi:bpmnshape bpmnelement="sid-27ae7469-ec65-4ef0-b85e-3a658bd85ee3" id="bpmnshape_sid-27ae7469-ec65-4ef0-b85e-3a658bd85ee3">
        <omgdc:bounds height="28.0" width="28.0" x="735.0" y="164.0"/>
      </bpmndi:bpmnshape>
      <bpmndi:bpmnedge bpmnelement="refuse" id="bpmnedge_refuse">
        <omgdi:waypoint x="395.0" y="217.95000000000002"/>
        <omgdi:waypoint x="395.0" y="291.0"/>
        <omgdi:waypoint x="225.0" y="291.0"/>
        <omgdi:waypoint x="225.0" y="217.95"/>
      </bpmndi:bpmnedge>
      <bpmndi:bpmnedge bpmnelement="pass" id="bpmnedge_pass">
        <omgdi:waypoint x="444.9499999998897" y="178.0"/>
        <omgdi:waypoint x="509.99999999998465" y="178.0"/>
      </bpmndi:bpmnedge>
      <bpmndi:bpmnedge bpmnelement="pass2" id="bpmnedge_pass2">
        <omgdi:waypoint x="609.9499999999675" y="178.0"/>
        <omgdi:waypoint x="735.0" y="178.0"/>
      </bpmndi:bpmnedge>
      <bpmndi:bpmnedge bpmnelement="refuse2" id="bpmnedge_refuse2">
        <omgdi:waypoint x="560.0" y="138.0"/>
        <omgdi:waypoint x="560.0" y="76.0"/>
        <omgdi:waypoint x="225.0" y="76.0"/>
        <omgdi:waypoint x="225.0" y="138.0"/>
      </bpmndi:bpmnedge>
      <bpmndi:bpmnedge bpmnelement="sid-78321d10-b222-41f2-a655-2550b97688e0" id="bpmnedge_sid-78321d10-b222-41f2-a655-2550b97688e0">
        <omgdi:waypoint x="129.9499984899576" y="178.0"/>
        <omgdi:waypoint x="175.0" y="178.0"/>
      </bpmndi:bpmnedge>
      <bpmndi:bpmnedge bpmnelement="sid-25a43afd-67c2-41f7-87df-25826aa220f8" id="bpmnedge_sid-25a43afd-67c2-41f7-87df-25826aa220f8">
        <omgdi:waypoint x="274.95" y="178.0"/>
        <omgdi:waypoint x="344.99999999993565" y="178.0"/>
      </bpmndi:bpmnedge>
    </bpmndi:bpmnplane>
  </bpmndi:bpmndiagram>
</definitions>

查看流程图

设置springboot相关配置

spring:
  application:
    name: springboot-flowable
  datasource:
    driver-class-name: com.mysql.cj.jdbc.driver
    url: jdbc:mysql://localhost:3306/flowable_test?usessl=false&useunicode=true&characterencoding=utf-8&servertimezone=gmt%2b8&nullcatalogmeanscurrent=true
    username: root
    password: 123456
server:
  port: 3333
flowable:
  #关闭定时任务job
  async-executor-activate: false
  #对数据库表进行操作，如果表不存在则会新建
  database-schema-update: true

配置flowable相关配置

防止流程图中文乱码配置

@configuration
public class flowableconfig implements engineconfigurationconfigurer<springprocessengineconfiguration> {
    @override
    public void configure(springprocessengineconfiguration springprocessengineconfiguration) {
        springprocessengineconfiguration.setactivityfontname("宋体");
        springprocessengineconfiguration.setlabelfontname("宋体");
        springprocessengineconfiguration.setannotationfontname("宋体");
    }
}

配置流程监听器

经理监听器

public class managertasklistener implements tasklistener {
    @override
    public void notify(delegatetask delegatetask) {
        delegatetask.setassignee("经理");
        system.out.println("经理收到了流程");
    }
}

配置老板监听器

public class bosstasklistener implements tasklistener {
    @override
    public void notify(delegatetask delegatetask) {
        delegatetask.setassignee("老板");
        system.out.println("老板收到了流程");
    }
}

编写flowable相关操作

我这里演示发起流程，查看流程，获取审批流程，审批同意，驳回以及查看流程图

其他操作跟这些都大差不大，可自行扩展

package com.sd.controller;
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.ioexception;
import java.io.inputstream;
import java.io.outputstream;
import java.util.*;
/**
 * @author sd
 * @create 2025-06-17-下午 4:06
 */
@restcontroller
@requestmapping("/flowable")
public class flowablecontroller {
    @autowired
    private runtimeservice runtimeservice;
    @autowired
    private taskservice taskservice;
    @autowired
    private repositoryservice repositoryservice;
    @autowired
    private processengine processengine;
    /**
     * 发起请假
     *
     * @param userid    用户id
     * @param days     请假天数
     * @param desc 描述
     */
    @getmapping(value = "/add")
    public string addexpense(string userid,integer days,string desc) {
        //设置流程参数,用户名等等
        hashmap<string, object> map = new hashmap<>();
        map.put("usertask", userid);
        map.put("days", days);
        map.put("desc", desc);
        //启动一个流程
        processinstance processinstance = runtimeservice.startprocessinstancebykey("leave_flow", map);
        //生成一个任务
        task task = taskservice.createtaskquery().processinstanceid(processinstance.getid()).singleresult();
        //第一步任务流程完成后，会按照流程图自动分配给下一个流程
        taskservice.complete(task.getid());
        return "提交成功\n流程id为：" + processinstance.getid()
                + "\n任务id: " + task.getid()
                + "\n请假人为：" +userid
                + "\n请假天数为：" + days
                + "\n描述为：" + desc;
    }
    /**
     * 查询请假流程
     *
     * @param userid 查询人
     *
     * */
    @getmapping("findtask")
    public string findtask(string userid) {
        //从引擎中获取任务
        taskservice taskservice = processengine.gettaskservice();
        task task = taskservice.createtaskquery().taskassignee(userid).singleresult();
        return userid + "的任务id："+task.getid();
    }
    /**
     * 获取审批管理列表
     *
     * @param userid 查询人
     *
     */
    @getmapping(value = "/list")
    public map<string,string> list(string userid) {
        map<string,string> result = new hashmap<>();
        list<task> tasks = taskservice.createtaskquery().taskassignee(userid).orderbytaskcreatetime().desc().list();
        for (task task : tasks) {
            result.put(task.getname(),task.getid());
        }
        return result;
    }
    /**
     * 批准
     *
     * @param taskid 任务id
     */
    @getmapping(value = "apply")
    public string apply(string taskid) {
        //获得任务
        task task = taskservice.createtaskquery().taskid(taskid).singleresult();
        if (task == null) {
            throw new runtimeexception("流程不存在");
        }
        //通过审核
        hashmap<string, object> map = new hashmap<>();
        map.put("result", "同意");
        taskservice.complete(taskid, map);
        return  "任务id：" + taskid + "---批准!";
    }
    /**
     * 驳回
     */
    @getmapping(value = "reject")
    public string reject(string taskid) {
        //获得任务
        task task = taskservice.createtaskquery().taskid(taskid).singleresult();
        if (task == null) {
            throw new runtimeexception("流程不存在");
        }
        hashmap<string, object> map = new hashmap<>();
        map.put("result", "驳回");
        taskservice.complete(taskid, map);
        return  "任务id：" + taskid + "---驳回!";
    }
    /**
     * 生成流程图
     *
     * @param taskid 任务id
     */
    @getmapping(value = "processdiagram")
    public void genprocessdiagram(httpservletresponse httpservletresponse, string taskid) throws exception {
        processinstance pi = runtimeservice.createprocessinstancequery().processinstanceid(taskid).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();
        //得到正在执行的flowable的id
        list<string> flowableids = new arraylist<>();
        list<string> flows = new arraylist<>();
        for (execution exe : executions) {
            list<string> ids = runtimeservice.getactiveactivityids(exe.getid());
            flowableids.addall(ids);
        }
        //获取流程图
        bpmnmodel bpmnmodel = repositoryservice.getbpmnmodel(pi.getprocessdefinitionid());
        processengineconfiguration engconf = processengine.getprocessengineconfiguration();
        processdiagramgenerator diagramgenerator = engconf.getprocessdiagramgenerator();
        inputstream in = diagramgenerator.generatediagram(bpmnmodel, "png", flowableids, collections.emptylist(), engconf.getactivityfontname(), engconf.getlabelfontname(), engconf.getannotationfontname(), null, 1.0, false);
        outputstream out = null;
        byte[] buf = new byte[10240];
        int legth = 0;
        try {
            httpservletresponse.setcontenttype("image/png"); // 设置响应类型为图片
            out = httpservletresponse.getoutputstream();
            while ((legth = in.read(buf)) != -1) {
                out.write(buf, 0, legth);
            }
        } catch (ioexception e) {
            system.out.println("生成流程图失败");
            throw new runtimeexception(e);
        } finally {
            if (in != null) {
                in.close();
            }
            if (out != null) {
                out.close();
            }
        }
    }
}