乐趣区

关于java:Spring-Boot-整合流程引擎-Flowableso-easy

jiezi

为啥想写 flowable 呢？起因很简略，因为最近在录的 tienchin 我的项目视频会用到，先写一篇文章和大家打打预防针，前面视频再细讲。

流程引擎，也算是一个比拟常见的工具了，咱们在日常的很多开发中都会用到，当然用的最多的就是 OA 零碎了，然而在一些非 OA 零碎中，咱们也会波及到，比方一个 CRM 中，可能会有合同治理的需要，合同的审批，也是须要流程引擎的。

所以明天咱们来简略聊聊流程引擎，顺便写一个简略的例子，小伙伴们一起来感触下流程引擎到底是个啥。

1. 流程引擎介绍

Flowable 是一个应用 Java 编写的轻量级业务流程引擎。Flowable 流程引擎可用于部署 BPMN2.0 流程定义（用于定义流程的行业 XML 规范），创立这些流程定义的流程实例，进行查问，拜访运行中或历史的流程实例与相干数据，等等。

Java 畛域另一个流程引擎是 Activiti，不过我感觉这两个货色，只有你会应用其中一个，另一个就不在话下。

咱就不废话了，上代码吧。

2. 创立我的项目

首先咱们创立一个 Spring Boot 我的项目，引入 Web、和 MySQL 驱动两个依赖，如下图：

我的项目创立胜利之后，咱们引入 flowable 依赖，如下：

<dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-spring-boot-starter</artifactId>
    <version>6.7.2</version>
</dependency>

这个会帮咱们做一些自动化配置，默认状况下，所以位于 resources/processes 的流程都会被主动部署。

接下来咱们在 application.yaml 中配置一下数据库连贯信息，当我的项目启动的时候会主动初始化数据库，未来流程引擎运行时候的数据会被主动长久化到数据库中。

spring:
  datasource:
    username: root
    password: 123
    url: jdbc:mysql:///flowable?serverTimezone=Asia/Shanghai&useSSL=false

好啦，配置实现后，咱们就能够启动我的项目了。我的项目启动胜利之后，flowable 数据库中就会主动创立如下这些表，未来流程引擎相干的数据都会主动保留到这些表中。

默认的表比拟多，截图只是其中一部分。

3. 画流程图

画流程图算是比拟有挑战的一个步骤了，也是流程引擎应用的要害。官网提供了一些流程引擎绘制工具，这个我就不说了，感兴趣的小伙伴能够自行去体验；IDEA 也自带了一个流程可视化的工具，然而特地难用，我这里也就 不说了。

这里说一下我罕用的 IDEA 插件 Flowable BPMN visualizer，如下图：

插件怎么装置就不必我教了吧，小伙伴们自行装置即可。

装好插件之后，咱们在 resources 目录下新建 processes 目录，这个目录下的流程文件未来会被主动部署。

接下来咱们在 processes 目录下，新建一个 BPMN 文件（插件装好了就有这个选项了），如下：

咱们来画个销假的流程，就叫做 ask_for_leave.bpmn20.xml，留神最初面的 .bpmn20.xml 是固定后缀。

文件创建进去之后，右键单击，抉择 View BPMN(Flowable) Diagram, 就关上了可视化页面了，咱们就能够来绘制本人的流程图了。

我的销假流程画进去是这样：

员工发动一个销假流程，首先是组长审核，组长审核通过了，就进入到经理审核，经理审核通过了，这个流程就完结了，如果组长审核未通过或者经理审核未通过，则流程给员工发送一个销假失败的告诉，流程完结。

咱们来看下这个流程对应的 XML 文件，一些流程细节会在 XML 文件中体现进去，如下：

