spring boot集成flowable工作流带源码

偏执的太偏执、 2022-03-16 08:56 319阅读 0赞

flowable工作流的介绍参考[官方用户手册][Link 1]。

以下直接介绍“出差报销”实例依赖的步骤，源码地址：[码云仓库][Link 2] [https://gitee.com/acelee723/acelee-flowable][Link 2]，文章内容转载于：

[采用springboot+flowable快速实现工作流][springboot_flowable]

**1.将flowable的依赖加入到POM中即可,flowable使用需要一个数据库，这里是mysql**

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.3.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.ww</groupId>
        <artifactId>flowable</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>acelee-flowable</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
            <flowable.version>6.4.0</flowable.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.flowable</groupId>
                <artifactId>flowable-spring-boot-starter</artifactId>
                <version>${flowable.version}</version>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.45</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

** 2.添加properties配置属性MySQL**

server:
      port: 8080
    
    spring:
      datasource:
        url: jdbc:mysql://127.0.0.1:3306/jesper?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false
        username: root
        password: 12345678
        driver-class-name: com.mysql.jdbc.Driver

**3.定义流程文件**

上面已经完成了flowable与springboot的整合了，接下来就可以使用此框架进行流程需要开发了！flowable建议采用业界标准BPMN2.0的XML来描述需要定义的工作流。通常都是通过专门的流程建模工具来画出来的，可以用Eclipse里的流程插件来画。同时Flowable也提供了对应的web管理台可以对流程文件进行创建。详见： **[Flowable UI applications][]**

为了方便，也可以去掉这两个JAVA类，将其对应的task改写为如下的形式：

尽管上面的BPMN文件很长，但放心，毕竟那是通过相关的工具生成出来的，对于核心的逻辑部分也很少（主要在process 标签内） ，如需要详细了解的可自行学习下BPMN的标签即可！当然，在flowable的使用文档中也有相关的描述,详见：[Creating a ProcessEngine][]

如上定义好一个流程文件后，将其命令为ExpenseProcess.bpmn20.xml并将其放于项目中的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: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="Expense" name="ExpenseProcess" isExecutable="true">
            <documentation>报销流程</documentation>
            <startEvent id="start" name="开始"></startEvent>
            <userTask id="fillTask" name="出差报销" flowable:assignee="${taskUser}">
                <extensionElements>
                    <modeler:initiator-can-complete xmlns:modeler="http://flowable.org/modeler">
                        <![CDATA[false]]></modeler:initiator-can-complete>
                </extensionElements>
            </userTask>
            <exclusiveGateway id="judgeTask"></exclusiveGateway>
            <userTask id="directorTak" name="经理审批" flowable:assignee="经理"/>
            <userTask id="bossTask" name="老板审批" flowable:assignee="老板"/>
            
    
            <endEvent id="end" name="结束"></endEvent>
            <sequenceFlow id="directorNotPassFlow" name="驳回" sourceRef="directorTak" targetRef="fillTask">
                <conditionExpression xsi:type="tFormalExpression"><![CDATA[${outcome=='驳回'}]]></conditionExpression>
            </sequenceFlow>
            <sequenceFlow id="bossNotPassFlow" name="驳回" sourceRef="bossTask" targetRef="fillTask">
                <conditionExpression xsi:type="tFormalExpression"><![CDATA[${outcome=='驳回'}]]></conditionExpression>
            </sequenceFlow>
            <sequenceFlow id="flow1" sourceRef="start" targetRef="fillTask"></sequenceFlow>
            <sequenceFlow id="flow2" sourceRef="fillTask" targetRef="judgeTask"></sequenceFlow>
            <sequenceFlow id="judgeMore" name="大于500元" sourceRef="judgeTask" targetRef="bossTask">
                <conditionExpression xsi:type="tFormalExpression"><![CDATA[${money > 500}]]></conditionExpression>
            </sequenceFlow>
            <sequenceFlow id="bossPassFlow" name="通过" sourceRef="bossTask" targetRef="end">
                <conditionExpression xsi:type="tFormalExpression"><![CDATA[${outcome=='通过'}]]></conditionExpression>
            </sequenceFlow>
            <sequenceFlow id="directorPassFlow" name="通过" sourceRef="directorTak" targetRef="end">
                <conditionExpression xsi:type="tFormalExpression"><![CDATA[${outcome=='通过'}]]></conditionExpression>
            </sequenceFlow>
            <sequenceFlow id="judgeLess" name="小于500元" sourceRef="judgeTask" targetRef="directorTak">
                <conditionExpression xsi:type="tFormalExpression"><![CDATA[${money <= 500}]]></conditionExpression>
            </sequenceFlow>
        </process>
        <bpmndi:BPMNDiagram id="BPMNDiagram_Expense">
            <bpmndi:BPMNPlane bpmnElement="Expense" id="BPMNPlane_Expense">
                <bpmndi:BPMNShape bpmnElement="start" id="BPMNShape_start">
                    <omgdc:Bounds height="30.0" width="30.0" x="285.0" y="135.0"></omgdc:Bounds>
                </bpmndi:BPMNShape>
                <bpmndi:BPMNShape bpmnElement="fillTask" id="BPMNShape_fillTask">
                    <omgdc:Bounds height="80.0" width="100.0" x="405.0" y="110.0"></omgdc:Bounds>
                </bpmndi:BPMNShape>
                <bpmndi:BPMNShape bpmnElement="judgeTask" id="BPMNShape_judgeTask">
                    <omgdc:Bounds height="40.0" width="40.0" x="585.0" y="130.0"></omgdc:Bounds>
                </bpmndi:BPMNShape>
                <bpmndi:BPMNShape bpmnElement="directorTak" id="BPMNShape_directorTak">
                    <omgdc:Bounds height="80.0" width="100.0" x="735.0" y="110.0"></omgdc:Bounds>
                </bpmndi:BPMNShape>
                <bpmndi:BPMNShape bpmnElement="bossTask" id="BPMNShape_bossTask">
                    <omgdc:Bounds height="80.0" width="100.0" x="555.0" y="255.0"></omgdc:Bounds>
                </bpmndi:BPMNShape>
                <bpmndi:BPMNShape bpmnElement="end" id="BPMNShape_end">
                    <omgdc:Bounds height="28.0" width="28.0" x="771.0" y="281.0"></omgdc:Bounds>
                </bpmndi:BPMNShape>
                <bpmndi:BPMNEdge bpmnElement="flow1" id="BPMNEdge_flow1">
                    <omgdi:waypoint x="315.0" y="150.0"></omgdi:waypoint>
                    <omgdi:waypoint x="405.0" y="150.0"></omgdi:waypoint>
                </bpmndi:BPMNEdge>
                <bpmndi:BPMNEdge bpmnElement="flow2" id="BPMNEdge_flow2">
                    <omgdi:waypoint x="505.0" y="150.16611295681062"></omgdi:waypoint>
                    <omgdi:waypoint x="585.4333333333333" y="150.43333333333334"></omgdi:waypoint>
                </bpmndi:BPMNEdge>
                <bpmndi:BPMNEdge bpmnElement="judgeLess" id="BPMNEdge_judgeLess">
                    <omgdi:waypoint x="624.5530726256983" y="150.44692737430168"></omgdi:waypoint>
                    <omgdi:waypoint x="735.0" y="150.1392757660167"></omgdi:waypoint>
                </bpmndi:BPMNEdge>
                <bpmndi:BPMNEdge bpmnElement="directorNotPassFlow" id="BPMNEdge_directorNotPassFlow">
                    <omgdi:waypoint x="785.0" y="110.0"></omgdi:waypoint>
                    <omgdi:waypoint x="785.0" y="37.0"></omgdi:waypoint>
                    <omgdi:waypoint x="455.0" y="37.0"></omgdi:waypoint>
                    <omgdi:waypoint x="455.0" y="110.0"></omgdi:waypoint>
                </bpmndi:BPMNEdge>
                <bpmndi:BPMNEdge bpmnElement="bossPassFlow" id="BPMNEdge_bossPassFlow">
                    <omgdi:waypoint x="655.0" y="295.0"></omgdi:waypoint>
                    <omgdi:waypoint x="771.0" y="295.0"></omgdi:waypoint>
                </bpmndi:BPMNEdge>
                <bpmndi:BPMNEdge bpmnElement="judgeMore" id="BPMNEdge_judgeMore">
                    <omgdi:waypoint x="605.4340277777778" y="169.56597222222223"></omgdi:waypoint>
                    <omgdi:waypoint x="605.1384083044983" y="255.0"></omgdi:waypoint>
                </bpmndi:BPMNEdge>
                <bpmndi:BPMNEdge bpmnElement="directorPassFlow" id="BPMNEdge_directorPassFlow">
                    <omgdi:waypoint x="785.0" y="190.0"></omgdi:waypoint>
                    <omgdi:waypoint x="785.0" y="281.0"></omgdi:waypoint>
                </bpmndi:BPMNEdge>
                <bpmndi:BPMNEdge bpmnElement="bossNotPassFlow" id="BPMNEdge_bossNotPassFlow">
                    <omgdi:waypoint x="555.0" y="295.0"></omgdi:waypoint>
                    <omgdi:waypoint x="455.0" y="295.0"></omgdi:waypoint>
                    <omgdi:waypoint x="455.0" y="190.0"></omgdi:waypoint>
                </bpmndi:BPMNEdge>
            </bpmndi:BPMNPlane>
        </bpmndi:BPMNDiagram>
    </definitions>

**其中的两个代理类为下面两个，但是按照上述配置只有打开注释里的代码需要，这里你可以不用加这两个类！**

package com.ww.flowable.listener;
    
    import org.flowable.engine.delegate.TaskListener;
    import org.flowable.task.service.delegate.DelegateTask;
    
    public class ManagerTaskHandler implements TaskListener {
    
        @Override
        public void notify(DelegateTask delegateTask) {
            delegateTask.setAssignee("经理");
        }
    
    }

package com.ww.flowable.listener;
    
    import org.flowable.engine.delegate.TaskListener;
    import org.flowable.task.service.delegate.DelegateTask;
    
    public class BossTaskHandler implements TaskListener {
    
        @Override
        public void notify(DelegateTask delegateTask) {
            delegateTask.setAssignee("老板");
        }
    
    }

**4.测试controller**  
为了方便这里通过一个controller来完成此DEMO的快速编写

package com.ww.flowable.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.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    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;
    
    @Controller
    @RequestMapping(value = "expense")
    public class ExpenseController {
        @Autowired
        private RuntimeService runtimeService;
        @Autowired
        private TaskService taskService;
        @Autowired
        private RepositoryService repositoryService;
        @Autowired
        private ProcessEngine processEngine;
    
    
        /**
         * 添加报销
         *
         * @param userId    用户Id
         * @param money     报销金额
         * @param descption 描述
         */
        @RequestMapping(value = "add")
        @ResponseBody
        public String addExpense(String userId, Integer money, String descption) {
            //启动流程
            HashMap<String, Object> map = new HashMap<>();
            map.put("taskUser", userId);
            map.put("money", money);
            ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("Expense", map);
            String msg = "提交成功.流程Id为：" + processInstance.getId();
            System.out.println(msg);
            return msg;
        }
    
    
        /**
         * 获取审批管理列表
         */
        @RequestMapping(value = "/list")
        @ResponseBody
        public Object list(String userId) {
            List<Task> tasks = taskService.createTaskQuery().taskAssignee(userId).orderByTaskCreateTime().desc().list();
            for (Task task : tasks) {
                System.out.println(task.toString());
            }
            return tasks.toArray().toString();
        }
    
        /**
         * 批准
         *
         * @param taskId 任务ID
         */
        @RequestMapping(value = "apply")
        @ResponseBody
        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("outcome", "通过");
            taskService.complete(taskId, map);
            return "processed ok!";
        }
    
    
        /**
         * 拒绝
         */
        @ResponseBody
        @RequestMapping(value = "reject")
        public String reject(String taskId) {
            HashMap<String, Object> map = new HashMap<>();
            map.put("outcome", "驳回");
            taskService.complete(taskId, map);
            return "reject";
        }
    
    
        /**
         * 生成流程图
         *
         * @param processId 任务ID
         */
        @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,true);
            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();
                }
            }
        }
    
    
    }

