一、概述
Activiti
是一个工作流引擎, Activiti
可以将业务系统中复杂的业务流程抽取出来,并用专门的建模语言BPMN2.0
进行定义,业务流程按照预先定义的流程进行执行,实现了系统的流程由Activiti
进行管理,减少业务系统由于流程变更进行系统升级改造的工作量,提高了系统的健壮性,减少了系统开发维护成本。
官网地址:
<https://www.activiti.org/>
二、基于Maven整合Activiti
这也是较为原生的方式去使用Activiti
,有助于对Activiti
基础的理解。
2.1 创建一个Maven工程
输入完项目基本信息后,点击下方的Finish
即可创建一个最基本的Maven
项目。
2.2 在pom文件中添加Maven坐标
<properties>
<slf4j.version>1.6.6</slf4j.version>
<log4j.version>1.2.12</log4j.version>
<activiti.version>7.0.0.Beta1</activiti.version>
</properties>
<dependencies>
<!-- activiti流程引擎 -->
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-engine</artifactId>
<version>${activiti.version}</version>
</dependency>
<!-- activiti和spring的整合包 -->
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-spring</artifactId>
<version>${activiti.version}</version>
</dependency>
<!-- bpmn 模型处理 -->
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-bpmn-model</artifactId>
<version>${activiti.version}</version>
</dependency>
<!-- bpmn 转换 -->
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-bpmn-converter</artifactId>
<version>${activiti.version}</version>
</dependency>
<!-- bpmn json数据转换 -->
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-json-converter</artifactId>
<version>${activiti.version}</version>
</dependency>
<!-- bpmn 布局 -->
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-bpmn-layout</artifactId>
<version>${activiti.version}</version>
</dependency>
<!-- activiti 云支持 -->
<dependency>
<groupId>org.activiti.cloud</groupId>
<artifactId>activiti-cloud-services-api</artifactId>
<version>${activiti.version}</version>
</dependency>
<!-- mysql驱动(版本不要过低,要不然连接mysql8 的时候直接会报如下错误:) -->
<!-- Cannot create PoolableConnectionFactory (Unknown system variable ‘query_cache_size‘) -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!-- mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<!-- 链接池 -->
<dependency>
<groupId>commons-dbcp</groupId>
<artifactId>commons-dbcp</artifactId>
<version>1.4</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<!-- log start -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
</dependencies>
如果报 com.github.jgraph:jgraphx
依赖找不到,有两种解决方案:
-
可以手动将依赖下载到本地
-
如果不想看到报红可以将该依赖排除
<dependency> <groupId>org.activiti</groupId> <artifactId>activiti-bpmn-layout</artifactId> <version>${activiti.version}</version> <exclusions> <exclusion> <groupId>com.github.jgraph</groupId> <artifactId>jgraphx</artifactId> </exclusion> </exclusions> </dependency>
因为其实没有该依赖也不影响使用
2.3 添加log4j日志配置文件
因为引入了log4j
的Maven
坐标,所以需要在项目的resources
目录下,增加log4j.properties
配置文件。
这样系统就会根据配置文件中的配置去输出日志了。
# Set root category priority to INFO and its only appender to CONSOLE.
#log4j.rootCategory=INFO, CONSOLE debug info warn error fatal
log4j.rootCategory=debug, CONSOLE, LOGFILE
# Set the enterprise logger category to FATAL and its only appender to CONSOLE.
log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE
# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r[%15.15t] %-5p %30.30c %x - %m\n
# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=F:\activiti\activiti.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r[%15.15t] %-5p %30.30c %x - %m\n
可以根据项目需求或者个人喜好进行更改。
注意:
log4j.appender.LOGFILE.File
配置的值F:\activiti\activiti.log
在F
盘的对应路径下,activiti.log
文件需要提前存在,要不然会报文件找不到的异常。
2.4 添加Activiti配置文件
Activiti
提供的默认方式来创建MySQL
表的要求是在resources
下创建activiti.cfg.xml
文件.
默认方式配置要求:
- 目录和文件名不能修改,因为
Activiti
的源码中已经编写了到固定的目录读取固定文件名的文件。 - 在
activiti.cfg.xml
中bean
的名字叫processEngineConfiguration
,不要修改这个名称。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/contex
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx.xsd">
<!-- 这里可以使用 dbcp 连接池 -->
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
<property name="driverClassName" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql:///activiti" />
<property name="username" value="root" />
<property name="password" value="123456" />
<property name="maxActive" value="3" />
<property name="maxIdle" value="1" />
</bean>
<bean id="processEngineConfiguration"
class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
<!-- 引用数据源 上面已经设置好了-->
<property name="dataSource" ref="dataSource" />
<!-- activiti数据库表处理策略 -->
<property name="databaseSchemaUpdate" value="true"/>
</bean>
</beans>
三、生成Activiti中的25张表
3.1 使用默认方式
就是使用默认的配置文件(配置文件名称和位置不能修改)和流畅引擎类(bean名称不能修改)的方式。
public class TestActiviti {
@Test
public void testCreateDbTable() {
// 使用classpath下的activiti.cfg.xml中的配置创建processEngine
// 而resources下的文件就是处于classpath下的
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
System.out.println(processEngine);
}
}
3.2 使用自定义方式
配置文件的名字可以自定义,bean的名字也可以自定义。
但是下面的代码中还是写的和原来默认一样的配置文件名和bean。
public class TestActiviti {
@Test
public void testCreateDbTable() {
ProcessEngineConfiguration processEngineConfiguration = ProcessEngineConfiguration.
createProcessEngineConfigurationFromResource("activiti.cfg.xml", "processEngineConfiguration");
// 获取流程引擎对象(此时就会创建数据库)
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
}
}
四、表结构解析
执行上面代码后就会在本地的activiti
数据库中创建25
张表。
4.1 表命名规则说明
-
ACT :
ACT
其实也就是Activiti
的意思,就是说这些表都是Activiti
相关的表。 -
ACT_RE :
RE
表示repository
。 这个前缀的表包含了流程定义和流程静态资源 (图片,规则,等等)。 -
ACT_RU:
RU
表示runtime
。 这些运行时的表,包含流程实例,任务,变量,异步任务,等运行中的数据。
Activiti
只在流程实例执行过程中保存这些数据, 在流程结束时就会删除这些记录。 这样运行时表可以一直很小速度很快。
-
ACT_HI:
HI
表示history
。 这些表包含历史数据,比如历史流程实例, 变量,任务等等。 -
ACT_GE :
GE
表示general
。 通用数据, 用于不同场景下
4.2 Activiti数据表说明
表分类 | 表名 | 解释 |
---|---|---|
一般数据 | ||
[ACT_GE_BYTEARRAY] | 通用的流程定义和流程资源 | |
[ACT_GE_PROPERTY] | 系统相关属性 | |
流程历史记录 | ||
[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_RE_DEPLOYMENT] | 部署单元信息 | |
[ACT_RE_MODEL] | 模型信息 | |
[ACT_RE_PROCDEF] | 已部署的流程定义 | |
运行实例表 | ||
[ACT_RU_EVENT_SUBSCR] | 运行时事件 | |
[ACT_RU_EXECUTION] | 运行时流程执行实例 | |
[ACT_RU_IDENTITYLINK] | 运行时用户关系信息,存储任务节点与参与者的相关信息 | |
[ACT_RU_JOB] | 运行时作业 | |
[ACT_RU_TASK] | 运行时任务 | |
[ACT_RU_VARIABLE] | 运行时变量表 |
五、Activiti的基本类关系
在Activiti7
中,已经删除了IdentityService
,FormService
两个Serivce
类。
activiti.cfg.xml
是Activiti
的引擎配置文件。
包括ProcessEngineConfiguration
的定义、数据源定义、事务管理器等。相当于一个Spring
配置文件。
ProcessEngineConfiguration
可以用来创建ProceccEngine
。
而ProceccEngine
又可以获取管理Activiti
中各种核心Service
。
5.1 ProcessEngineConfiguration
流程引擎的配置类(ProcessEngineConfiguration
),通过ProcessEngineConfiguration
可以创建工作流引擎ProceccEngine
。
创建processEngineConfiguration也有两种方式:
-
方式一:固定名称
下边的代码要求
activiti.cfg.xml
中必须有一个processEngineConfiguration
的bean
。ProcessEngineConfiguration configuration = ProcessEngineConfiguration.createProcessEngineConfigurationFromResource("activiti.cfg.xml")
-
方式一:自定义名称
activiti.cfg.xml
配置文件名称可更改,processEngineConfiguration
的bean
名称可更改。ProcessEngineConfiguration.createProcessEngineConfigurationFromResource(String resource, String beanName);
5.2 ProcessEngineConfiguration
工作流引擎(ProcessEngine
),相当于一个统一管理接口。
通过ProcessEngineConfiguration
创建processEngine
,通过ProcessEngine
获取各个Service
接口。
-
方式一:固定名称
下边的代码要求
activiti.cfg.xml
中必须有一个processEngineConfiguration
的bean
。// 直接使用工具类 ProcessEngines,使用classpath下的activiti.cfg.xml中的配置创建processEngine ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine(); System.out.println(processEngine);
-
方式一:自定义名称
activiti.cfg.xml
配置文件名称可更改,processEngineConfiguration
的bean
名称可更改。//先构建ProcessEngineConfiguration ProcessEngineConfiguration configuration = ProcessEngineConfiguration.createProcessEngineConfigurationFromResource("activiti.cfg.xml"); //通过ProcessEngineConfiguration创建ProcessEngine,此时会创建数据库 ProcessEngine processEngine = configuration.buildProcessEngine();
5.3 Servcie服务接口
各类Service
服务接口是工作流引擎提供用于进行工作流部署、执行、管理的服务接口。
使用这些接口可以就是操作服务对应的数据表。
1)service概览
service名称 | service作用 |
---|---|
RepositoryService | activiti的资源管理类 |
RuntimeService | activiti的流程运行管理类 |
TaskService | activiti的任务管理类 |
HistoryService | activiti的历史管理类 |
ManagerService | activiti的引擎管理类 |
-
RepositoryService:
Activiti
的资源管理类,提供了管理和控制流程发布包和流程定义的操作。使用工作流建模工具设计的业务流程图需要使用此service将流程定义文件的内容部署到计算机。
除了部署流程定义以外还可以查询引擎中的发布包和流程定义,暂停或激活发布包,对应全部和特定流程定义。
暂停意味着它们不能再执行任何操作了,激活是对应的反向操作。获得多种资源,像是包含在发布包里的文件, 或引擎自动生成的流程图。
获得流程定义的
pojo
版本, 可以用来通过Java
解析流程,而不必通过xml
。 -
RuntimeService
Activiti
的流程运行管理类。可以从这个服务类中获取很多关于流程执行相关的信息 -
TaskService
Activiti
的任务管理类。可以从这个类中获取任务的信息。 -
HistoryService
Activiti
的历史管理类,可以查询历史信息,执行流程时,引擎会保存很多数据(根据配置),比如流程实例启动时间,任务的参与者, 完成任务的时间,每个流程实例的执行路径,等等。 这个服务主要通过查询功能来获得这些数据。 -
ManagementService
Activiti
的引擎管理类,提供了对Activiti
流程引擎的管理和维护功能,这些功能不在工作流驱动的应用程序中使用,主要用于Activiti
系统的日常维护。
2)Service创建方式
通常通过ProcessEngine
创建各类Service
,就以RuntimeService
为例,其余Service
也是一样的。
RuntimeService runtimeService = processEngine.getRuntimeService();
RepositoryService repositoryService = processEngine.getRepositoryService();
TaskService taskService = processEngine.getTaskService();
ce**
Activiti
的引擎管理类,提供了对 Activiti
流程引擎的管理和维护功能,这些功能不在工作流驱动的应用程序中使用,主要用于 Activiti
系统的日常维护。
2)Service创建方式
通常通过ProcessEngine
创建各类Service
,就以RuntimeService
为例,其余Service
也是一样的。
RuntimeService runtimeService = processEngine.getRuntimeService();
RepositoryService repositoryService = processEngine.getRepositoryService();
TaskService taskService = processEngine.getTaskService();