<process id="ask_for_leave" name="ask_for_leave" isExecutable="true">
  <userTask id="leaveTask" name="销假" flowable:assignee="#{leaveTask}"/>
  <userTask id="zuzhangTask" name="组长审核" flowable:assignee="#{zuzhangTask}"/>
  <userTask id="managerTask" name="经理审核" flowable:assignee="#{managerTask}"/>
  <exclusiveGateway id="managerJudgeTask"/>
  <exclusiveGateway id="zuzhangJudeTask"/>
  <endEvent id="endLeave" name="完结"/>
  <startEvent id="startLeave" name="开始"/>
  <sequenceFlow id="flowStart" sourceRef="startLeave" targetRef="leaveTask"/>
  <sequenceFlow id="modeFlow" sourceRef="leaveTask" targetRef="zuzhangTask"/>
  <sequenceFlow id="zuzhang_go" sourceRef="zuzhangJudeTask" targetRef="managerTask" name="通过">
    <conditionExpression xsi:type="tFormalExpression"><![CDATA[${checkResult=='通过'}]]></conditionExpression>
  </sequenceFlow>
  <sequenceFlow id="zuzhang_reject" sourceRef="zuzhangJudeTask" targetRef="sendMail" name="回绝">
    <conditionExpression xsi:type="tFormalExpression"><![CDATA[${checkResult=='回绝'}]]></conditionExpression>
  </sequenceFlow>
  <sequenceFlow id="jugdeFlow" sourceRef="managerTask" targetRef="managerJudgeTask"/>
  <sequenceFlow id="flowEnd" name="通过" sourceRef="managerJudgeTask" targetRef="endLeave">
    <conditionExpression xsi:type="tFormalExpression"><![CDATA[${checkResult=='通过'}]]></conditionExpression>
  </sequenceFlow>
  <sequenceFlow id="rejectFlow" name="回绝" sourceRef="managerJudgeTask" targetRef="sendMail">
    <conditionExpression xsi:type="tFormalExpression"><![CDATA[${checkResult=='回绝'}]]></conditionExpression>
  </sequenceFlow>
  <serviceTask id="sendMail" flowable:exclusive="true" name="发送失败提醒" isForCompensation="true" flowable:class="org.javaboy.flowable.AskForLeaveFail"/>
  <sequenceFlow id="endFlow" sourceRef="sendMail" targetRef="askForLeaveFail"/>
  <endEvent id="askForLeaveFail" name="销假失败"/>
  <sequenceFlow id="zuzhangTask_zuzhangJudeTask" sourceRef="zuzhangTask" targetRef="zuzhangJudeTask"/>
</process>

联合 XML 文件我来和大家解释一下这里波及到的 Flowable 中的组件，咱们来看下：

  • <process>：示意一个残缺的工作流程。
  • <startEvent>：工作流中终点地位，也就是图中的绿色按钮。
  • <endEvent>：工作流中完结地位，也就是图中的红色按钮。
  • <userTask>：代表一个工作审核节点（组长、经理等角色），这个节点上有一个 flowable:assignee 属性，这示意这个节点该由谁来解决，未来在 Java 代码中调用的时候，咱们须要指定对应的解决人的 ID 或者其余惟一标记。
  • <serviceTask>：这是服务工作，在具体的实现中，这个工作能够做任何事件。
  • <exclusiveGateway>：逻辑判断节点，相当于流程图中的菱形框。
  • <sequenceFlow>：链接各个节点的线条，sourceRef 属性示意线的起始节点，targetRef 属性示意线指向的节点，咱们图中的线条都属于这种。

流程图这块松哥和大家略微说一下，咋一看这个图挺简单很难画，然而实际上只有你认认真真去捋一捋这里边的各个属性，基本上很快就明确到底是怎么一回事，我也置信各位小伙伴都有这样的悟性。

4. 开发接口

接下来咱们写几个接口，来体验一把流程引擎。

在正式体验之前，咱们先来相熟几个类，这几个类咱们一会写代码会用到。

4.1 Java 类梳理

  • ProcessDefinition

这个最好了解，就是流程的定义，也就相当于标准，每个 ProcessDefinition 都会有一个 id。

  • ProcessInstance