写一个controller，并注入由flowable框架启动时自动注册的几个bean，下面的功能将会用到！

开始流程  
    /\*\*  
     \* 添加报销  
     \*  
     \* @param userId    用户Id  
     \* @param money     报销金额  
     \* @param descption 描述  
     \*/  
    @RequestMapping(value = "add")  
    @ResponseBody  
    public String addExpense(String userId, Integer money, String descption) \{  
        //启动流程  
        HashMap<String, Object> map = new HashMap<>();  
        map.put("taskUser", userId);  
        map.put("money", money);  
        ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("Expense", map);  
        return "提交成功.流程Id为：" + processInstance.getId();  
    \}  
上面的代码通过接收用户的一个请求传入用户的ID和金额以及描述信息来开启一个报销流程，并返回给用户这个流程的Id

查询流程列表，待办列表  
    /\*\*  
     \* 获取审批管理列表  
     \*/  
    @RequestMapping(value = "/list")  
    @ResponseBody  
    public Object list(String userId) \{  
        List<Task> tasks = taskService.createTaskQuery().taskAssignee(userId).orderByTaskCreateTime().desc().list();  
        for (Task task : tasks) \{  
            System.out.println(task.toString());  
        \}  
        return tasks.toArray().toString();  
    \}  
通过上面的代码获取出此用户需要处理的流程

