一、前言:
发现网上关于Flowable的资料基本都是浅尝辄止,对如何构建一个企业级的流程应用说明很少,所以写个实战系列,希望对大家和自己,都有所帮助。
二、认识Flowable
Flowable是一个使用Java编写的轻量级业务流程引擎。
Flowable流程引擎可用于部署BPMN 2.0流程定义,创建这些流程定义的流程实例,进行查询,访问运行中或历史的流程实例与相关数据。
Flowable是Activiti的fork,即Flowable源自Activiti。所以可以看到,Flowable很多设计与实现,与Activiti是相同的。
开源Flowable官网:https://www.flowable.com/open-source/
三、完整实例
Flowable官网教程已经提供了一个很简单的流程运行例子,是英文版。
下面的例子内容来源于官网教程,已经看过的同学可以直接跳过到下一节内容
。
我们将构建的例子是一个简单的请假(holiday request)流程:
- 雇员(employee)申请几天的假期
- 经理(manager)批准或驳回申请
- 我们会模拟将申请注册到某个外部系统,并给雇员发送结果邮件
1.创建项目
打开IDEA,通过File -> New -> Project… -> Maven 创建一个新的Maven项目
在下一个界面,填入项目名Name,GroupId 和 ArtifactId 默认即可
这样就建立了空的Maven项目。
2.创建流程引擎
为项目添加3个依赖:
- Flowable流程引擎。使我们可以创建一个ProcessEngine流程引擎对象,并访问Flowable API。
- 一个内存数据库。本例中为H2,因为Flowable引擎在运行流程实例时,需要使用数据库来存储执行与历史数据。
- 日志框架。Flowable使用SLF4J作为内部日志框架。本例中,我们使用log4j作为SLF4J的实现。
在pom.xml文件中添加下列行:
<dependencies>
<dependency>
<groupId>org.flowable</groupId>
<artifactId>flowable-engine</artifactId>
<version>6.7.2</version>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>1.3.176</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.21</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.21</version>
</dependency>
</dependencies>
Log4j需要一个配置文件。在src/main/resources文件夹下添加log4j.properties文件,并写入下列内容:
log4j.rootLogger=INFO, CA
log4j.appender.CA=org.apache.log4j.ConsoleAppender
log4j.appender.CA.layout=org.apache.log4j.PatternLayout
log4j.appender.CA.layout.ConversionPattern= %d{hh:mm:ss,SSS} [%t] %-5p %c %x - %m%n
注意: 关于Log4j 的远程代码执行漏洞问题,影响范围是Apache Log4j 2.x <= 2.14.1 版本,所以上面的日志版本是安全的。
有时候,依赖JAR无法自动获取,可以右键点击项目,并选择 Maven ->Reload Project以强制手动刷新。
创建一个新的Java类,并添加标准的Java main方法:
public class HolidayRequest {
public static void main(String[] args) {
}
}
首先要做的是初始化ProcessEngine流程引擎实例。创建一个ProcessEngineConfiguration实例 ,并配置数据库JDBC连接。然后由ProcessEngineConfiguration创建ProcessEngine实例。
import org.flowable.engine.ProcessEngine;
import org.flowable.engine.ProcessEngineConfiguration;
import org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration;
public class HolidayRequest {
public static void main(String[] args) {
ProcessEngineConfiguration cfg = new StandaloneProcessEngineConfiguration()
.setJdbcUrl("jdbc:h2:mem:flowable;DB_CLOSE_DELAY=-1")
.setJdbcUsername("sa")
.setJdbcPassword("")
.setJdbcDriver("org.h2.Driver")
.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE);
ProcessEngine processEngine = cfg.buildProcessEngine();
}
}
注意:内存H2数据库在JVM重启后会消失。如果需要永久保存数据,需要切换为持久化数据库,并相应切换连接参数。
这样就可以运行了。在IDEA中最简单的方法是右键点击类文件,选择Run ‘HolidayRequest.main()’ :
成功运行,应该可以看到关于引擎启动与创建数据库表结构的提示日志:
这样就得到了一个启动可用的流程引擎。接下来为它提供一个流程!
3.创建流程定义文件
我们要构建的流程是一个非常简单的请假流程。 在Flowable术语中,我们将其称为一个流程定义(process definition)。一个流程定义可以启动多个流程实例(process instance)。流程定义可以看做是重复执行流程的蓝图。 在这个例子中,流程定义定义了请假的各个步骤,而一个流程实例对应某个雇员提出的一个请假申请。
我们要使用的流程定义为:
为了明确起见,说明一下几个要点:
- 启动流程需要提供一些信息,例如雇员名字、请假时长以及说明。。
- 左侧的圆圈叫做启动事件(start event)。这是一个流程实例的起点。
- 第一个矩形是一个用户任务(user task)。这是流程中人类用户操作的步骤。在这个例子中,经理需要批准或驳回申请。
- 取决于经理的决定,排他网关(exclusive gateway) (带叉的菱形)会将流程实例路由至批准或驳回路径。
- 如果批准,则需要将申请注册至某个外部系统,并跟着另一个用户任务,将经理的决定通知给申请人。
- 如果驳回,则为雇员发送一封邮件通知他。
注意:一般来说,这样的流程定义使用可视化建模工具建立,如Flowable Designer(Eclipse)或Flowable Web Modeler(Web应用)。IDEA没有官方提供的可视化插件,可选插件为Flowable BPMN visualizer。
将下面的XML保存在src/main/resources文件夹下名为holiday-request.bpmn20.xml的文件中。
<?xml version="1.0" encoding="UTF-8"?>