Activiti

integrated-development

# 一、工作流

Workflow 工作流

WfMS Workflow Management System 工作流管理系统

WfMC Workflow Management Coalition 工作流管理系统

工作流就是“业务过程的部分或整体在计算机应用环境下的自动化”,它主要解决的是“使在多个参与者之间按照某种预定义的规则传递文档、信息或任务的过程自动进行,从而实现某个预期的业务目标,或者促使此目标的实现”。

工作流管理系统是一个软件系统,它完成工作量的定义和管理,并按照在系统中预先定义好的工作流规则进行工作流实例的执行。工作流管理系统不是企业的业务系统,而是为企业的业务系统的运行提供了一个软件的支撑环境。

工作流管理联盟给出的关于工作流管理系统的定义是:工作流管理系统是一个软件系统,它通过执行经过计算的流程定义去支持一批专门设定的业务流程。工作流管理系统被用来定义、管理、和执行工作流程。

工作流管理系统的目标:管理工作的流程以确保工作在正确的时间被期望的人员所执行——在自动化进行的业务过程中插入人工的执行和干预。

# 二、Activiti介绍

Activiti是由Alfresco软件在2010年5月17日发布的业务流程管理(BPM)框架,它是覆盖了业务流程管理工作流服务协作等领域的一个开源的、灵活的、易扩展的可执行流程语言框架

Activiti基于Apache许可的开源BPM平台,创始人Tom Baeyens是JBoss jBPM的项目架构师,它特色是提供了eclipse插件,开发人员可以通过插件直接绘画出业务流程图。

官网:https://www.activiti.org (opens new window)

学习博客:https://blog.csdn.net/zjx86320/category_6294649.html (opens new window)

开源项目:https://boot.jeecg.com/user/login (opens new window)

# 核心概念

# 工作流引擎

ProcessEngine对象,这是Activiti工作的核心。负责生成流程运行时的各种实例及数据、监控和管理流程的运行。

# BPMN

业务流程建模与标注(Business Process Model and Notation,BPMN) ,描述流程的基本符号,包括这些图元如何组合成一个业务流程图(Business Process Diagram)

# 数据库

Activiti数据库支持:

Activiti的后台是有数据库的支持,所有的表都以ACT_开头。 第二部分是表示表的用途的两个字母标识。 用途也和服务的API对应。

  • ACT_RE_*:'RE'表示repository。 这个前缀的表包含了流程定义和流程静态资源 (图片,规则,等等)。

  • ACT_RU_*:'RU'表示runtime。 这些运行时的表,包含流程实例,任务,变量,异步任务,等运行中的数据。 Activiti只在流程实例执行过程中保存这些数据, 在流程结束时就会删除这些记录。 这样运行时表可以一直很小速度很快。

  • ACT_HI_*:'HI'表示history。 这些表包含历史数据,比如历史流程实例, 变量,任务等等。

  • ACT_GE_*:通用数据, 用于不同场景下,如存放资源文件。

Activiti 5.20之前,工作流总共包含 23 张数据表。

Activiti 5.20之后一共是25张。新增了 ACT_EVT_LOGACT_PROCDEF_INFO ,这两张表命名没有按照规则来,两者分别属于HI和RE。

# 一般数据

一般数据 (ACT_GE_*) 2张

表名 解释
ACT_GE_BYTEARRAY 二进制数据表,存储通用的流程定义和流程资源。
ACT_GE_PROPERTY 系统相关属性,属性数据表存储整个流程引擎级别的数据,初始化表结构时,会默认插入三条记录。

# 流程历史记录

流程历史记录 (ACT_HI_*) 9张

表名 解释
ACT_HI_ACTINST 历史节点表
ACT_HI_ATTACHMENT 历史附件表
ACT_HI_COMMENT 历史意见表
ACT_HI_DETAIL 历史详情表,提供历史变量的查询
ACT_HI_IDENTITYLINK 历史流程人员表
ACT_HI_PROCINST 历史流程实例表
ACT_HI_TASKINST 历史任务实例表
ACT_HI_VARINST 历史变量表
ACT_EVT_LOG 事件日志(在Activiti 5.20版本之前没有这张表)

# 用户表

用户、用户组表 (ACT_ID_*) 4张

表名 解释
ACT_ID_GROUP 用户组信息表
ACT_ID_INFO 用户扩展信息表
ACT_ID_MEMBERSHIP 用户与用户组对应信息表
ACT_ID_USER 用户信息表

# 流程定义表

流程定义表 (ACT_RE_*) 4张

表名 解释
ACT_RE_DEPLOYMENT 部署信息表
ACT_RE_MODEL 流程设计模型部署表
ACT_RE_PROCDEF 流程定义数据表
ACT_PROCDEF_INFO 流程定义的动态变更信息(在Activiti5.20版本之前没有这张表)

# 运行实例表

运行实例表 (ACT_RU_*) 6张

表名 解释
ACT_RU_EVENT_SUBSCR 运行时事件 throwEvent、catchEvent 时间监听信息表
ACT_RU_EXECUTION 运行时流程执行实例
ACT_RU_IDENTITYLINK 运行时流程人员表,主要存储任务节点与参与者的相关信息
ACT_RU_JOB 运行时定时任务数据表
ACT_RU_TASK 运行时任务节点表
ACT_RU_VARIABLE 运行时流程变量数据表

# 核心API

# ProcessEngine

在Activiti中最核心的类,其他的类都是由他而来。

创建ProcessEngine(流程引擎)的方式:

ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
1

调用ProcessEngines的getDefaultProceeEngine方法时会自动加载classpath下名为activiti.cfg.xml文件。

可以产生RepositoryService:

RepositoryService repositoryService = processEngine.getRepositoryService();
1