批准，同意  
    /\*\*  
     \* 批准  
     \*  
     \* @param taskId 任务ID  
     \*/  
    @RequestMapping(value = "apply")  
    @ResponseBody  
    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("outcome", "通过");  
        taskService.complete(taskId, map);  
        return "processed ok!";  
    \}  
通过前端传入的任务ID来对此流程进行同意处理

拒绝，不同意  
    /\*\*  
     \* 拒绝  
     \*/  
    @ResponseBody  
    @RequestMapping(value = "reject")  
    public String reject(String taskId) \{  
        HashMap<String, Object> map = new HashMap<>();  
        map.put("outcome", "驳回");  
        taskService.complete(taskId, map);  
        return "reject";  
    \}   
生成当前流程图表  
    /\*\*  
     \* 生成流程图  
     \*  
     \* @param processId 任务ID  
     \*/  
    @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();  
            \}  
        \}  
    \}   
通过传入流程ID生成当前流程的流程图给前端,如果流程中使用到中文且生成的图片是乱码的，则需要进配置下字体：

/\*\*  
 \* @author haiyangp  
 \* date:  2018/4/7  
 \* desc: flowable配置----为放置生成的流程图中中文乱码  
 \*/  
@Configuration  
public class FlowableConfig implements EngineConfigurationConfigurer<SpringProcessEngineConfiguration> \{  
   
   
    @Override  
    public void configure(SpringProcessEngineConfiguration engineConfiguration) \{  
        engineConfiguration.setActivityFontName("宋体");  
        engineConfiguration.setLabelFontName("宋体");  
        engineConfiguration.setAnnotationFontName("宋体");  
    \}  
\}