这个就是流程的一个实例。简略来说，ProcessDefinition 相当于是类，而 ProcessInstance 则相当于是依据类 new 进去的对象。

  • Activity

Activity 是流程标准规范 BPMN2.0 外面的标准，流程中的每一个步骤都是一个 Activity。

  • Execution

Execution 的含意是流程的执行线路，通过 Execution 能够取得以后 ProcessInstance 以后执行到哪个 Activity 了。

  • Task

Task 就是以后要做的工作。

实际上这里波及到的货色比拟多，不过咱们明天先整一个简略的例子，所以下面这些知识点临时够用了。

4.2 查看流程图

在正式开始之前，咱们先筹备一个接口，用来查看流程图的实时执行状况，这样不便咱们查看流程到底执行到哪一步了。

具体的代码如下：

@RestController
public class HelloController {

    @Autowired
    RuntimeService runtimeService;

    @Autowired
    TaskService taskService;

    @Autowired
    RepositoryService repositoryService;

    @Autowired
    ProcessEngine processEngine;

    @GetMapping("/pic")
    public void showPic(HttpServletResponse resp, String processId) throws Exception {ProcessInstance pi = runtimeService.createProcessInstanceQuery().processInstanceId(processId).singleResult();
        if (pi == null) {return;}
        List<Execution> executions = runtimeService
                .createExecutionQuery()
                .processInstanceId(processId)
                .list();

        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, false);
        OutputStream out = null;
        byte[] buf = new byte[1024];
        int legth = 0;
        try {out = resp.getOutputStream();
            while ((legth = in.read(buf)) != -1) {out.write(buf, 0, legth);
            }
        } finally {if (in != null) {in.close();
            }
            if (out != null) {out.close();
            }
        }
    }
}

这就一个工具，没啥好说的，一会大家看完前面的代码，再回过头来看这个接口，很多中央就都懂了。

4.3 开启一个流程

为了不便，接下来的代码咱们都在单元测试中实现。

首先咱们来开启一个流程，代码如下：

String staffId = "1000";
/**
 * 开启一个流程
 */
@Test
void askForLeave() {HashMap<String, Object> map = new HashMap<>();
    map.put("leaveTask", staffId);
    ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("ask_for_leave", map);
    runtimeService.setVariable(processInstance.getId(), "name", "javaboy");
    runtimeService.setVariable(processInstance.getId(), "reason", "劳动一下");
    runtimeService.setVariable(processInstance.getId(), "days", 10);
    logger.info("创立销假流程 processId：{}", processInstance.getId());
}

首先由员工发动一个销假流程，map 中寄存的 leaveTask 是咱们在 XML 流程文件中提前定义好的，提前定义好以后这个工作创立之后，该由谁来解决，这里咱们是假如由工号为 1000 的员工来发动这样一个销假流程。同时，咱们还设置了一些额定信息。ask_for_leave 是咱们在 XML 文件中定义的一个 process 的名称。

好啦，当初咱们执行这个单元测试办法，执行实现后，控制台会打印出以后这个流程的 id，咱们拿着这个 id 去拜访 4.2 大节的接口，后果如下：

能够看到，销假用红色的框框起来了，阐明以后流程走到了这一步。

4.4 将申请提交给组长

接下来，咱们就须要将这个销假流程向后推进一步，将销假事务提交给组长，代码如下：

String zuzhangId = "90";
/**
 * 提交给组长审批
 */
@Test
void submitToZuzhang() {
    // 员工查找到本人的工作，而后提交给组长审批
    List<Task> list = taskService.createTaskQuery().taskAssignee(staffId).orderByTaskId().desc().list();
    for (Task task : list) {logger.info("工作 ID：{}；工作解决人：{}；工作是否挂起：{}", task.getId(), task.getAssignee(), task.isSuspended());
        Map<String, Object> map = new HashMap<>();
        // 提交给组长的时候，须要指定组长的 id
        map.put("zuzhangTask", zuzhangId);
        taskService.complete(task.getId(), map);
    }
}