可以产生RuntimeService:

RuntimeService runtimeService = processEngine.getRuntimeService();
1

可以产生TaskService:

TaskService taskService = processEngine.getTaskService();
1

各个Service的作用:

Service 作用
RepositoryService 管理流程定义和部署相关的Service
RuntimeService 执行管理,包括启动、推进、删除流程实例等操作
TaskService 任务管理
HistoryService 历史管理(执行完的数据的管理)
IdentityService 组织机构管理
FormService 一个可选服务,任务表单管理
ManagerService

# RepositoryService

是Activiti的仓库服务类。所谓的仓库指流程定义文档的两个文件:bpmn文件和流程图片。

  1. 产生方式
RepositoryService repositoryService = processEngine.getRepositoryService();
1
  1. 可以产生DeploymentBuilder,用来定义流程部署的相关参数
DeploymentBuilder deploymentBuilder = repositoryService.createDeployment();
1
  1. 删除流程定义
repositoryService.deleteDeployment(deploymentId);
1

# RuntimeService

是activiti的流程执行服务类。可以从这个服务类中获取很多关于流程执行相关的信息。

# TaskService

是activiti的任务服务类。可以从这个类中获取任务的信息。

# HistoryService

是activiti的查询历史信息的类。在一个流程执行完成后,这个对象为我们提供查询历史信息。

# ProcessDefinition

流程定义类。可以从这里获得资源文件等。

# ProcessInstance

代表流程定义的执行实例。如范冰冰请了一天的假,她就必须发出一个流程实例的申请。一个流程实例包括了所有的运行节点。我们可以利用这个对象来了解当前流程实例的进度等信息。

流程实例就表示一个流程从开始到结束的最大的流程分支,即一个流程中流程实例只有一个。

# Execution

Activiti用这个对象去描述流程执行的每一个节点。在没有并发的情况下,Execution就是同ProcessInstance。

流程按照流程定义的规则执行一次的过程,就可以表示执行对象Execution。

# 流程变量

流程变量在整个工作流中扮演很重要的作用。例如:请假流程中有请假天数、请假原因等一些参数都为流程变量的范围。

流程变量的作用域范围是只对应一个流程实例。也就是说各个流程实例的流程变量是不相互影响的。

流程实例结束完成以后流程变量还保存在数据库中(存放到流程变量的历史表中)。

# 三、Activiti7使用

# 1. pom.xml

在pom.xml中配置activiti 7的maven依赖包

<properties>
    <activiti.version>7.1.0.M2</activiti.version>
    <activiti-image.version>7.1.0.M2</activiti-image.version>
</properties>

<!-- ********  Activiti Begin  ********** -->
<dependency>
    <groupId>org.activiti</groupId>
    <artifactId>activiti-spring-boot-starter</artifactId>
    <version>${activiti.version}</version>
</dependency>
<!-- 单独依赖生成流程图 -->
<dependency>
    <groupId>org.activiti</groupId>
    <artifactId>activiti-image-generator</artifactId>
    <version>${activiti-image.version}</version>
</dependency>
<!-- ********  Activiti End  ********** -->
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# 2. application.yml

在application.yml中配置

spring:
  activiti:
    # 如果不存在表就创建表,存在就直接使用。生产环境该值改为false,表示不存在表就抛出异常。
    database-schema-update: true
    # 检测历史表是否存在
    db-history-used: true
    # 记录历史等级 可配置的历史级别有none, acitivity, audit, all
    history-level: full
    # 默认校验resources下的processes文件夹里的流程文件
    check-process-definitions: true
1
2
3
4
5
6
7
8
9
10

# 3. 启动服务生成25张表

当配置好之后,启动微服务。

  • 如果数据库不存在act相关表,就在启动中自动创建25张表;
  • 存在则直接使用。

# 4. 安装插件actiBPM

使用IDEA安装流程设计器插件actiBPM

# 5. 创建流程定义文件(.bpmn)

在resources目录下,创建processes目录,将所有流程规则文件放置在该目录下。

如下配置,springboot集成中,默认读取该路径。

也可自定义目录路径:添加该属性配置。

# 四、FAQ

# 生成PNG图片

生成png文件时如下操作:

  1. 先将bpmn文件修改成xml文件;

  2. 然后右键点这个xml文件,选项中选择diagrams,然后选择show Designer 就可以看到流程图,

  3. 然后Export to file保存png文件。

# 新版IDEA找不到插件actiBPM

解决方法:

找不到actiBPM插件可以到官网下载actibpm.jar到你电脑硬盘,idea可以从硬盘中安装插件。

  1. IDEA actiBMP插件下载地址 (opens new window)

  2. File-->setting-->Plugin-->Install plangin from disk...-->选择你的actibpm.jar,就会提示重启idea即可。

# IDEA右键xml文件没有Diagrams

问题描述:

生成png图片时,右键xml文件,没有找到Diagrams菜单项。

解决方法:

是因为有一个jbpm2.0的插件没有开启或者没有安装。

在插件中搜索JBoss jBPM,开启或安装这个插件以后,右键xml文件就显示Diagrams了。

# IDEA打开bpmn文件中文乱码问题

  1. 修改IDEA编辑器编码为utf8,File->Settings->Editor->File Encodings,都改为UTF-8;

  2. 在IDEA安装bin目录下,找到idea.exe.vmoptionsidea64.exe.vmoptions两个文件,打开编辑分别在文本最末端添加下面代码;

    -Dfile.encoding=UTF-8
    
    1

  3. 改IDEA运行时的vmoptions,IDEA路径Help->Edit Custom VM Options

    -Dfile.encoding=UTF-8
    
    1

    重启IDEA,成功消除中文乱码!