SpringBoot 整合 Flowable 实现工作流实战指南

结合 XML 文件解释一下涉及到的 Flowable 组件：

• <process>：表示一个完整的工作流程。
• <startEvent>：工作流的起点。
• <endEvent>：工作流的终点。
• <userTask>：代表任务审核节点（如组长、经理），flowable:assignee 属性指定处理人 ID。
• <serviceTask>：服务任务，可执行任意业务逻辑。
• <exclusiveGateway>：排他网关，相当于流程图中的判断菱形框。
• <sequenceFlow>：连接各个节点的线条。

关于流程图的绘制细节，这里补充几点关键说明：乍一看图比较复杂，但只要理顺各个属性之间的关系，很快就能理解其运作机制。

4、开发接口

接下来编写几个接口来体验流程引擎。在正式编码前，先熟悉几个核心类。

4.1 Java 类梳理

• ProcessDefinition：流程定义，相当于规范，每个定义都有唯一 ID。
• ProcessInstance：流程实例，相当于根据定义创建的对象。
• Activity：流程标准规范 BPMN2.0 中的步骤单元。
• Execution：流程的执行线路，用于获取当前实例执行到了哪个 Activity。
• 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 length = 0;
        try {
            out = resp.getOutputStream();
            while ((length = in.read(buf)) != -1) {
                out.write(buf, 0, length);
            }
        } 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 流程文件中提前定义好的变量名，用于指定任务发起人。同时设置了一些额外信息，如姓名、原因、天数。ask_for_leave 对应 XML 中定义的 process 名称。

执行该单元测试方法后，控制台会打印流程 ID。使用该 ID 访问上述 /pic 接口，可以看到流程已到达'请假'节点。

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 查询当前员工的任务，遍历任务并调用 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 查询任务，同意时需指定经理 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 flowable:exclusive="true" name="发送失败提示" isForCompensation="true" flowable:class="org.javaboy.flowable.AskForLeaveFail"/>

对应的处理类 AskForLeaveFail 实现了 JavaDelegate 接口：

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

当流程走到被拒绝分支时，会自动执行该方法。开发者可以在这里添加邮件通知、短信提醒等具体业务逻辑。