首先咱们利用 staffId 查找到以后员工的 id，进而找到以后员工须要执行的工作，遍历这个工作，调用 taskService.complete 办法将工作提交给组长，留神在 map 中指定组长的 id。

提交实现后，咱们再去看流程图片，如下：

能够看到，流程图走到组长审批了。

4.5 组长审批

组长当初有两种抉择，批准或者回绝，批准的代码如下：

/**
 * 组长审批 - 批准
 */
@Test
void zuZhangApprove() {List<Task> list = taskService.createTaskQuery().taskAssignee(zuzhangId).orderByTaskId().desc().list();
    for (Task task : list) {logger.info("组长 {} 在审批 {} 工作", task.getAssignee(), task.getId());
        Map<String, Object> map = new HashMap<>();
        // 组长审批的时候，如果是批准，须要指定经理的 id
        map.put("managerTask", managerId);
        map.put("checkResult", "通过");
        taskService.complete(task.getId(), map);
    }
}

通过组长的 id 查问组长的工作，批准的话，须要指定经理，也就是这个流程下一步该由谁来解决。

回绝的代码如下：

/**
 * 组长审批 - 回绝
 */
@Test
void zuZhangReject() {List<Task> list = taskService.createTaskQuery().taskAssignee(zuzhangId).orderByTaskId().desc().list();
    for (Task task : list) {logger.info("组长 {} 在审批 {} 工作", task.getAssignee(), task.getId());
        Map<String, Object> map = new HashMap<>();
        // 组长审批的时候，如果是回绝，就不须要指定经理的 id
        map.put("checkResult", "回绝");
        taskService.complete(task.getId(), map);
    }
}

回绝的话，就没那么多事了，间接设置 checkResult 为回绝即可。

假如这里执行了批准，那么流程图如下：

4.6 经理审批

经理审批和组长审批差不多，只不过经理这里是最初一步了，不须要再指定下一位解决人了，批准的代码如下：

/**
 * 经理审批本人的工作 - 批准
 */
@Test
void managerApprove() {List<Task> list = taskService.createTaskQuery().taskAssignee(managerId).orderByTaskId().desc().list();
    for (Task task : list) {logger.info("经理 {} 在审批 {} 工作", task.getAssignee(), task.getId());
        Map<String, Object> map = new HashMap<>();
        map.put("checkResult", "通过");
        taskService.complete(task.getId(), map);
    }
}

回绝代码如下：

/**
 * 经理审批本人的工作 - 回绝
 */
@Test
void managerReject() {List<Task> list = taskService.createTaskQuery().taskAssignee(managerId).orderByTaskId().desc().list();
    for (Task task : list) {logger.info("经理 {} 在审批 {} 工作", task.getAssignee(), task.getId());
        Map<String, Object> map = new HashMap<>();
        map.put("checkResult", "回绝");
        taskService.complete(task.getId(), map);
    }
}

4.7 回绝流程

如果组长回绝了或者经理回绝了，咱们也有相应的解决计划，首先在 XML 流程文件定义时，如下：

<serviceTask id="sendMail" flowable:exclusive="true" name="发送失败提醒" isForCompensation="true" flowable:class="org.javaboy.flowable.AskForLeaveFail"/>

如果销假被回绝，会进入到这个 serviceTask，serviceTask 对应的解决类是 org.javaboy.flowable.AskForLeaveFail，该类的代码如下：

public class AskForLeaveFail implements JavaDelegate {
    @Override
    public void execute(DelegateExecution execution) {System.out.println("销假失败。。。");
    }
}

也就是销假失败会进入到这个办法中，当初咱们就能够在这个办法中该干嘛干嘛了。

5. 小结

好啦，一个简略的销假流程，心愿能带小伙伴们入门 flowable，公众后盾回复 flowable，获取本文案例。

好啦，前面 tienchin 我的项目视频中咱们再看看这个 flowable 在我的项目中如何应用：戳戳戳这里 –>TienChin 我的项目配套视频来啦。

退出移动版