**5.整体演示**  
上面的代码写好后就可以演示下整体流程了

1.先启动好此项目，然后创建一个流程：

访问：http://localhost:8080/expense/add?userId=123&money=123321

返回：提交成功.流程Id为：2501

2.查询待办列表:

访问：http://localhost:8080/expense/list?userId=123

输出：Task\[id=2507, name=出差报销\]

3.同意：

访问：http://localhost:8080/expense/apply?taskId=2507

返回：processed ok!

4.生成流程图：

访问：http://localhost:8080/expense/processDiagram?processId=2501

返回如下图片：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B1aGFpeWFuZw_size_16_color_FFFFFF_t_70][]

整体流程截图如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B1aGFpeWFuZw_size_16_color_FFFFFF_t_70 1][]

[Link 1]: https://tkjohn.github.io/flowable-userguide/#_introduction
[Link 2]: https://gitee.com/acelee723/acelee-flowable
[springboot_flowable]: https://blog.csdn.net/puhaiyang/article/details/79845248
[Flowable UI applications]: https://www.flowable.org/docs/userguide/index.html#flowableUIApps
[Creating a ProcessEngine]: https://www.flowable.org/docs/userguide/index.html#configuration
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B1aGFpeWFuZw_size_16_color_FFFFFF_t_70]: /images/20220316/fc5778047b0b4da285fd791c2130f950.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3B1aGFpeWFuZw_size_16_color_FFFFFF_t_70 1]: /images/20220316/7a8f11e769a949afb177fa4b1edd4d71.png