Flowable使用初体验

最近在公司接手了工作流这一块的任务，使用的技术框架是Flowable。对于工作流这块，之前自己也是没有接触过的，一开始听到把工作流交给我也是很慌的，好在项目组的大哥手把手的给我讲了讲整个工作流的逻辑，加上查看Flowable的官方文档，渐渐的也就掌握了。

1、从Flowable的官方文档说起

找了一个汉化后的官方文档：https://tkjohn.github.io/flowable-userguide/#_introduction

可以说，这个官方文档算是很详细的了，从是什么，到怎么用，以及和其他框架进行集成都有了很详细的讲解。个人觉得对于文档而言，可以重点先看下 4. Flowable API 这个章节，熟悉一下各个API的使用,其实，在Flowable中涉及的几个重要的服务，文章中都列出来了并给予了讲解(如下图)：

我们的这个项目中主要使用了RepositoryService、RuntimeService、TaskService这三个服务：

• RepositoryService：这个主要在部署流程的时候会使用到，在项目启动的时候会在此加载配置好的BPMN文档，从而构建整个工作流

• RuntimeService: 用于启动流程定义的新流程实例,可以通过startProcessInstanceByKey方法来创建一个工作流实例

• TaskService: 这是和任务相关的，也就是需要人员执行的任务，一个流程是对应这个多个任务节点

可以说整个流程的流转主要也就和这三个服务相关了，这里只是蜻蜓点水的提一下，需要详细了解的还请各位仁兄移步官方文档

新手的话，官方文档提供的案例还是非常建议练一练的,案例的代码也可以直接在我的gitee仓库上获取到: https://gitee.com/java_xhs/flowable.git

最后，文档中的 14. Flowable UI应用 这一章节介绍了如何通过绘制流程图的方式，并导出BPMN的xml结构，这真的是很良心啊。我相信很多小伙伴在看文档的前部分的案例的时候看到BPMN的语法，应该会很绝望，Spring都已经将xml替换成注解了，你就知道xml的配置写起来是有多麻烦了，而现在开发个工作流得手写xml，那我…直接放弃吧。好在Flowable的开发人员也考虑到了这一点，Flowable UI正是为此而生，具体的步骤如下：

1. 下载最新稳定版本的Apache Tomcat。
2. 下载最新稳定版本的Flowable 6。
3. 将Flowable发行包中，wars文件夹下的flowable-admin.war、flowable-idm.war、flowable-modeler.war与flowable-task.war文件，复制到Tomcat的webapps文件夹下。
4. 运行bin/startup.sh（在Mac OS或Linux下），或bin/startup.bat（在Windows下）脚本，启动Tomcat服务器。
5. 打开web浏览器，访问 http://localhost:8080/flowable-modeler

其实，除此之外是有IDE的相关插件的，但是IDEA在高版本后就不支持了，所以在此也就不说了，官方的这个UI真的是很棒了

2、开发流程

1. 对于整个工作流的开发来说，首先就是理清这个业务的流程，然后在Flowable UI上绘制出符合逻辑的流程图(如下图)
   

然后通过下载按钮，就可以下载出我们需要的BPMN2的文档了(如下图)

2. 部署流程，在基于Spring集成的情况下，可以如下进行部署：

	//部署流程
    RepositoryService repositoryService = this.processEngine.getRepositoryService();
    repositoryService.createDeployment()
                .addClasspathResource("test_01.bpmn20.xml")
                .deploy();

3. 创建一个流程实例

	// 获取RuntimeService实例
	RuntimeService runtimeService = processEngine.getRuntimeService();
	// 开启一个流程实例
	ProcessInstance processInstance = runtimeService.startProcessInstanceByKey(workflowTypeCode, map);

4. 执行流程

	// 获取TaskService实例
	TaskService taskService = processEngine.getTaskService();
	// 根据流程id获取指定任务
    Task task = taskService.createTaskQuery().processInstanceId(processId).singleResult();
    // 执行指定任务
    taskService.complete(task.getId());

5. 实现JavaDelegate
   通过实现JavaDelegate我们可以实现申请通过后执行的自己逻辑；流程图中的服务任务 中就是执行这个JavaDelegate代理类的逻辑的【切记是需要配置的】

	public class CallExternalSystemDelegate implements JavaDelegate {
	// 服务任务会回调这个方法，来执行自定义的逻辑
    public void execute(DelegateExecution execution) {
        // System.out.println("Calling the external system for employee "
        //     + execution.getVariable("employee"));	
        // 可以在此处编写执行命令后需要执行的逻辑
    }
}

整个框架使用起来还是很简单的，这是这样也就过于简单了，和实际的流程差距很大，正如官方文档中所说：Flowable实际上在运行时并不做任何用户检查 ，我想说一个通用的框架差不多都这样吧，只能集成公共的部分，剩下的部分得需要我们自己在代码中进行实现，下面就看看实际项目的使用吧

3、实战使用

存在的问题

通过上面对Flowble的介绍，我们已经发现了Flowable可以很好的帮我们串起整个流程，但是对于实际项目中的流程，我们是需要流转到指定的人或拥有指定权限的人那边，然后进行处理。我们知道，在我们不做任何处理的时候，Flowable中命令的执行是任何人都可以的，那我们该怎么办呢？

解决思路

其实也很简单：如果需要满足指定的需求，我们只需要在执行操作之前对执行的这个人进行权限校验，只有校验通过，我们才给予放行，否则返回没有操作工作流权限。

解决方法

由于对于不同的节点有着不同的操作，所以我们项目中就定义了状态 和 命令 这两个特殊的枚举，其实流程图中的每一个节点就是对应了一个状态，命令就是当前执行人可以进行的操作，即一个流程途中有着多个状态，而每个状态下又有着多个命令，把这当成一个配置项，在流程运行之前我们就是配置好的，此时是放入了Mongo中，每个工作流对应了Mongo中的一个document。再流程图中的服务任务中，我们配置了两个类中的字段,这两个字段分别对应了该流程执行这个操作的前一个状态beforeStatus和执行完这个操作的后一个状态afterStatus,这样每次在回调执行我们指定的JavaDelegate时，我们就可以获取到这两个字段,从而及时更新流程的状态到数据库中，这样在下次执行流程时，我们就可以通过流程id去数据库中获取到该流程的当前所处的状态值，然后根据这个状态值以及前台传过来的命令去Mongo中拿到能在该状态下执行该命令的人所需要具有的权限，在据此来判断当前执行人是符合配置的权限，符合则执行流程的complete方法，否则直接返回没有操作改工作流的权限。

4、说在最后

Flowable的整体使用起来还是比较简单的，易上手，加上自己的权限控制，以及消息推送等模块才能真正的具备生产使用。后面有时间再研究研究Flowable的其他扩展功能以及源码吧，有缘再见，各位仁兄。