流程编排、如此简单-通用流程编排组件JDEasyFlow介绍

作者：李玉亮

JDEasyFlow是企业金融研发部自研的通用流程编排技术组件，适用于服务编排、工作流、审批流等场景，该组件已开源(https://github.com/JDEasyFlow/jd-easyflow)，目前在部门的内部业务系统和科技输出系统中广泛应用，其他部门也有使用。

它的特点是简单、灵活、易扩展，开发人员一般30分钟可入门上手，半天可掌握其原理。它分为一个核心模块和若干扩展模块，模块之间松耦合，开发使用时可按需选择、快速集成、渐进式应用，同时支持JSON内置规范和BPMN规范。它的实现原理也有其特色，后面有介绍。

支持的场景功能

节点流转类型

支持顺序流转、条件流转、循环流转等。

节点功能类型

支持脚本节点、用户节点和消息节点。

• **脚本节点：**节点执行时运行一段代码脚本

• **用户节点：**根据用户的操作指令触发节点执行

• **消息节点：**接收消息后触发节点执行

节点串并类型

支持串行执行、并行执行、串并组合执行等。

流程交互场景

支持单次交互一次执行多节点、多次交互一次执行一节点、多次交互一次执行多节点等。

子流程场景

JDEasyFlow支持子流程的场景，可将把复杂的流程节点拆分为子流程，便于业务逻辑抽象。

审批流程场景

JDEasyFlow提供了流程任务审批的能力；常用的审批、撤销、驳回、会签、加签等功能都可支持；内置了简单的动态表单。既支持从页面发起和操作流程任务，也支持API的方式，京东OA审批系统也有对接。

功能架构

整体功能架构

JDEasyFlow的功能架构如下图，功能模块之间松耦合，开发时可按需选择、快速集成、渐进式应用**。**最简单的使用方式为只在业务应用端引入jar包使用流程引擎。如果需要流程可视化功能，可集成BPMN规范模块，如果还需要流程实例持久化、流程定义持久化等更丰富功能，则可以集成其他相关模块。

流程引擎模块

JDEasyFlow的核心模块，此模块提供了基于JSON格式的JDEasyFlow规范进行流程编排的能力，其他模块均基于该模块扩展，相当于流程执行的发动机、CPU。该功能模块为独立组件，无数据库依赖，应用中引入jar包便可使用。

BPMN规范模块

提供了基于BPMN规范进行流程定义和可视化的能力，流程可视化基于[bpmn-js](Web-based tooling for BPMN, DMN, CMMN, and Forms | bpmn.io)，其本质为提供了将BPMN格式流程定义转换为JDEasyFlow格式的能力。该模块为独立组件，仅依赖流程引擎模块，无数据库和服务依赖，应用中引入jar包便可使用。

目前可支持常用的BPMN元素：

• **任务：**脚本任务、用户任务、消息任务

• **事件：**开始事件、结束事件、消息接收事件

• **网关：**排他网关、并行网关、包容网关

流程定义和实例管理模块

流程定义模块支持流程定义的中心化、版本化管理，流程实例模块支持流程实例的持久化和生命周期管理。该功能依赖数据库，有服务端和ERP管理端。

任务/审批模块

支持任务生成、任务分配等功能，常用的审批、撤销、驳回、会签、加签等功能都可支持。该功能依赖数据库，有服务端和ERP管理端。

系统架构

整体系统架构

JDEasyFlow的完整系统架构如下，主要有三个端：业务应用端、流程服务端、流程管理端，三个端可部署在单体应用中，也可分开部署。

中间件依赖

· 关系型数据库(如Mysql)

· 缓存(如Redis或R2M)

· 服务通讯框架(如Java API调用或Http调用或JSF调用)

数据库数据模型比较简单清晰，见下图：

性能说明

· 如果仅是服务编排场景，则流程的执行仅依赖内存和CPU，并且是在流程客户端执行，性能上依赖于客户端服务器的性能，普通笔记本实测1秒可执行一个流程请求的1w+个节点，1秒可执行1万+次含1个节点的流程请求

· 如果需要流程状态管理和流程持久化功能，流程引擎在执行时会到流程服务端查询和保存流程实例和流程节点的状态，性能上主要依赖于数据库的查询和插入效率

· 对于流程任务审批功能，流程的任务审批流转是在服务端执行，一方面取决于流程服务端的计算性能，另一方面同样取决于数据库的查询和插入效率

可伸缩性说明

· 流程引擎属于无状态，可随应用实例线性伸缩

· 流程服务端应用实例支持线性扩展

· 流程数据库可通过分库分表的方式支持大数据量的增长

实践建议

在具体实践中，建议部署统一的流程中心（见下图），对流程定义统一管理。各系统的应用只需集成流程客户端jar包进行流程节点开发和流程调用便可。如果系统只使用任务审批的功能，则只需要通过API和消息与流程中心交互便可。

使用示例

流程引擎使用示例

在源码的test目录下有quickstart测试用例(easyflow\easyflow-flow\src\test\java\com\jd\easyflow\flow\quickstart\QuickStartTest.java)，可直接运行或调试以了解使用方式和运行原理。具体实践步骤如下：

1、代码中引入easyflow-flow jar包，以maven为例:

<dependency>
        <groupId>com.jd.easyflow</groupId>
        <artifactId>easyflow-flow</artifactId>
        <version>{替换为最新版本}</version>
</dependency>

2、编写流程定义文件，以node001->node002→node003的执行顺序为例:

{"id": "quickstart_001", "name": "Quick Start 001",
"nodes": [
  {"id": "node001","name": "Node001","action": {"createExp": "new com.jd.easyflow.flow.quickstart.QuickStart001Node01Action()"},"start": true,"post": {"to": "node002"}},
  {"id": "node002","name": "Node002","action": {"createExp": "new com.jd.easyflow.flow.quickstart.QuickStart002Node01Action()"},"post": {"to": "node003"}},
  {"id": "node003","name": "Node003","action": {"createExp": "new com.jd.easyflow.flow.quickstart.QuickStart003Node01Action()"}}
]
}

其中QuickStart001Node01Action等为java节点动作类。完整的流程定义配置项可见： Flow engine usage · JDEasyFlow/jd-easyflow Wiki · GitHub (公网）

3、编写应用启动时加载流程引擎的代码

   FlowEngineImpl flowEngine = new FlowEngineImpl();
   flowEngine.setFlowPath("classpath:flow/quickstart/quickstart_001.json");
   flowEngine.init();

Spring环境可直接定义FlowEngineImpl bean.

4、编写具体流程调用执行的代码

    FlowParam param = new FlowParam("quickstart_001");
    FlowResult result = flowEngine.execute(param);

完整测试用例的执行结果打印如下：

[main           ] INFO FlowEngineImpl         - Start parsing definition files:easyflow-flow/target/test-classes/flow/quickstart/quickstart_001.json
[main           ] INFO FlowEngineImpl         - SART EXECUTE FLOW, flowId:quickstart_001 nodeIds:null
[main           ] INFO BaseFlowRunner         - EXECUTE NODE:node001
[main           ] INFO QuickStart001Node01Action - Execute Node 001
[main           ] INFO BaseFlowRunner         - NEXT NODES:node002
[main           ] INFO BaseFlowRunner         - EXECUTE NODE:node002
[main           ] INFO QuickStart002Node01Action - Execute Node 002
[main           ] INFO BaseFlowRunner         - NEXT NODES:node003
[main           ] INFO BaseFlowRunner         - EXECUTE NODE:node003
[main           ] INFO QuickStart003Node01Action - Execute Node 003
[main           ] INFO BaseFlowRunner         - NEXT NODES:
[main           ] INFO QuickStartTest         - Execute finish, current node is:node003

BPMN模块使用示例

打开easyflow-flow-bpmn/BPMNDesigner.html流程设计器. 点击导入按钮，导入easyflow-flow-bpmn/src/test/resources/flow/quickstart/quickstart_001.bpmn文件，可在设计器中看到和以上JSON定义等价的BPMN流程定义.