https://www.activiti.org/
------------------------------------------------------------------------------------------
Activiti工作流
概念
工作流。通过计算机对业务流程自动化执行管理,主要解决的是“使在多个参与者之间按照某种预定义的规则自动进行传递文档、信息或任务的过程,从而实现某个预期的业务目标,或者促使此目标的实现”。
Activiti7
介绍
Activiti是一个工作流引擎,Activiti可以将业务系统中复杂的业务流程抽取出来,使用专门的建模语言BPMN2.0进行定义,业务流程按照预先定义的流程进行执行,实现了系统的流程由Activiti进行管理,减少业务系统由于流程变更进行系统升级改造的工作量,从而提高系统的健壮性,同时也减少了系统开发维护成本。
在使用activiti之前,首先需要编写activiti.cfg.xml配置文件。并且引入相关依赖。
<dependencies>
<!--activiti的核心包-->
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-engine</artifactId>
<version>6.0.0</version>
</dependency>
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-spring</artifactId>
<version>6.0.0</version>
</dependency>
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-bpmn-model</artifactId>
<version>6.0.0</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
</dependency>
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-bpmn-converter</artifactId>
<version>6.0.0</version>
</dependency>
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-json-converter</artifactId>
<version>6.0.0</version>
</dependency>
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-bpmn-layout</artifactId>
<version>6.0.0</version>
</dependency>
<dependency>
<groupId>org.activiti.cloud</groupId>
<artifactId>activiti-cloud-services-api</artifactId>
<version>7-201710-EA</version>
</dependency>
<dependency>
<groupId>aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.5.4</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.40</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>5.0.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>4.1.6.RELEASE</version>
</dependency>
<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>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.21</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.6</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.18</version>
<scope>provided</scope>
</dependency>
</dependencies>
---------------------------
activiti.cfg.xml
activiti的引擎配置文件,包括:ProcessEngineConfiguration的定义、数据源定义、事务管理器等。其实就是一个Spring配置文件。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.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://localhost:3306/activiti"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
<property name="maxActive" value="3"/>
<property name="maxIdle" value="1"/>
</bean>
<!--在默认方式下,bean的id固定为processEngineConfiguration-->
<bean id="processEngineConfiguration" class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
<!--配置数据库相关信息-->
<property name="dataSource" ref="dataSource"/>
<!--
activiti数据库表处理策略
false(默认值):检查数据库的版本和依赖库的版本,如果不匹配就抛出异常
true:构建流程引擎时,执行检查,如果需要就执行更新。如果表不存在,就创建。
create-drop:构建流程引擎时创建数据库报表,关闭流程引擎时就删除这些表。
drop-create:先删除表再创建表。
create:构建流程引擎时创建数据库表,关闭流程引擎时不删除这些表
-->
<property name="databaseSchemaUpdate" value="true"/>
<property name="asyncExecutorActivate" value="false"/>
<property name="mailServerHost" value="mail.my-corp.com"/>
<property name="mailServerPort" value="5025"/>
</bean>
</beans>
Activiti流程框架,在前期主要需要了解的就是数据库表的创建、流程的部署、流程的启动和各个阶段任务的完成。
流程引擎配置类
流程引擎配置类(ProcessEngineConfiguration),通过 ProcessEngineConfiguration 可以创建工作流引擎 ProceccEngine。
工作流引擎的创建
工作流引擎的创建主要有两种方式:默认创建方式和一般创建方式
默认创建方式
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
System.out.println(processEngine);
一般创建方式
//使用自定义方式创建
ProcessEngineConfiguration processEngineConfiguration = ProcessEngineConfiguration.createProcessEngineConfigurationFromResource("activiti.cfg.xml");
//获取流程引擎对象:通过 ProcessEngineConfiguration 创建 ProcessEngine,此时会创建数据库
ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine();
当创建好工作流引擎后,对应的数据库中会自动生成25张数据库表。
ACT_GE_PROPERTY中会先展示下一次流程的ID(next.dbid),并且在下一次流程部署的时候,对下一次流程的ID进行赋值。
Activiti表说明
这里以表名的前缀进行说明:
Activiti表 Activiti表说明
ACT_RE 流程定义和流程资源
ACT_RU 运行时,流程实例、任务、变量
ACT_HI 历史表
ACT_GE 通用表
Service服务接口
Activiti中还有许多的Service服务接口。这些Service 是工作流引擎提供用于进行工作流部署、执行、管理的服务接口,我们可以使用这些接口操作服务对应的数据表。
Service创建方式
通过ProcessEngine创建Service方式:
Runtimeservice runtimeService = processEngine.getRuntimeService();
RepositoryService repositoryService = processEngine.getRepositoryService();
TaskService taskService = processEngine.getTaskService();
----------------------
Service总览
service名称 service作用
RepositoryService Activiti的资源管理类
RuntimeService Activiti的流程运行管理类
TaskService Activiti的任务管理类
HistoryService Activiti的历史管理类
ManagementService Activiti的引擎管理类
RepositoryService
Activiti 的资源管理类,提供了管理和控制流程发布包和流程定义的操作。使用工作流建模工具设计的业务流程图需要使用此service将流程定义文件的内容部署到计算机。除了部署流程定义以外,还可以查询引擎中的发布包和流程定义。暂停或激活发布包,对应全部和特定流程定义。暂停意味着它们不能再执行任何操作了,激活是对应的反向操作。获得多种资源,像是包含在发布包里的文件,或引擎自动生成的流程图。获得流程定义的pojo版本,可以用来通过java解析流程,而不必通过xml。
Runtimeservice
Activiti的流程运行管理类。可以从这个服务类中获取很多关于流程执行相关的信息
Taskservice
Activiti的任务管理类。可以从这个类中获取任务的信息。
Historyservice
Activiti的历史管理类,可以查询历史信息,执行流程时,引擎会保存很多数据(根据配置),比如流程实例启动时间,任务的参与者,完成任务的时间,每个流程实例的执行路径,等等。这个服务主要通过查询功能来获得这些数据。
ManagementService
Activiti的引擎管理类,提供了对Activiti流程引擎的管理和维护功能,这些功能不在工作流驱动的应用程序中使用,主要用于Activiti 系统的日常维护。
流程图符号说明
BPMN插件
使用IDEA进行开发,建议下载一个插件。actiBPM插件,直接搜索下载。
流程符号、画流程图
流程符号:事件Event,活动Activity,网关Gateway,流向
使用流程设计器画出流程图
创建bpmn文件,在流程设计器使用流程符号来表达流程,指定流程的key,指定任务负责人
生成png文件
创建的bpmn文件要放在resourse下的bpmn文件夹下。
注意: 当前任务流程的ID不能是数字开头。
找到本地的文件,选择notepad打开
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:activiti="http://activiti.org/bpmn" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:omgdc="http://www.omg.org/spec/DD/20100524/DC" xmlns:omgdi="http://www.omg.org/spec/DD/20100524/DI" xmlns:tns="http://www.activiti.org/test" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" expressionLanguage="http://www.w3.org/1999/XPath" id="m1611283406582" name="" targetNamespace="http://www.activiti.org/test" typeLanguage="http://www.w3.org/2001/XMLSchema">
<process id="myEvection" isClosed="false" isExecutable="true" name="出差申请" processType="None">
<startEvent id="_2" name="StartEvent"/>
<userTask activiti:assignee="zhangsan" activiti:exclusive="true" id="_3" name="创建出差申请"/>
<userTask activiti:assignee="jerry" activiti:exclusive="true" id="_4" name="经理审批"/>
<userTask activiti:assignee="jack" activiti:exclusive="true" id="_5" name="总经理审批"/>
<userTask activiti:assignee="rose" activiti:exclusive="true" id="_6" name="财务审批"/>
<endEvent id="_7" name="EndEvent"/>
<sequenceFlow id="_8" sourceRef="_2" targetRef="_3"/>
<sequenceFlow id="_9" sourceRef="_3" targetRef="_4"/>
<sequenceFlow id="_10" sourceRef="_4" targetRef="_5"/>
<sequenceFlow id="_11" sourceRef="_5" targetRef="_6"/>
<sequenceFlow id="_12" sourceRef="_6" targetRef="_7"/>
</process>
<bpmndi:BPMNDiagram documentation="background=#FFFFFF;count=1;horizontalcount=1;orientation=0;width=842.4;height=1195.2;imageableWidth=832.4;imageableHeight=1185.2;imageableX=5.0;imageableY=5.0" id="Diagram-_1" name="New Diagram">
<bpmndi:BPMNPlane bpmnElement="myEvection">
<bpmndi:BPMNShape bpmnElement="_2" id="Shape-_2">
<omgdc:Bounds height="32.0" width="32.0" x="185.0" y="0.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="32.0" width="32.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="_3" id="Shape-_3">
<omgdc:Bounds height="55.0" width="85.0" x="160.0" y="85.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="55.0" width="85.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="_4" id="Shape-_4">
<omgdc:Bounds height="55.0" width="85.0" x="160.0" y="185.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="55.0" width="85.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="_5" id="Shape-_5">
<omgdc:Bounds height="55.0" width="85.0" x="160.0" y="285.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="55.0" width="85.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="_6" id="Shape-_6">
<omgdc:Bounds height="55.0" width="85.0" x="160.0" y="390.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="55.0" width="85.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="_7" id="Shape-_7">
<omgdc:Bounds height="32.0" width="32.0" x="185.0" y="475.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="32.0" width="32.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNEdge bpmnElement="_12" id="BPMNEdge__12" sourceElement="_6" targetElement="_7">
<omgdi:waypoint x="201.0" y="445.0"/>
<omgdi:waypoint x="201.0" y="475.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="0.0" width="0.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="_8" id="BPMNEdge__8" sourceElement="_2" targetElement="_3">
<omgdi:waypoint x="201.0" y="32.0"/>
<omgdi:waypoint x="201.0" y="85.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="0.0" width="0.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="_9" id="BPMNEdge__9" sourceElement="_3" targetElement="_4">
<omgdi:waypoint x="202.5" y="140.0"/>
<omgdi:waypoint x="202.5" y="185.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="0.0" width="0.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="_11" id="BPMNEdge__11" sourceElement="_5" targetElement="_6">
<omgdi:waypoint x="202.5" y="340.0"/>
<omgdi:waypoint x="202.5" y="390.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="0.0" width="0.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="_10" id="BPMNEdge__10" sourceElement="_4" targetElement="_5">
<omgdi:waypoint x="202.5" y="240.0"/>
<omgdi:waypoint x="202.5" y="285.0"/>
<bpmndi:BPMNLabel>
<omgdc:Bounds height="0.0" width="0.0" x="0.0" y="0.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNEdge>
</bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
</definitions>
流程的操作
部署流程
使用 Activiti 提供的 API 把流程图的内容写入到数据库中
属于资源操作类,使用 RepositoryService
单文件部署:把bpmn文件和png文件逐个处理
压缩包部署:把bpmn文件和png文件打成压缩包来处理
部署操作表:act_re_deployment、act_re_procdef、act_ge_bytearray
/**
* 流程部署
*/
public void deployment() {
// 创建 ProcessEngine
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
// 获取 RepositoryService
RepositoryService repositoryService = processEngine.getRepositoryService();
// 使用 service 进行流程的部署,定义一个流程的名字,把bpmn和png部署到数据中
Deployment deployment = repositoryService.createDeployment()
.name("出差申请流程") //流程图标的名字
.addClasspathResource("bpmn/evection.bpmn") //bpmn文件
.addClasspathResource("bpmn/evection.png") //bpmn文件生成的图片
.deploy();
// 输出部署信息
System.out.println("流程部署ID:" + deployment.getId());
System.out.println("流程部署名字:" + deployment.getName());
}
有时候我们会有多个流程,需要创建多个bpmn流程文件,这个时候想要同时部署,我们可以对bpmn文件进行打包压缩,使用Zip包进行批量的部署
/**
* 使用Zip包进行批量的部署
*/
@Test
public void deployProcessByZip() {
// 获取流程引擎
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
// 获取 RepositoryService
RepositoryService repositoryService = processEngine.getRepositoryService();
// 流程部署
// 读取资源包文件,构造成 InputStream
InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("bpmn/evection.zip");
// 使用 InputStream 构造 ZipInputStream
ZipInputStream zipInputStream = new ZipInputStream(inputStream);
// 使用压缩包的流,进行流程的部署
Deployment deploy = repositoryService.createDeployment()
.addZipInputStream(zipInputStream)
.deploy();
// 输出
System.out.println("流程部署的ID:" + deploy.getId());
System.out.println("流程部署的名称:" + deploy.getName());
}
操作的数据库表:
act_ge_bytearray、act_ge_property、act_re_deployment、act_re_procdef
启动流程实例
流程部署完成以后,需要启动流程实例。使用 RuntimeService 根据流程定义的 key进行启动。
核心代码:
/**
* 启动流程
*/
public void starProcess() {
// 创建 ProcessEngine
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
// 获取 RunTimeService
RuntimeService runtimeService = processEngine.getRuntimeService();
// 根据流程定义的ID启动流程
ProcessInstance instance = runtimeService.startProcessInstanceByKey("myEvection");
// 输出内容
System.out.println("流程定义ID:" + instance.getProcessDefinitionId());
System.out.println("流程实例的ID:" + instance.getId());
System.out.println("当前活动的ID:" + instance.getActivityId());
}
任务查询
使用 TaskService ,根据流程定义的 key ,任务负责人来进行查询
核心代码:
/**
* 查询个人待执行的任务
*/
@Test
public void findPersonalTaskList() {
// 获取流程引擎
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
// 获取TaskService
TaskService taskService = processEngine.getTaskService();
// 根据流程的key和任务的负责人去查询任务
List<Task> taskList = taskService.createTaskQuery()
.processDefinitionKey("myEvection") // 流程的key
.includeProcessVariables()
.taskAssignee("zhangsan") // 要查询的负责人
.list();
// 输出
for (Task task : taskList) {
System.out.println("流程实例的ID:" + task.getProcessInstanceId());
System.out.println("任务的ID:" + task.getId());
System.out.println("任务的负责人:" + task.getAssignee());
System.out.println("任务的名称:" + task.getName());
}
}
任务完成
使用 TaskService ,用任务 ID 直接完成任务。
核心代码:
/**
* 完成个人任务
*/
@Test
public void completTask() {
String key = "testCandidiate";
String assignee = "张三1"; //任务的负责人
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
TaskService taskService = processEngine.getTaskService();
Task task = taskService.createTaskQuery()
.processDefinitionKey(key)
.taskAssignee(assignee)
.singleResult();
if (task != null) {
taskService.complete(task.getId());
}
}
关于流程实例的挂起和激活
全部流程实例的挂起和激活
/**
* 全部流程实例的挂起和激活
*/
@Test
public void suspendAllProcessInstance() {
// 1.获取流程引擎
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
// 2.获取 RepositoryService
RepositoryService repositoryService = processEngine.getRepositoryService();
// 3.查询流程定义
ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
.processDefinitionKey("myEvection")
.singleResult();
// 4.获取当前流程定义的实例是否都是挂起状态
boolean flag = processDefinition.isSuspended();
// 5.获取流程定义的ID
String id = processDefinition.getId();
// 6.判断是否挂起状态。是:改为激活;否:改为挂起
if (flag) {
// 改为激活. 参数1:流程定义的ID,参数2:是否激活,参数3:激活时间
repositoryService.activateProcessDefinitionById(id, true, null);
System.out.println("流程定义ID:" + id + "已激活");
} else {
// 改为挂起. 参数1:流程定义的ID;参数2:是否挂起;参数3:挂起时间
repositoryService.suspendProcessDefinitionById(id, true, null);
System.out.println("流程定义ID:" + id + "已挂起");
}
}
单个流程实例的挂起和激活
/**
* 单个流程实例的挂起和激活
*/
@Test
public void suspendSingleProcessInstance() {
// 1.获取流程引擎
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
// 2.获取 RuntimeService
RuntimeService runtimeService = processEngine.getRuntimeService();
// 3.通过 RuntimeService 获取流程实例对象
ProcessInstance instance = runtimeService.createProcessInstanceQuery()
.processInstanceId("17501")
.singleResult();
// 4.得到当前流程实例的暂停状态
boolean flag = instance.isSuspended();
// 5.获取流程实例的ID
String instanceId = instance.getId();
// 6.判断是否暂停。是:改为激活;否:改为暂停
if (flag) {
runtimeService.activateProcessInstanceById(instanceId);
System.out.println("流程实例ID:" + instanceId + "已激活");
} else {
runtimeService.suspendProcessInstanceById(instanceId);
System.out.println("流程实例ID:" + instanceId + "已暂停");
}
}
注意: 流程实例在挂起的状态下是无法进行下一步操作的。
流程变量
我们在使用流程变量的时候。如果我们将一个对象存储到一个流程变量中,那么这个对象需要实现Serializable接口。
/**
* 出差申请中的流程变量对象
*/
@NoArgsConstructor
@AllArgsConstructor
@Data
public class Evection implements Serializable {
private Long id; //主键ID
private Integer days; //出差天数
private String evectionName; //出差单名字
private Date startTime; //出差开始时间
private Date endTime; //出差结束时间
private String address; //目的地
private String reason; //出差原因
}
流程变量的作用域
整个流程实例、任务、执行实例。
默认:整个流程实例。
使用方法
在属性上使用UEL表达式 ${assignee},assignee就是一个流程变量的名称。
在连线上使用UEL表达式 ${days<=3},days就是一个流程变量名称,返回结果为true或者false。
Activiti有很多种方式设置流程变量,这里简单介绍两种
启动流程时设置流程变量
/**
* 启动流程
*/
@Test
public void startProcess() {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
RuntimeService runtimeService = processEngine.getRuntimeService();
// 流程变量map
Map<String, Object> map = new HashMap<>();
// 设置流程变量
Evection evection = new Evection();
evection.setDays(2);
// 把流程变量的pojo放入map
map.put("evection", evection);
map.put("assignee0", "张三");
map.put("assignee1", "李经理");
map.put("assignee2", "王财务");
map.put("assignee3", "赵总经理");
runtimeService.startProcessInstanceByKey("myProcess_1", map);
}
任务办理时设置
/**
* 完成任务
*/
@Test
public void completTask() {
ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
TaskService taskService = processEngine.getTaskService();
Evection evection = new Evection();
evection.setDays(2);
Map<String, Object> map = new HashMap<>();
map.put("evection", evection);
Task task = taskService.createTaskQuery()
.processDefinitionKey("myProcess_2")
.taskAssignee("王财务0")
.singleResult();
if (task != null) {
String taskId = task.getId();
// 完成任务
taskService.complete(taskId, map);
}
}
网关
用来控制流程的走向
排他网关——ExclusiveGateway
用来在流程中实现决策,当流程执行到这个网关,所有的分支都会判断条件是否为true,如果为true,则执行该分支。
注意: 排他网关只会选择一个作为true的分支执行,如果有两个分支都为true,排他网关会选择ID值比较小的一条分支去执行。
如果从排他网关出去的流程所有的条件都不满足,则会抛出异常。
并行网关——ParallelGateway
并行网关,允许流程分成多条分支,也可以把多分支汇聚到一起,并行网关的功能是基于进入和外出顺序流的:
fork分支:并行后的所有外出顺序流,为每个顺序流都创建一个并发分支
join汇聚:所有到达并行网关,在此等待的分支,直到所有进入顺序流的分支都到达以后,流程就会通过汇聚网关。
注意: 如果同一个并行网关有多个进入和多个外出顺序流,它就同时具有分支和汇聚功能,这时,网关会先汇聚所有进入的顺序流,然后再切分成多个并行分支。
与其他网关的主要区别是:并行网关不会解析条件,即使顺序流中定义了条件,也会被忽略。
并行网关需要所有分支的全部运行完了,才会汇聚,继续向下执行。
包含网关——InclusiveGateway
包含网关可以看成是排他网关和并行网关的结合体,和排他网关一样,可以在外出顺序流上定义条件,包含网关会解析它们,但是主要的区别是:包含网关可以选择多于一条顺序流,这和并行网关一样。
包含网关的功能是基于进入和外出顺序流的。
分支:
所有外出顺序流的条件都会被解析,结果为true的顺序流会以并行方式继续执行,会为每一个顺序流创建一个分支。
汇聚:
所有并行分支到达包含网关,会进入等待状态,直到每个包含流程token的进入顺序流的分支都到达。这是和并行网关最大的不同。
事件网关——EventGateway
Activiti和Spring的整合开发
配置文件:
<?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:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx.xsd">
<!--工作流引擎配置对象-->
<bean id="processEngineConfiguration" class="org.activiti.spring.SpringProcessEngineConfiguration">
<!--数据源-->
<property name="dataSource" ref="dataSource"/>
<!--使用Spring的事务管理器-->
<property name="transactionManager" ref="transactionManager"/>
<!--
数据库策略:
false:默认值。activiti在启动时,会对比数据库表中保存的版本。如果没有表或者版本不匹配,将抛出 异常。
true:activiti会对数据库中所有表进行更新操作,如果表不存在,则会自动创建。
create_drop:在activiti启动时创建表,在关闭时删除表(必须手动关闭引擎,才能删除表)。
drop-create:在activiti启动时删除原来的旧表,然后再创建新表(不需要手动关闭引擎)。
-->
<property name="databaseSchemaUpdate" value="true"/>
</bean>
<!--配置数据源-->
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
<property name="driverClassName" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/actspring"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
<property name="maxActive" value="3"/>
<property name="maxIdle" value="1"/>
</bean>
<!-- 流程引擎对象 -->
<bean id="processEngine" class="org.activiti.spring.ProcessEngineFactoryBean">
<property name="processEngineConfiguration" ref="processEngineConfiguration"/>
</bean>
<!--资源服务-->
<bean id="repositoryService" factory-bean="processEngine" factory-method="getRepositoryService"/>
<!--流程管理-->
<bean id="runtimeService" factory-bean="processEngine" factory-method="getRuntimeService"/>
<!--任务管理-->
<bean id="taskService" factory-bean="processEngine" factory-method="getTaskService"/>
<!--历史管理-->
<bean id="historyService" factory-bean="processEngine" factory-method="getHistoryService"/>
<!--事务管理器-->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource"/>
</bean>
<!--通知-->
<tx:advice id="txAdvice" transaction-manager="transactionManager">
<tx:attributes>
<!--传播行为-->
<tx:method name="save*" propagation="REQUIRED"/>
<tx:method name="insert*" propagation="REQUIRED"/>
<tx:method name="delete*" propagation="REQUIRED"/>
<tx:method name="update*" propagation="REQUIRED"/>
<tx:method name="find*" propagation="SUPPORTS" read-only="true"/>
<tx:method name="get*" propagation="SUPPORTS" read-only="true"/>
</tx:attributes>
</tx:advice>
</beans>
Activiti和SpringBoot的整合开发
配置文件:
spring:
application:
name: actspringboot
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/actspring?useUnicode=true&characterEncoding=utf-8&useSSL=false&autoReconnect=true&serverTimezone=UTC
username: root
password: root
activiti:
# false:默认值。activiti在启动时,会对比数据库表中保存的版本。如果没有表或者版本不匹配,将抛出异常
# true:activiti会对数据库中所有表进行更新操作,如果表不存在,则会自动创建
# create_drop:在activiti启动时创建表,在关闭时删除表(必须手动关闭引擎,才能删除表)
# drop-create:在activiti启动时删除原来的旧表,然后再创建新表(不需要手动关闭引擎)
# 线上一般使用false,开发中使用true
database-schema-update: true
# 自动部署验证设置:true-开启(默认)、false-关闭
check-process-definitions: false
# 开启历史表
db-history-used: true
# 历史记录存储等级
history-level: full
server:
port: 8082
------------------------------------------------------------------------------------------
工作流
工作流简介
- 工作流(Workflow): 工作流就是通过计算机技术对业务流程进行自动化管理。实现多个参与者按照预定的流程去自动执行业务流程。
- 定义: 通过计算机对业务流程自动化执行管理
- 主要解决的是: 使在多个参与者之间按照某种预定义的规则自动进行传递文档,信息或任务的过程.从而实现某个预期的业务目标,或者促使此目标的实现
- 工作流管理系统的目标:
- 管理工作的流程以确保工作在正确的时间被期望的人员所执行
- 在自动化进行的业务过程中插入人工的执行和干预
- 工作流框架:
- Activiti,JBPM,OSWorkFlow,WorkFlow
- 工作流框架底层需要有数据库提供支持
工作流术语
工作流引擎
- ProcessEngine对象: 这是Activiti工作的核心.负责生成流程运行时的各种实例及数据,监控和管理流程的运行
BPM
- 业务流程管理:
- 是一种以规范化的构造端到端的卓越业务流程为中心,以持续的提高组织业务绩效为目的的系统化方法
- 常见商业管理教育如EMBA,MBA等均将BPM包含在内
BPMN
- 业务流程建模与标注:
- 这些图如何组合成一个业务流程图(Business Process Diagram)
- 讨论BPMN的各种的用途:包括以何种精度来影响一个流程图中的模型
- BPMN作为一个标准的价值
- BPMN未来发展的远景
流对象
一个业务流程图有三个流对象的核心元素
- 事件
- 一个事件用圆圈来描述,表示一个业务流程期间发生的东西
- 事件影响流程的流动.一般有一个原因(触发器)或一个影响(结果)
- 基于它们对流程的影响,有三种事件:开始事件,中间事件,终止事件
-
-
活动
-
用圆角矩形表示,一个流程由一个活动或多个活动组成
-
-
-
条件
- 条件用菱形表示,用于控制序列流的分支与合并。
- 可以作为选择,包括路径的分支与合并
- 内部的标记会给出控制流的类型
Activiti开源工作流框架
Activiti简介
- Activiti是一个开源的工作流引擎,它实现了BPMN 2.0规范,可以发布设计好的流程定义,并通过api进行流程调度
- Activiti 作为一个遵从 Apache 许可的工作流和业务流程管理开源平台,其核心是基于Java的超快速,超稳定的 BPMN2.0 流程引擎,强调流程服务的可嵌入性和可扩展性,同时更加强调面向业务人员
- Activiti 流程引擎重点关注在系统开发的易用性和轻量性上.每一项BPM业务功能Activiti流程引擎都以服务的形式提供给开发人员.通过使用这些服务,开发人员能够构建出功能丰富,轻便且高效的BPM应用程序
Activiti服务结构
-
Activiti系统服务结构图
- -
核心类:
- ProcessEngine: 流程引擎的抽象,可以通过此类获取需要的所有服务
-
服务类:
-
XxxService: 通过ProcessEngine获取,Activiti将不同生命周期的服务封装在不同Service中,包括定义,部署,运行.通过服务类可获取相关生命周期中的服务信息
-
==RepositoryService==
- Repository Service提供了对repository的存取服务
- Activiti中每一个不同版本的业务流程的定义都需要使用一些定义文件,部署文件和支持数据(例如BPMN2.0XML文件,表单定义文件,流程定义图像文件等),这些文件都存储在Activiti内建的Repository中
-
==RuntimeService==
- Runtime Service提供了启动流程,查询流程实例,设置获取流程实例变量等功能.此外它还提供了对流程部署,流程定义和流程实例的存取服务
-
==TaskService==
- Task Service提供了对用户Task和Form相关的操作.它提供了运行时任务查询,领取,完成,删除以及变量设置等功能
-
==HistoryService==
- History Service用于获取正在运行或已经完成的流程实例的信息,与Runtime Service中获取的流程信息不同,历史信息包含已经持久化存储的永久信息,并已经被针对查询优化
-
==FormService==
- 使用Form Service可以存取启动和完成任务所需的表单数据并且根据需要来渲染表单
- Activiti中的流程和状态Task均可以关联业务相关的数据
-
==IdentityService==
- Identity Service提供了对Activiti系统中的用户和组的管理功能
- Activiti中内置了用户以及组管理的功能,必须使用这些用户和组的信息才能获取到相应的Task
-
ManagementService
- Management Service提供了对Activiti流程引擎的管理和维护功能
- 这些功能不在工作流驱动的应用程序中使用,主要用于 Activiti 系统的日常维护
-
==RepositoryService==
-
XxxService: 通过ProcessEngine获取,Activiti将不同生命周期的服务封装在不同Service中,包括定义,部署,运行.通过服务类可获取相关生命周期中的服务信息
-
核心业务对象:
- org.activiti.engine.impl.persistence.entity包下的类,包括Task,ProcessInstance,Execution等
- 根据不同职责实现相应接口的方法(如需要持久化则继承PersistentObject接口),与传统的实体类不同
Activiti组件
-
==Activiti上下文组件Context:== 用来保存生命周期比较长,全局性的信息,类似Application.主要包括如下三类:
- CommandContext: 命令上下文-保存每个命令必要的资源,如持久化需要的session
- ProcessEngineConfigurationImpl: 流程引擎相关配置信息-整个引擎全局的配置信息.如数据源DataSource等.该对象为单例,在流程引擎创建的时候初始化
- ExecutionContext: 持有ExecutionEntity对象
-
==持久化组件:==
- Activiti使用mybatis作OR映射,并在此基础上增加设计了自己的持久化框架
- 在流程引擎创建时初始化,顶层接口Session,SessionFactory
- Session有两个实现类:
- DbSqlSession: 负责sql表达式的执行
- AbstractManager: 负责对象的持久化操作
- SessionFactory有两个实现类:
- DbSqlSessionFactory: 负责DbSqlSession相关操作
- GenericManagerFactory: 负责AbstractManager相关操作
-
==Event-Listener组件:==
- Activiti允许客户代码介入流程执行,提供了事件监听组件
- 监听的事件类型:
- TaskListener
- JavaDelegate
- Expression
- ExecutionListener
- ProcessEngineConfigurationImpl持有DelegateInterceptor的某个实例,方便调用handleInvocation
-
==Cache组件==
- DbSqlSession中有cache的实现
- Activiti基于List和Map来做缓存:如查询时先查缓存,没有则直接查询并放入缓存
-
==异步执行组件==
- Activiti可以执行任务,JobExecutor为其核心类,JobExecutor包含三个主要属性:
- JobAcquisitionThread
- BlockingQueue
- ThreadPoolExecutor
- 方法ProcessEngines在引擎启动时调用JobExecutor.start,JobAcquisitionThread 线程即开始工作,其run方法不断循环执行AcquiredJobs中的job,执行一次后线程等待一定时间直到超时或者JobExecutor.jobWasAdded方法,因为有新任务而被调用。
- Activiti可以执行任务,JobExecutor为其核心类,JobExecutor包含三个主要属性:
流程虚拟机PVM
- 流程虚拟机API暴露了流程虚拟机的POJO核心,流程虚拟机API描述了一个工作流流程必备的组件,这些组件包括:
- PvmProcessDefinition: 流程的定义,形象点说就是用户画的那个图.静态含义
- PvmProcessInstance: 流程实例,用户发起的某个PvmProcessDefinition的一个实例.动态含义
- PvmActivity: 流程中的一个节点
- PvmTransition: 衔接各个节点之间的路径,形象点说就是图中各个节点之间的连接线
- PvmEvent: 流程执行过程中触发的事件
Activiti架构
在这里插入图片描述-
Activiti Engine:
- 最核心的模块
- 提供针对BPMN 2.0规范的解析,执行,创建,管理(任务,流程实例),查询历史记录并根据结果生成报表
-
Activiti Modeler:
- 模型设计器
- 适用于业务人员把需求转换为规范流程定义
-
Activiti Designer:
- 功能和Activiti Modeler类似,同样提供了基于BPMN 2.0规范的可视化设计功能,但是目前还没有完全支持BPMN规范的定义
- 可以把业务需求人员用Signavio设计的流程定义(XML格式)导入到Designer中,从而让开发人员将其进一步加工成为可以运行的流程定义
-
Activiti Explorer:
- 可以用来管理仓库,用户,组,启动流程,任务办理等
- 此组件使用REST风格API,提供一个基础的设计模型.如果业务简单,也可以直接使用无需开发.还可以作为后台管理员的流程、任务管理系统使用
-
Activiti REST:
- 提供RESTful风格的服务
- 允许客户端以JSON的方式与引擎的REST API交互
- 通用的协议具有跨平台,跨语言的特性
Activiti数据库支持
- Activiti的后台由有数据库的支持
- 所有的表都以ACT_开头
- 第二部分是表示表的用途的两个字母标识
- 用途也和服务的API对应
ACT_RE_* : 'RE'表示repository. 这个前缀的表包含了流程定义和流程静态资源(图片,规则...)
ACT_RU_* : 'RU'表示runtime.这些运行时的表, 包含流程实例,任务,变量,异步任务,等运行中的数据.
Activiti只在流程实例执行过程中保存这些数据,在流程结束时就会删除这些记录.这样运行时表可以一直很小速度很快
ACT_ID_* : 'ID'表示identity.这些表包含身份信息, 比如用户,组...
ACT_HI_* : 'HI'表示history.这些表包含历史数据, 比如历史流程实例,变量,任务...
ACT_GE_* :通用数据. 用于不同场景下, 如存放资源文件
- 资源库流程规则表 (ACT_RE_*:'RE'表示repository. 这个前缀的表包含了流程定义和流程静态资源(图片,规则...))
act_re_deployment 部署信息表
act_re_model 流程设计模型部署表
act_re_procdef 流程定义数据表
- 运行时数据库表 (ACT_RU_*:'RU'表示runtime.这些运行时的表, 包含流程实例,任务,变量,异步任务,等运行中的数据.Activiti只在流程实例执行过程中保存这些数据,在流程结束时就会删除这些记录.这样运行时表可以一直很小速度很快)
act_ru_execution 运行时流程执行实例表
act_ru_identitylink 运行时流程人员表,主要存储任务节点与参与者的相关信息
act_ru_task 运行时任务节点表
act_ru_variable 运行时流程变量数据表
- 组织机构表 (ACT_ID_* : 'ID'表示identity.这些表包含身份信息, 比如用户,组...)
act_id_group 用户组信息表
act_id_info 用户扩展信息表
act_id_membership 用户与用户组对应信息表
act_id_user 用户信息表
这四张表很常见,基本的组织机构管理,关于用户认证方面建议还是自己开发一套,组件自带的功能太简单,使用中有很多需求难以满足
- 历史数据库表 (ACT_HI_*:'HI'表示history.这些表包含历史数据, 比如历史流程实例,变量,任务...)
act_hi_actinst 历史节点表
act_hi_attachment 历史附件表
act_hi_comment 历史意见表
act_hi_identitylink 历史流程人员表
act_hi_detail 历史详情表,提供历史变量的查询
act_hi_procinst 历史流程实例表
act_hi_taskinst 历史任务实例表
act_hi_varinst 历史变量表
- 组织机构表 (ACT_GE_*:通用数据. 用于不同场景下, 如存放资源文件)
act_ge_bytearray 二进制数据表
act_ge_property 属性数据表存储整个流程引擎级别的数据,初始化表结构时,会默认插入三条记录
Activiti配置文件
- activiti.cfg.xml: Activiti核心配置文件,配置流程引擎创建工具的基本参数和数据库连接池参数
- 定义数据库配置参数
- 配置连接池参数
Activiti特点
数据持久化
- Activiti的设计思想是简洁,快速
- 瓶颈体现在和数据库交换数据的过程中,针对这一点Activiti选择了使MyBatis,从而可以通过最优的SQL语句执行Command,仅凭如此就能让引擎在速度上保持最高的性能
引擎service接口
- Activiti流程引擎重点关注在系统开发的易用性和轻量性上,每一项BPM业务功能Activiti流程引擎都以服务的形式提供给开发人员,通过使用这些服务,开发人员能够构建出功能丰富,轻便且高效的BPM应用程序
- activiti.cfg.xml文件为核心配置文件,该配置文件集成在Spring的IOC容器当中,可以产生ProcessEngineConfiguration对象,这个对象就是流程引擎的配置对象
- ProcessEngine对象为流程引擎对象,该对象是工作流业务系统的核心,所有的业务操作都是由这个对象所派生出来的对象实现
- Activiti引擎提供了七大Service接口,均通过ProcessEngine获取,并且支持链式API编程风格
流程设计器
- 基于Web的Activiti Modeler流程设计器
- IDEA的actiBPM插件
原生支持Spring
- Activiti原生支持Spring,可以很轻松地进行Spring集成,非常方便管理事务和解析表达式(Expression)
分离运行时与历史数据
- Activiti继承自jBPM4,在表结构设计方面也遵循运行时与历史数据的分离
- 这样的设计可以快速读取运行时数据,仅当需要查询历史数据时再从专门的历史数据表中读取.这种设计方式可以大幅提高数据的存取效率,尤其是当数据日积月累时依然能够快速反应
一、工作流介绍
1.1 概念
工作流(Workflow),就是通过计算机对业务流程自动化执行管理。它主要解决的是“使在多个参与者之间按照某种预定义的规则自动进行传递文档、信息或任务的过程,从而实现某个预期的业务目标,或者促使此目标的实现”。
1.2 工作流系统
一个软件系统中具有工作流的功能,我们把它称为工作流系统,一个系统中工作流的功能是什么?就是对系统的业务流程进行自动化管理,所以工作流是建立在业务流程的基础上,所以一个软件的系统核心根本上还是系统的业务流程,工作流只是协助进行业务流程管理。即使没有工作流业务系统也可以开发运行,只不过有了工作流可以更好的管理业务流程,提高系统的可扩展性。
1.3 适用行业
消费品行业,制造业,电信服务业,银证险等金融服务业,物流服务业,物业服务业,物业管理,大中型进出口贸易公司,政府事业机构,研究院所及教育服务业等,特别是大的跨国企业和集团公司。
1.4 具体应用
1、关键业务流程: 订单、报价处理、合同审核、客户电话处理、供应链管理等
2、行政管理类: 出差申请、加班申请、请假申请、用车申请、各种办公用品申请、购买申请、日报周报等凡是原来手工流转处理的行政表单。
3、人事管理类: 员工培训安排、绩效考评、职位变动处理、员工档案信息管理等。
4、财务相关类: 付款请求、应收款处理、日常报销处理、出差报销、预算和计划申请等。
5、客户服务类: 客户信息管理、客户投诉、请求处理、售后服务管理等。
6、特殊服务类: ISO系列对应流程、质量管理对应流程、产品数据信息管理、贸易公司报关处理、物流公司货物跟踪处理等各种通过表单逐步手工流转完成的任务均可应用工作流软件自动规范地实施。
1.5 实现方式
在没有专门的工作流引擎之前,我们之前为了实现流程控制,通常的做法就是采用状态字段的值来跟踪流程的变化情况。这样不同角色的用户,通过状态字段的取值来决定记录是否显示。
针对有权限可以查看的记录,当前用户根据自己的角色来决定审批是否合格的操作。如果合格将状态字段设置一个值,来代表合格;当然如果不合格也需要设置一个值来代表不合格的情况。
这是一种最为原始的方式。通过状态字段虽然做到了流程控制,但是当我们的流程发生变更的时候,这种方式所编写的代码也要进行调整。
那么有没有专业的方式来实现工作流的管理呢?并且可以做到业务流程变化之后,我们的程序可以不用改变,如果可以实现这样的效果,那么我们的业务系统的适应能力就得到了极大提升。
二、Activiti7概述
2.1 介绍
Alfresco软件在2010年5月17日宣布Activiti业务流程管理(BPM)开源项目的正式启动,其首席架构师由业务流程管理BPM的专家 Tom Baeyens担任,Tom Baeyens就是原来jbpm的架构师,而jbpm是一个非常有名的工作流引擎,当然activiti也是一个工作流引擎。
Activiti是一个工作流引擎, activiti可以将业务系统中复杂的业务流程抽取出来,使用专门的建模语言BPMN2.0进行定义,业务流程按照预先定义的流程进行执行,实现了系统的流程由activiti进行管理,减少业务系统由于流程变更进行系统升级改造的工作量,从而提高系统的健壮性,同时也减少了系统开发维护成本。
官方网站:https://www.activiti.org/
经历的版本:
目前最新版本:Activiti7.0.0.Beta
2.1.1 BPM
BPM(Business Process Management),即业务流程管理,是一种规范化的构造端到端的业务流程,以持续的提高组织业务效率。常见商业管理教育如EMBA、MBA等均将BPM包含在内。
2.1.2 BPM软件
BPM软件就是根据企业中业务环境的变化,推进人与人之间、人与系统之间以及系统与系统之间的整合及调整的经营方法与解决方案的IT工具。
通过BPM软件对企业内部及外部的业务流程的整个生命周期进行建模、自动化、管理监控和优化,使企业成本降低,利润得以大幅提升。
BPM软件在企业中应用领域广泛,凡是有业务流程的地方都可以BPM软件进行管理,比如企业人事办公管理、采购流程管理、公文审批流程管理、财务管理等。
2.1.3 BPMN
BPMN(Business Process Model AndNotation)- 业务流程模型和符号 是由BPMI(BusinessProcess Management Initiative)开发的一套标准的业务流程建模符号,使用BPMN提供的符号可以创建业务流程。
2004年5月发布了BPMN1.0规范.BPMI于2005年9月并入OMG(The Object Management Group对象管理组织)组织。OMG于2011年1月发布BPMN2.0的最终版本。
具体发展历史如下:
BPMN 是目前被各 BPM 厂商广泛接受的 BPM 标准。Activiti 就是使用 BPMN 2.0 进行流程建模、流程执行管理,它包括很多的建模符号,比如:Event
用一个圆圈表示,它是流程中运行过程中发生的事情。
活动用圆角矩形表示,一个流程由一个活动或多个活动组成
Bpmn图形其实是通过xml表示业务流程,上边的.bpmn文件使用文本编辑器打开:
- <?xml version="1.0" encoding="UTF-8"?>
- <definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:activiti="http://activiti.org/bpmn" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:omgdc="http://www.omg.org/spec/DD/20100524/DC" xmlns:omgdi="http://www.omg.org/spec/DD/20100524/DI" typeLanguage="http://www.w3.org/2001/XMLSchema" expressionLanguage="http://www.w3.org/1999/XPath" targetNamespace="http://www.activiti.org/test">
- <process id="myProcess" name="My process" isExecutable="true">
- <startEvent id="startevent1" name="Start"></startEvent>
- <userTask id="usertask1" name="创建请假单"></userTask>
- <sequenceFlow id="flow1" sourceRef="startevent1" targetRef="usertask1"></sequenceFlow>
- <userTask id="usertask2" name="部门经理审核"></userTask>
- <sequenceFlow id="flow2" sourceRef="usertask1" targetRef="usertask2"></sequenceFlow>
- <userTask id="usertask3" name="人事复核"></userTask>
- <sequenceFlow id="flow3" sourceRef="usertask2" targetRef="usertask3"></sequenceFlow>
- <endEvent id="endevent1" name="End"></endEvent>
- <sequenceFlow id="flow4" sourceRef="usertask3" targetRef="endevent1"></sequenceFlow>
- </process>
- <bpmndi:BPMNDiagram id="BPMNDiagram_myProcess">
- <bpmndi:BPMNPlane bpmnElement="myProcess" id="BPMNPlane_myProcess">
- <bpmndi:BPMNShape bpmnElement="startevent1" id="BPMNShape_startevent1">
- <omgdc:Bounds height="35.0" width="35.0" x="130.0" y="160.0"></omgdc:Bounds>
- </bpmndi:BPMNShape>
- <bpmndi:BPMNShape bpmnElement="usertask1" id="BPMNShape_usertask1">
- <omgdc:Bounds height="55.0" width="105.0" x="210.0" y="150.0"></omgdc:Bounds>
- </bpmndi:BPMNShape>
- <bpmndi:BPMNShape bpmnElement="usertask2" id="BPMNShape_usertask2">
- <omgdc:Bounds height="55.0" width="105.0" x="360.0" y="150.0"></omgdc:Bounds>
- </bpmndi:BPMNShape>
- <bpmndi:BPMNShape bpmnElement="usertask3" id="BPMNShape_usertask3">
- <omgdc:Bounds height="55.0" width="105.0" x="510.0" y="150.0"></omgdc:Bounds>
- </bpmndi:BPMNShape>
- <bpmndi:BPMNShape bpmnElement="endevent1" id="BPMNShape_endevent1">
- <omgdc:Bounds height="35.0" width="35.0" x="660.0" y="160.0"></omgdc:Bounds>
- </bpmndi:BPMNShape>
- <bpmndi:BPMNEdge bpmnElement="flow1" id="BPMNEdge_flow1">
- <omgdi:waypoint x="165.0" y="177.0"></omgdi:waypoint>
- <omgdi:waypoint x="210.0" y="177.0"></omgdi:waypoint>
- </bpmndi:BPMNEdge>
- <bpmndi:BPMNEdge bpmnElement="flow2" id="BPMNEdge_flow2">
- <omgdi:waypoint x="315.0" y="177.0"></omgdi:waypoint>
- <omgdi:waypoint x="360.0" y="177.0"></omgdi:waypoint>
- </bpmndi:BPMNEdge>
- <bpmndi:BPMNEdge bpmnElement="flow3" id="BPMNEdge_flow3">
- <omgdi:waypoint x="465.0" y="177.0"></omgdi:waypoint>
- <omgdi:waypoint x="510.0" y="177.0"></omgdi:waypoint>
- </bpmndi:BPMNEdge>
- <bpmndi:BPMNEdge bpmnElement="flow4" id="BPMNEdge_flow4">
- <omgdi:waypoint x="615.0" y="177.0"></omgdi:waypoint>
- <omgdi:waypoint x="660.0" y="177.0"></omgdi:waypoint>
- </bpmndi:BPMNEdge>
- </bpmndi:BPMNPlane>
- </bpmndi:BPMNDiagram>
- </definitions>
2.2 使用步骤
部署activiti
Activiti是一个工作流引擎(其实就是一堆jar包API),业务系统访问(操作)activiti的接口,就可以方便的操作流程相关数据,这样就可以把工作流环境与业务系统的环境集成在一起。
流程定义
使用activiti流程建模工具(activity-designer)定义业务流程(.bpmn文件) 。
.bpmn文件就是业务流程定义文件,通过xml定义业务流程。
流程定义部署
activiti部署业务流程定义(.bpmn文件)。
使用activiti提供的api把流程定义内容存储起来,在Activiti执行过程中可以查询定义的内容
Activiti执行把流程定义内容存储在数据库中
启动一个流程实例
流程实例也叫:ProcessInstance
启动一个流程实例表示开始一次业务流程的运行。
在员工请假流程定义部署完成后,如果张三要请假就可以启动一个流程实例,如果李四要请假也启动一个流程实例,两个流程的执行互相不影响。
用户查询待办任务(Task)
因为现在系统的业务流程已经交给activiti管理,通过activiti就可以查询当前流程执行到哪了,当前用户需要办理什么任务了,这些activiti帮我们管理了,而不需要开发人员自己编写在sql语句查询。
用户办理任务
用户查询待办任务后,就可以办理某个任务,如果这个任务办理完成还需要其它用户办理,比如采购单创建后由部门经理审核,这个过程也是由activiti帮我们完成了。
流程结束
当任务办理完成没有下一个任务结点了,这个流程实例就完成了。
三、Activiti环境
3.1 开发环境
-
Jdk1.8或以上版本
-
Mysql 5及以上的版本
-
Tomcat8.5
-
IDEA
注意:activiti的流程定义工具插件可以安装在IDEA下,也可以安装在Eclipse工具下
3.2 Activiti环境
我们使用:Activiti7.0.0.Beta1
默认支持spring5
3.2.1 下载activiti7
Activiti下载地址:http://activiti.org/download.html
,Maven的依赖如下:
- <dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.activiti</groupId>
- <artifactId>activiti-dependencies</artifactId>
- <version>7.0.0.Beta1</version>
- <scope>import</scope>
- <type>pom</type>
- </dependency>
- </dependencies>
- </dependencyManagement>
1) Database:
activiti运行需要有数据库的支持,支持的数据库有:h2, mysql, oracle, postgres, mssql, db2。
3.2.2 流程设计器IDEA下安装
在IDEA的File菜单中找到子菜单”Settings”,后面我们再选择左侧的“plugins”菜单,如下图所示:
此时我们就可以搜索到actiBPM插件,它就是Activiti Designer
的IDEA版本,我们点击Install安装。
安装好后,页面如下:
提示需要重启idea,点击重启。
重启完成后,再次打开Settings 下的 Plugins(插件列表),点击右侧的Installed(已安装的插件),在列表中看到actiBPM,就说明已经安装成功了,如下图所示:
后面的课程里,我们会使用这个流程设计器进行Activiti的流程设计。
3.3 Activiti的数据库支持
Activiti 在运行时需要数据库的支持,使用25张表,把流程定义节点内容读取到数据库表中,以供后续使用。
3.3.1 Activiti 支持的数据库
activiti 支持的数据库和版本如下:
3.3.2 在MySQL生成表
3.3.2.1 创建数据库
创建 mysql 数据库 activiti (名字任意):
CREATE DATABASE activiti DEFAULT CHARACTER SET utf8;
3.3.2.2 使用java代码生成表
-
创建 java 工程
使用idea 创建 java 的maven工程,取名:activiti01。
-
加入 maven 依赖的坐标(jar 包)
首先需要在 java 工程中加入 ProcessEngine 所需要的 jar 包,包括:
-
activiti-engine-7.0.0.beta1.jar
-
activiti 依赖的 jar 包:mybatis、 alf4j、 log4j 等
-
activiti 依赖的 spring 包
-
mysql数据库驱动
-
第三方数据连接池 dbcp
-
单元测试 Junit-4.12.jar
我们使用 maven 来实现项目的构建,所以应当导入这些 jar 所对应的坐标到 pom.xml 文件中。
完整的依赖内容如下:
- <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>
- <dependency>
- <groupId>org.activiti</groupId>
- <artifactId>activiti-engine</artifactId>
- <version>${activiti.version}</version>
- </dependency>
- <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驱动 -->
- <dependency>
- <groupId>mysql</groupId>
- <artifactId>mysql-connector-java</artifactId>
- <version>5.1.40</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>
-
添加log4j日志配置
我们使用log4j日志包,可以对日志进行配置
在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:\act\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
-
添加activiti配置文件
我们使用activiti提供的默认方式来创建mysql的表。
默认方式的要求是在 resources 下创建 activiti.cfg.xml
文件,注意:默认方式目录和文件名不能修改,因为activiti的源码中已经设置,到固定的目录读取固定文件名的文件。
- <?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">
- </beans>
-
在 activiti.cfg.xml 中进行配置
默认方式要在在activiti.cfg.xml
中bean的名字叫processEngineConfiguration
,名字不可修改
在这里有2中配置方式:一种是单独配置数据源,一种是不单独配置数据源
1、直接配置processEngineConfiguration
processEngineConfiguration
用来创建 ProcessEngine
,在创建 ProcessEngine
时会执行数据库的操作。
- <?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">
- <!-- 默认id对应的值 为processEngineConfiguration -->
- <!-- processEngine Activiti的流程引擎 -->
- <bean id="processEngineConfiguration"
- class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
- <property name="jdbcDriver" value="com.mysql.jdbc.Driver"/>
- <property name="jdbcUrl" value="jdbc:mysql:///activiti"/>
- <property name="jdbcUsername" value="root"/>
- <property name="jdbcPassword" value="123456"/>
- <!-- activiti数据库表处理策略 -->
- <property name="databaseSchemaUpdate" value="true"/>
- </bean>
- </beans>
2、配置数据源后,在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>
-
java类编写程序生成表
创建一个测试类,调用activiti的工具类,生成acitivti需要的数据库表。
直接使用activiti提供的工具类ProcessEngines
,会默认读取classpath下的activiti.cfg.xml
文件,读取其中的数据库配置,创建 ProcessEngine
,在创建ProcessEngine
时会自动创建表。
代码如下:
- package com.itheima.activiti01.test;
- import org.activiti.engine.ProcessEngine;
- import org.activiti.engine.ProcessEngineConfiguration;
- import org.junit.Test;
- public class TestDemo {
- /**
- * 生成 activiti的数据库表
- */
- @Test
- public void testCreateDbTable() {
- //使用classpath下的activiti.cfg.xml中的配置创建processEngine
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- System.out.println(processEngine);
- }
- }
说明:
-
运行以上程序段即可完成 activiti 表创建,通过改变
activiti.cfg.xml
中databaseSchemaUpdate
参数的值执行不同的数据表处理策略。 -
上 边 的 方法
getDefaultProcessEngine
方法在执行时,从activiti.cfg.xml
中找固定的名称processEngineConfiguration
。
在测试程序执行过程中,idea的控制台会输出日志,说明程序正在创建数据表,类似如下,注意红线内容:
执行完成后我们查看数据库, 创建了 25 张表,结果如下:
到这,我们就完成activiti运行需要的数据库和表的创建。
3.4 表结构介绍
3.4.1 表的命名规则和作用
看到刚才创建的表,我们发现Activiti 的表都以 ACT_
开头。
第二部分是表示表的用途的两个字母标识。用途也和服务的 API 对应。
-
ACT_RE
:'RE’表示 repository。这个前缀的表包含了流程定义和流程静态资源 (图片,规则,等等)。 -
ACT_RU
:'RU’表示 runtime。这些运行时的表,包含流程实例,任务,变量,异步任务,等运行中的数据。Activiti 只在流程实例执行过程中保存这些数据, 在流程结束时就会删除这些记录。这样运行时表可以一直很小速度很快。 -
ACT_HI
:'HI’表示 history。这些表包含历史数据,比如历史流程实例, 变量,任务等等。 -
ACT_GE
:GE 表示 general。通用数据, 用于不同场景下
3.4.2 Activiti数据表介绍
四、Activiti类关系图
上面我们完成了Activiti数据库表的生成,java代码中我们调用Activiti的工具类,下面来了解Activiti的类关系
4.1 类关系图
在新版本中,我们通过实验可以发现IdentityService
,FormService
两个Serivce都已经删除了。
所以后面我们对于这两个Service也不讲解了,但老版本中还是有这两个Service,同学们需要了解一下
4.2 activiti.cfg.xml
activiti的引擎配置文件,包括:ProcessEngineConfiguration
的定义、数据源定义、事务管理器等,此文件其实就是一个spring配置文件。
4.3 流程引擎配置类
流程引擎的配置类(ProcessEngineConfiguration
),通过ProcessEngineConfiguration
可以创建工作流引擎ProceccEngine
,常用的两种方法如下:
4.3.1 StandaloneProcessEngineConfiguration
使用StandaloneProcessEngineConfigurationActiviti
可以单独运行,来创建ProcessEngine
,Activiti
会自己处理事务。
配置文件方式:
通常在activiti.cfg.xml
配置文件中定义一个id为 processEngineConfiguration
的bean。
方法如下:
- <bean id="processEngineConfiguration"
- class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
- <!--配置数据库相关的信息-->
- <!--数据库驱动-->
- <property name="jdbcDriver" value="com.mysql.jdbc.Driver"/>
- <!--数据库链接-->
- <property name="jdbcUrl" value="jdbc:mysql:///activiti"/>
- <!--数据库用户名-->
- <property name="jdbcUsername" value="root"/>
- <!--数据库密码-->
- <property name="jdbcPassword" value="123456"/>
- <!--actviti数据库表在生成时的策略 true - 如果数据库中已经存在相应的表,那么直接使用,如果不存在,那么会创建-->
- <property name="databaseSchemaUpdate" value="true"/>
- </bean>
还可以加入连接池:
- <?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">
- <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-->
- <bean id="processEngineConfiguration"
- class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
- <!--引入上面配置好的 链接池-->
- <property name="dataSource" ref="dataSource"/>
- <!--actviti数据库表在生成时的策略 true - 如果数据库中已经存在相应的表,那么直接使用,如果不存在,那么会创建-->
- <property name="databaseSchemaUpdate" value="true"/>
- </bean>
- </beans>
4.3.2 SpringProcessEngineConfiguration
通过org.activiti.spring.SpringProcessEngineConfiguration
与Spring整合。
创建spring与activiti的整合配置文件:
activity-spring.cfg.xml
(名称可修改)
- <beans xmlns="http://www.springframework.org/schema/beans"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mvc="http://www.springframework.org/schema/mvc"
- xmlns:context="http://www.springframework.org/schema/context"
- xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx"
- xsi:schemaLocation="http://www.springframework.org/schema/beans
- http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
- http://www.springframework.org/schema/mvc
- http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd
- http://www.springframework.org/schema/context
- http://www.springframework.org/schema/context/spring-context-3.1.xsd
- http://www.springframework.org/schema/aop
- http://www.springframework.org/schema/aop/spring-aop-3.1.xsd
- http://www.springframework.org/schema/tx
- http://www.springframework.org/schema/tx/spring-tx-3.1.xsd ">
- <!-- 工作流引擎配置bean -->
- <bean id="processEngineConfiguration" class="org.activiti.spring.SpringProcessEngineConfiguration">
- <!-- 数据源 -->
- <property name="dataSource" ref="dataSource" />
- <!-- 使用spring事务管理器 -->
- <property name="transactionManager" ref="transactionManager" />
- <!-- 数据库策略 -->
- <property name="databaseSchemaUpdate" value="drop-create" />
- <!-- activiti的定时任务关闭 -->
- <property name="jobExecutorActivate" value="false" />
- </bean>
- <!-- 流程引擎 -->
- <bean id="processEngine" class="org.activiti.spring.ProcessEngineFactoryBean">
- <property name="processEngineConfiguration" ref="processEngineConfiguration" />
- </bean>
- <!-- 资源服务service -->
- <bean id="repositoryService" factory-bean="processEngine"
- factory-method="getRepositoryService" />
- <!-- 流程运行service -->
- <bean id="runtimeService" factory-bean="processEngine"
- factory-method="getRuntimeService" />
- <!-- 任务管理service -->
- <bean id="taskService" factory-bean="processEngine"
- factory-method="getTaskService" />
- <!-- 历史管理service -->
- <bean id="historyService" factory-bean="processEngine" factory-method="getHistoryService" />
- <!-- 用户管理service -->
- <bean id="identityService" factory-bean="processEngine" factory-method="getIdentityService" />
- <!-- 引擎管理service -->
- <bean id="managementService" factory-bean="processEngine" factory-method="getManagementService" />
- <!-- 数据源 -->
- <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
- <property name="driverClassName" value="com.mysql.jdbc.Driver" />
- <property name="url" value="jdbc:mysql://localhost:3306/activiti" />
- <property name="username" value="root" />
- <property name="password" value="mysql" />
- <property name="maxActive" value="3" />
- <property name="maxIdle" value="1" />
- </bean>
- <!-- 事务管理器 -->
- <bean id="transactionManager"
- class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
- <property name="dataSource" ref="dataSource" />
- </bean>
- <!-- 通知 -->
- <tx:advice id="txAdvice" transaction-manager="transactionManager">
- <tx:attributes></tx:attributes>
- <!-- 传播行为 -->
- <tx:method name="save*" propagation="REQUIRED" />
- <tx:method name="insert*" propagation="REQUIRED" />
- <tx:method name="delete*" propagation="REQUIRED" />
- <tx:method name="update*" propagation="REQUIRED" />
- <tx:method name="find*" propagation="SUPPORTS" read-only="true" />
- <tx:method name="get*" propagation="SUPPORTS" read-only="true" />
- </tx:attributes>
- </tx:advice>
- <!-- 切面,根据具体项目修改切点配置 -->
- <aop:config proxy-target-class="true">
- <aop:advisor advice-ref="txAdvice" pointcut="execution(* com.itheima.ihrm.service.impl.*.(..))"* />
- </aop:config>
- </beans>
创建processEngineConfiguration
ProcessEngineConfiguration configuration = ProcessEngineConfiguration.createProcessEngineConfigurationFromResource("activiti.cfg.xml")
上边的代码要求activiti.cfg.xml
中必须有一个processEngineConfiguration
的bean
也可以使用下边的方法,更改bean 的名字:
ProcessEngineConfiguration.createProcessEngineConfigurationFromResource(String resource, String beanName);
4.4 工作流引擎创建
工作流引擎(ProcessEngine),相当于一个门面接口,通过ProcessEngineConfiguration
创建processEngine
,通过ProcessEngine
创建各个service接口。
4.4.1 默认创建方式
将activiti.cfg.xml
文件名及路径固定,且activiti.cfg.xml
文件中有 processEngineConfiguration
的配置, 可以使用如下代码创建processEngine
:
- //直接使用工具类 ProcessEngines,使用classpath下的activiti.cfg.xml中的配置创建processEngine
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- System.out.println(processEngine);
4.4.2 一般创建方式
- //先构建ProcessEngineConfiguration
- ProcessEngineConfiguration configuration = ProcessEngineConfiguration.createProcessEngineConfigurationFromResource("activiti.cfg.xml");
- //通过ProcessEngineConfiguration创建ProcessEngine,此时会创建数据库
- ProcessEngine processEngine = configuration.buildProcessEngine();
4.5 Servcie服务接口
Service是工作流引擎提供用于进行工作流部署、执行、管理的服务接口,我们使用这些接口可以就是操作服务对应的数据表
4.5.1 Service创建方式
通过ProcessEngine创建Service
方式如下:
- RuntimeService runtimeService = processEngine.getRuntimeService();
- RepositoryService repositoryService = processEngine.getRepositoryService();
- TaskService taskService = processEngine.getTaskService();
4.5.2 Service总览
简单介绍:
-
RepositoryService
是activiti的资源管理类,提供了管理和控制流程发布包和流程定义的操作。使用工作流建模工具设计的业务流程图需要使用此service将流程定义文件的内容部署到计算机。
除了部署流程定义以外还可以:查询引擎中的发布包和流程定义。
暂停或激活发布包,对应全部和特定流程定义。暂停意味着它们不能再执行任何操作了,激活是对应的反向操作。获得多种资源,像是包含在发布包里的文件, 或引擎自动生成的流程图。
获得流程定义的pojo版本, 可以用来通过java解析流程,而不必通过xml。
-
RuntimeService
Activiti的流程运行管理类。可以从这个服务类中获取很多关于流程执行相关的信息
-
TaskService
Activiti的任务管理类。可以从这个类中获取任务的信息。
-
HistoryService
Activiti的历史管理类,可以查询历史信息,执行流程时,引擎会保存很多数据(根据配置),比如流程实例启动时间,任务的参与者, 完成任务的时间,每个流程实例的执行路径,等等。这个服务主要通过查询功能来获得这些数据。
-
ManagementService
Activiti的引擎管理类,提供了对 Activiti 流程引擎的管理和维护功能,这些功能不在工作流驱动的应用程序中使用,主要用于 Activiti 系统的日常维护。
五、Activiti入门
在本章内容中,我们来创建一个Activiti工作流,并启动这个流程。
创建Activiti工作流主要包含以下几步:
-
定义流程,按照BPMN的规范,使用流程定义工具,用流程符号把整个流程描述出来
-
部署流程,把画好的流程定义文件,加载到数据库中,生成表的数据
-
启动流程,使用java代码来操作数据库表中的内容
5.1 流程符号
BPMN 2.0是业务流程建模符号2.0的缩写。
它由Business Process Management Initiative这个非营利协会创建并不断发展。作为一种标识,BPMN 2.0是使用一些符号来明确业务流程设计流程图的一整套符号规范,它能增进业务建模时的沟通效率。
目前BPMN2.0是最新的版本,它用于在BPM上下文中进行布局和可视化的沟通。
接下来我们先来了解在流程设计中常见的 符号。
BPMN2.0的基本符合主要包含:
事件 Event
活动 Activity
活动是工作或任务的一个通用术语。一个活动可以是一个任务,还可以是一个当前流程的子处理流程;其次,你还可以为活动指定不同的类型。常见活动如下:
网关 GateWay
网关用来处理决策,有几种常用网关需要了解:
排他网关 (x)
——只有一条路径会被选择。流程执行到该网关时,按照输出流的顺序逐个计算,当条件的计算结果为true时,继续执行当前网关的输出流;
-
如果多条线路计算结果都是 true,则会执行第一个值为 true 的线路。如果所有网关计算结果没有true,则引擎会抛出异常。
-
排他网关需要和条件顺序流结合使用,default 属性指定默认顺序流,当所有的条件不满足时会执行默认顺序流。
并行网关 (+)
——所有路径会被同时选择
-
拆分 —— 并行执行所有输出顺序流,为每一条顺序流创建一个并行执行线路。
-
合并 —— 所有从并行网关拆分并执行完成的线路均在此等候,直到所有的线路都执行完成才继续向下执行。
包容网关 (+)
—— 可以同时执行多条线路,也可以在网关上设置条件
-
拆分 —— 计算每条线路上的表达式,当表达式计算结果为true时,创建一个并行线路并继续执行
-
合并 —— 所有从并行网关拆分并执行完成的线路均在此等候,直到所有的线路都执行完成才继续向下执行。
事件网关 (+)
—— 专门为中间捕获事件设置的,允许设置多个输出流指向多个不同的中间捕获事件。当流程执行到事件网关后,流程处于等待状态,需要等待抛出事件才能将等待状态转换为活动状态。
流向 Flow
流是连接两个流程节点的连线。常见的流向包含以下几种:
5.2 流程设计器使用
Activiti-Designer使用
Palette(画板)
在idea中安装插件即可使用,画板中包括以下结点:
-
Connection—连接
-
Event—事件
-
Task—任务
-
Gateway—网关
-
Container—容器
-
Boundary event—边界事件
-
Intermediate event- -中间事件
流程图设计完毕保存生成.bpmn文件
新建流程(IDEA工具)
首先选中存放图形的目录(选择resources下的bpmn目录),点击菜单:New -> BpmnFile
,如图:
弹出如下图所示框,输入evection 表示 出差审批流程:
起完名字evection后(默认扩展名为bpmn),就可以看到流程设计页面,如图所示:
左侧区域是绘图区,右侧区域是palette画板区域
鼠标先点击画板的元素即可在左侧绘图
绘制流程
使用滑板来绘制流程,通过从右侧把图标拖拽到左侧的画板,最终效果如下:
指定流程定义Key
流程定义key即流程定义的标识,通过properties视图查看流程的key
指定任务负责人
在properties视图指定每个任务结点的负责人,如:填写出差申请的负责人为 zhangsan
-
经理审批负责人为 jerry
-
总经理审批负责人为 jack
-
财务审批负责人为 rose
六、流程操作
6.1 流程定义
概述
流程定义是线下按照bpmn2.0标准去描述 业务流程,通常使用idea中的插件对业务流程进行建模。IDEA插件介绍:IDEA 值得推荐的十几款优秀插件,狂,拽,屌!
使用idea下的designer设计器绘制流程,并会生成两个文件:.bpmn和.png
.bpmn文件
使用activiti-desinger设计业务流程,会生成.bpmn文件,上面我们已经创建好了bpmn文件
BPMN 2.0根节点是definitions节点。这个元素中,可以定义多个流程定义(不过我们建议每个文件只包含一个流程定义, 可以简化开发过程中的维护难度)。
注意,definitions元素 最少也要包含xmlns 和 targetNamespace的声明。targetNamespace可以是任意值,它用来对流程实例进行分类。
-
流程定义部分:定义了流程每个结点的描述及结点之间的流程流转。
-
流程布局定义:定义流程每个结点在流程图上的位置坐标等信息。
生成.png图片文件
IDEA工具中的操作方式
1、修改文件后缀为xml
首先将evection.bpmn文件改名为evection.xml,如下图:
evection.xml修改前的bpmn文件,效果如下:
2、使用designer设计器打开.xml文件
在evection.xml文件上面,点右键并选择Diagrams菜单,再选择Show BPMN2.0 Designer…
3、查看打开的文件
打开后,却出现乱码,如图:
4、解决中文乱码
1、打开Settings,找到File Encodings,把encoding的选项都选择UTF-8
2、打开IDEA安装路径,找到如下的安装目录
根据自己所安装的版本来决定,我使用的是64位的idea,所以在idea64.exe.vmoptions
文件的最后一行追加一条命令: -Dfile.encoding=UTF-8
如下所示:
一定注意,不要有空格,否则重启IDEA时会打不开,然后 重启IDEA。
如果以上方法已经做完,还出现乱码,就再修改一个文件,并在文件的末尾添加:-Dfile.encoding=UTF-8
,然后重启idea,如图:
最后重新在evection.xml文件上面,点右键并选择Diagrams菜单,再选择Show BPMN2.0 Designer…
,看到生成图片,如图:
到此,解决乱码问题
5、导出为图片文件
点击Export To File
的小图标,打开如下窗口,注意填写文件名及扩展名,选择好保存图片的位置:
然后,我们把png文件拷贝到resources下的bpmn目录,并且把evection.xml改名为evection.bpmn。
6.2 流程定义部署
概述
将上面在设计器中定义的流程部署到activiti数据库中,就是流程定义部署。
通过调用activiti的api将流程定义的bpmn和png两个文件一个一个添加部署到activiti中,也可以将两个文件打成zip包进行部署。
单个文件部署方式
分别将bpmn文件和png图片文件部署。
- public class ActivitiDemo {
- /**
- * 部署流程定义
- */
- @Test
- public void testDeployment(){
- // 1、创建ProcessEngine
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- // 2、得到RepositoryService实例
- RepositoryService repositoryService = processEngine.getRepositoryService();
- // 3、使用RepositoryService进行部署
- Deployment deployment = repositoryService.createDeployment()
- .addClasspathResource("bpmn/evection.bpmn") // 添加bpmn资源
- .addClasspathResource("bpmn/evection.png") // 添加png资源
- .name("出差申请流程")
- .deploy();
- // 4、输出部署信息
- System.out.println("流程部署id:" + deployment.getId());
- System.out.println("流程部署名称:" + deployment.getName());
- }
- }
执行此操作后activiti会将上边代码中指定的bpm文件和图片文件保存在activiti数据库。
压缩包部署方式
将evection.bpmn
和evection.png
压缩成zip包。
- @Test
- public void deployProcessByZip() {
- // 定义zip输入流
- InputStream inputStream = this
- .getClass()
- .getClassLoader()
- .getResourceAsStream(
- "bpmn/evection.zip");
- ZipInputStream zipInputStream = new ZipInputStream(inputStream);
- // 获取repositoryService
- RepositoryService repositoryService = processEngine
- .getRepositoryService();
- // 流程部署
- Deployment deployment = repositoryService.createDeployment()
- .addZipInputStream(zipInputStream)
- .deploy();
- System.out.println("流程部署id:" + deployment.getId());
- System.out.println("流程部署名称:" + deployment.getName());
- }
执行此操作后activiti会将上边代码中指定的bpm文件和图片文件保存在activiti数据库。
操作数据表
流程定义部署后操作activiti的3张表如下:
-
act_re_deployment
流程定义部署表,每部署一次增加一条记录 -
act_re_procdef
流程定义表,部署每个新的流程定义都会在这张表中增加一条记录 -
act_ge_bytearray
流程资源表
接下来我们来看看,写入了什么数据:
SELECT * FROM act_re_deployment #流程定义部署表,记录流程部署信息
结果:
SELECT * FROM act_re_procdef #流程定义表,记录流程定义信息
结果:
注意,KEY 这个字段是用来唯一识别不同流程的关键字
SELECT * FROM act_ge_bytearray #资源表
结果:
注意:
act_re_deployment
和act_re_procdef
一对多关系,一次部署在流程部署表生成一条记录,但一次部署可以部署多个流程定义,每个流程定义在流程定义表生成一条记录。每一个流程定义在act_ge_bytearray
会存在两个资源记录,bpmn和png。
建议:一次部署一个流程,这样部署表和流程定义表是一对一有关系,方便读取流程部署及流程定义信息。
6.3 启动流程实例
流程定义部署在activiti后就可以通过工作流管理业务流程了,也就是说上边部署的出差申请流程可以使用了。
针对该流程,启动一个流程表示发起一个新的出差申请单,这就相当于java类与java对象的关系,类定义好后需要new创建一个对象使用,当然可以new多个对象。对于请出差申请流程,张三发起一个出差申请单需要启动一个流程实例,出差申请单发起一个出差单也需要启动一个流程实例。
代码如下:
- /**
- * 启动流程实例
- */
- @Test
- public void testStartProcess(){
- // 1、创建ProcessEngine
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- // 2、获取RunTimeService
- RuntimeService runtimeService = processEngine.getRuntimeService();
- // 3、根据流程定义Id启动流程
- ProcessInstance processInstance = runtimeService
- .startProcessInstanceByKey("myEvection");
- // 输出内容
- System.out.println("流程定义id:" + processInstance.getProcessDefinitionId());
- System.out.println("流程实例id:" + processInstance.getId());
- System.out.println("当前活动Id:" + processInstance.getActivityId());
- }
输出内容如下:
操作数据表
-
act_hi_actinst
流程实例执行历史 -
act_hi_identitylink
流程的参与用户历史信息 -
act_hi_procinst
流程实例历史信息 -
act_hi_taskinst
流程任务历史信息 -
act_ru_execution
流程执行信息 -
act_ru_identitylink
流程的参与用户信息 -
act_ru_task
任务信息
6.4 任务查询
流程启动后,任务的负责人就可以查询自己当前需要处理的任务,查询出来的任务都是该用户的待办任务。
- /**
- * 查询当前个人待执行的任务
- */
- @Test
- public void testFindPersonalTaskList() {
- // 任务负责人
- String assignee = "zhangsan";
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- // 创建TaskService
- TaskService taskService = processEngine.getTaskService();
- // 根据流程key 和 任务负责人 查询任务
- List<Task> list = taskService.createTaskQuery()
- .processDefinitionKey("myEvection") //流程Key
- .taskAssignee(assignee)//只查询该任务负责人的任务
- .list();
- for (Task task : list) {
- System.out.println("流程实例id:" + task.getProcessInstanceId());
- System.out.println("任务id:" + task.getId());
- System.out.println("任务负责人:" + task.getAssignee());
- System.out.println("任务名称:" + task.getName());
- }
- }
输出结果如下:
- 流程实例id:2501
- 任务id:2505
- 任务负责人:zhangsan
- 任务名称:创建出差申请
6.5 流程任务处理
任务负责人查询待办任务,选择任务进行处理,完成任务。
- // 完成任务
- @Test
- public void completTask(){
- // 获取引擎
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- // 获取taskService
- TaskService taskService = processEngine.getTaskService();
- // 根据流程key 和 任务的负责人 查询任务
- // 返回一个任务对象
- Task task = taskService.createTaskQuery()
- .processDefinitionKey("myEvection") //流程Key
- .taskAssignee("zhangsan") //要查询的负责人
- .singleResult();
- // 完成任务,参数:任务id
- taskService.complete(task.getId());
- }
6.6 流程定义信息查询
查询流程相关信息,包含流程定义,流程部署,流程定义版本
- /**
- * 查询流程定义
- */
- @Test
- public void queryProcessDefinition(){
- // 获取引擎
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- // repositoryService
- RepositoryService repositoryService = processEngine.getRepositoryService();
- // 得到ProcessDefinitionQuery 对象
- ProcessDefinitionQuery processDefinitionQuery = repositoryService.createProcessDefinitionQuery();
- // 查询出当前所有的流程定义
- // 条件:processDefinitionKey =evection
- // orderByProcessDefinitionVersion 按照版本排序
- // desc倒叙
- // list 返回集合
- List<ProcessDefinition> definitionList = processDefinitionQuery.processDefinitionKey("myEvection")
- .orderByProcessDefinitionVersion()
- .desc()
- .list();
- // 输出流程定义信息
- for (ProcessDefinition processDefinition : definitionList) {
- System.out.println("流程定义 id="+processDefinition.getId());
- System.out.println("流程定义 name="+processDefinition.getName());
- System.out.println("流程定义 key="+processDefinition.getKey());
- System.out.println("流程定义 Version="+processDefinition.getVersion());
- System.out.println("流程部署ID ="+processDefinition.getDeploymentId());
- }
- }
输出结果:
- 流程定义id:myEvection:1:4
- 流程定义名称:出差申请单
- 流程定义key:myEvection
- 流程定义版本:1
6.7 流程删除
- public void deleteDeployment() {
- // 流程部署id
- String deploymentId = "1";
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- // 通过流程引擎获取repositoryService
- RepositoryService repositoryService = processEngine
- .getRepositoryService();
- //删除流程定义,如果该流程定义已有流程实例启动则删除时出错
- repositoryService.deleteDeployment(deploymentId);
- //设置true 级联删除流程定义,即使该流程有流程实例启动也可以删除,设置为false非级别删除方式,如果流程
- //repositoryService.deleteDeployment(deploymentId, true);
- }
说明:
-
使用repositoryService删除流程定义,历史表信息不会被删除
-
如果该流程定义下没有正在运行的流程,则可以用普通删除。
如果该流程定义下存在已经运行的流程,使用普通删除报错,可用级联删除方法将流程及相关记录全部删除。
先删除没有完成流程节点,最后就可以完全删除流程定义信息
项目开发中级联删除操作一般只开放给超级管理员使用.
6.8 流程资源下载
现在我们的流程资源文件已经上传到数据库了,如果其他用户想要查看这些资源文件,可以从数据库中把资源文件下载到本地。
解决方案有:
-
jdbc对blob类型,clob类型数据读取出来,保存到文件目录
-
使用activiti的api来实现
使用commons-io.jar 解决IO的操作
引入commons-io依赖包
- <dependency>
- <groupId>commons-io</groupId>
- <artifactId>commons-io</artifactId>
- <version>2.6</version>
- </dependency>
通过流程定义对象获取流程定义资源,获取bpmn和png
- import org.apache.commons.io.IOUtils;
- @Test
- public void deleteDeployment(){
- // 获取引擎
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- // 获取repositoryService
- RepositoryService repositoryService = processEngine.getRepositoryService();
- // 根据部署id 删除部署信息,如果想要级联删除,可以添加第二个参数,true
- repositoryService.deleteDeployment("1");
- }
- public void queryBpmnFile() throws IOException {
- // 1、得到引擎
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- // 2、获取repositoryService
- RepositoryService repositoryService = processEngine.getRepositoryService();
- // 3、得到查询器:ProcessDefinitionQuery,设置查询条件,得到想要的流程定义
- ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
- .processDefinitionKey("myEvection")
- .singleResult();
- // 4、通过流程定义信息,得到部署ID
- String deploymentId = processDefinition.getDeploymentId();
- // 5、通过repositoryService的方法,实现读取图片信息和bpmn信息
- // png图片的流
- InputStream pngInput = repositoryService.getResourceAsStream(deploymentId, processDefinition.getDiagramResourceName());
- // bpmn文件的流
- InputStream bpmnInput = repositoryService.getResourceAsStream(deploymentId, processDefinition.getResourceName());
- // 6、构造OutputStream流
- File file_png = new File("d:/evectionflow01.png");
- File file_bpmn = new File("d:/evectionflow01.bpmn");
- FileOutputStream bpmnOut = new FileOutputStream(file_bpmn);
- FileOutputStream pngOut = new FileOutputStream(file_png);
- // 7、输入流,输出流的转换
- IOUtils.copy(pngInput,pngOut);
- IOUtils.copy(bpmnInput,bpmnOut);
- // 8、关闭流
- pngOut.close();
- bpmnOut.close();
- pngInput.close();
- bpmnInput.close();
- }
说明:
-
deploymentId
为流程部署ID -
resource_name
为act_ge_bytearray
表中NAME_列的值 -
使用
repositoryService
的getDeploymentResourceNames
方法可以获取指定部署下得所有文件的名称 -
使用
repositoryService
的getResourceAsStream
方法传入部署ID和资源图片名称可以获取部署下指定名称文件的输入流
最后的将输入流中的图片资源进行输出。
6.9 流程历史信息的查看
即使流程定义已经删除了,流程执行的历史信息通过前面的分析,依然保存在activiti的act_hi_*
相关的表中。所以我们还是可以查询流程执行的历史信息,可以通过HistoryService
来查看相关的历史记录。
- /**
- * 查看历史信息
- */
- @Test
- public void findHistoryInfo(){
- // 获取引擎
- ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
- // 获取HistoryService
- HistoryService historyService = processEngine.getHistoryService();
- // 获取 actinst表的查询对象
- HistoricActivityInstanceQuery instanceQuery = historyService.createHistoricActivityInstanceQuery();
- // 查询 actinst表,条件:根据 InstanceId 查询
- // instanceQuery.processInstanceId("2501");
- // 查询 actinst表,条件:根据 DefinitionId 查询
- instanceQuery.processDefinitionId("myEvection:1:4");
- // 增加排序操作,orderByHistoricActivityInstanceStartTime 根据开始时间排序 asc 升序
- instanceQuery.orderByHistoricActivityInstanceStartTime().asc();
- // 查询所有内容
- List<HistoricActivityInstance> activityInstanceList = instanceQuery.list();
- // 输出
- for (HistoricActivityInstance hi : activityInstanceList) {
- System.out.println(hi.getActivityId());
- System.out.println(hi.getActivityName());
- System.out.println(hi.getProcessDefinitionId());
- System.out.println(hi.getProcessInstanceId());
- System.out.println("<==========================>");
- }
- }
总结
基本功能介绍以及完成了,如果还需要更加高级的功能比如挂起、激活流程实例、流程变量等请参考
-
https://andyoung.blog.csdn.net/article/details/118345330
需要说明的是,Spring Boot 集成的 Activiti 依赖 activiti-spring-boot-starter 中 ,同时也集成了 Security 框架,所以说它可谓是自带权限控制功能,这一点从设计上出发,的确是比较人性化的了,毕竟实际需求中的工作流,往往涉及到特定用户的操作,比如有些工作流只能由某些人发起或者查看,而有些流程,只能由某些人进行审批等
当然你也可以考虑将 Security 换成其他权限控制的框架,或者在初学时,直接将 Security 去掉即可(具体方式网上都有的,可以参考)
据我了解,很多 Spring Boot 框架的 WEB 项目中,往往就是直接采用这两个方式一起进行权限管理的工作流控制的,所以,为了完整起见,我们今天就直接来学习 Activiti 与 Spring Security 结合来实现工作流控制的方法与步骤
本次演示信息如下(均为当前最新版本):
- spring-boot-starter-parent 依赖版本:2.7.0
- activiti-spring-boot-starter 依赖版本:7.1.0.M6
- spring-boot-starter-security 依赖版本:2.7.0
一 security 相关
对于 Spring Boot 集成 Security 的步骤,我们在文章 Spring Boot(十一):Spring Security 实现权限控制 中已经很详细地介绍过,可以跳过去大概阅读一番,以便更好地入门此次的知识
1 引入 spring-boot-starter-security 依赖
虽然 activiti-spring-boot-starter 也包含了 Security 的依赖,但是在 7.1.0.M6 版本里,却不能够直接使用最新版本的权限配置方式(自定义 SecurityFilterChain Bean 来实现权限配置),所以我这里便额外引入了 spring-boot-starter-security 的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
2 表结构
遵从 Security 所采取的权限访问控制方案:RABC -基于角色的权限访问控制(Role-Based Access Control),我们建立如下 5 张表
建表语句如下:
/*
Navicat Premium Data Transfer
Source Server : localhost
Source Server Type : MySQL
Source Server Version : 50733
Source Host : localhost:3306
Source Schema : activiti_spring
Target Server Type : MySQL
Target Server Version : 50733
File Encoding : 65001
Date: 18/07/2022 15:55:30
*/
SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;
-- ----------------------------
-- Table structure for permission
-- ----------------------------
DROP TABLE IF EXISTS `permission`;
CREATE TABLE `permission` (
`id` bigint(11) NOT NULL AUTO_INCREMENT,
`url` varchar(255) NOT NULL,
`name` varchar(255) NOT NULL,
`description` varchar(255) DEFAULT NULL,
`pid` bigint(11) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of permission
-- ----------------------------
BEGIN;
INSERT INTO `permission` VALUES (1, '/user/common', 'common', NULL, 0);
INSERT INTO `permission` VALUES (2, '/user/admin', 'admin', NULL, 0);
INSERT INTO `permission` VALUES (3, '/process/*', 'activiti', NULL, 0);
COMMIT;
-- ----------------------------
-- Table structure for role
-- ----------------------------
DROP TABLE IF EXISTS `role`;
CREATE TABLE `role` (
`id` bigint(11) NOT NULL AUTO_INCREMENT,
`name` varchar(255) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of role
-- ----------------------------
BEGIN;
INSERT INTO `role` VALUES (1, 'USER');
INSERT INTO `role` VALUES (2, 'ADMIN');
INSERT INTO `role` VALUES (3, 'ACTIVITI_USER');
COMMIT;
-- ----------------------------
-- Table structure for role_permission
-- ----------------------------
DROP TABLE IF EXISTS `role_permission`;
CREATE TABLE `role_permission` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`role_id` bigint(11) NOT NULL,
`permission_id` bigint(11) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=8 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of role_permission
-- ----------------------------
BEGIN;
INSERT INTO `role_permission` VALUES (1, 1, 1);
INSERT INTO `role_permission` VALUES (2, 2, 1);
INSERT INTO `role_permission` VALUES (3, 2, 2);
INSERT INTO `role_permission` VALUES (4, 3, 3);
COMMIT;
-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` bigint(11) NOT NULL AUTO_INCREMENT,
`username` varchar(255) NOT NULL,
`password` varchar(255) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of user
-- ----------------------------
BEGIN;
INSERT INTO `user` VALUES (1, 'user', '$2a$10$4zd/aj2BNJhuM5PIs5BupO8tiN2yikzP7JMzNaq1fXhcXUefWCOF2');
INSERT INTO `user` VALUES (2, 'admin', '$2a$10$4zd/aj2BNJhuM5PIs5BupO8tiN2yikzP7JMzNaq1fXhcXUefWCOF2');
INSERT INTO `user` VALUES (3, 'Jack', '$2a$10$4zd/aj2BNJhuM5PIs5BupO8tiN2yikzP7JMzNaq1fXhcXUefWCOF2');
INSERT INTO `user` VALUES (4, 'Marry', '$2a$10$4zd/aj2BNJhuM5PIs5BupO8tiN2yikzP7JMzNaq1fXhcXUefWCOF2');
COMMIT;
-- ----------------------------
-- Table structure for user_role
-- ----------------------------
DROP TABLE IF EXISTS `user_role`;
CREATE TABLE `user_role` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`user_id` bigint(11) NOT NULL,
`role_id` bigint(11) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of user_role
-- ----------------------------
BEGIN;
INSERT INTO `user_role` VALUES (1, 1, 1);
INSERT INTO `user_role` VALUES (3, 2, 2);
INSERT INTO `user_role` VALUES (4, 2, 3);
INSERT INTO `user_role` VALUES (5, 3, 3);
INSERT INTO `user_role` VALUES (6, 4, 3);
COMMIT;
SET FOREIGN_KEY_CHECKS = 1;
其实就是直接拿来文章 Spring Boot(十一):Spring Security 实现权限控制 中的表结构,并根据我们本次对于 Activiti 项目的演示需要,在之前的基础上,分别增加了两个用户:Jack 和 Marry,以及他们对应的新角色:ACTIVITI_USER 以及新 url :/process/* 的访问权限。当然,根据 RABC 的方式,也配置了其对应的用户角色、角色权限的关系
3 配置类
采用 Spring Boot Security 的最新方式实现,即:
- 如果想要配置过滤器链,可以通过自定义 SecurityFilterChain Bean 来实现
- 如果想要配置 WebSecurity,可以通过 WebSecurityCustomizer Bean 来实现
@Configuration
@Slf4j
public class SecurityConfig {
@Resource
private PermissionMapper permissionMapper;
@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
ExpressionUrlAuthorizationConfigurer<HttpSecurity>.ExpressionInterceptUrlRegistry
authorizeRequests = http.csrf().disable().authorizeRequests();
// 方式二:配置来源于数据库
// 1.查询到所有的权限
List<Permission> allPermission = permissionMapper.findAllPermission();
// 2.分别添加权限规则
allPermission.forEach((p -> {
authorizeRequests.antMatchers(p.getUrl()).hasAnyAuthority(p.getName()) ;
}));
authorizeRequests.antMatchers("/**").fullyAuthenticated()
.anyRequest().authenticated().and().formLogin();
return http.build();
}
@Bean
WebSecurityCustomizer webSecurityCustomizer() {
return web -> {
web.ignoring().antMatchers("/css/**");
web.ignoring().antMatchers("/js/**");
web.ignoring().antMatchers("/img/**");
web.ignoring().antMatchers("/plugins/**");
web.ignoring().antMatchers("/login.html");
};
}
@Bean
public PasswordEncoder passwordEncoder(){
return new BCryptPasswordEncoder();
}
当前用户所拥有的的权限等信息,则通过实现 UserDetailsService 接口,并重写其方法 loadUserByUsername() 来获取:
@Slf4j
@Service
public class UserServiceImpl implements UserService {
@Resource
private UserMapper userMapper;
@Override
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
// 1.根据用户名称查询到user用户
User userDetails = userMapper.findByUsername(username);
if (userDetails == null) {
return null;
}
// 2.查询该用户对应的权限
List<Permission> permissionList = userMapper.findPermissionByUsername(username);
List<GrantedAuthority> grantedAuthorities = new ArrayList<>();
permissionList.forEach((a) -> grantedAuthorities.add(new SimpleGrantedAuthority(a.getName())));
log.info(">>permissionList:{}<<", permissionList);
// 设置权限
userDetails.setAuthorities(grantedAuthorities);
return userDetails;
}
}
到此,就完成了 Security 的相关配置,接下来,让我们正式进入 Spring Boot 集成 Activiti 的实战环节
二 进入 Spring Boot 集成 Activiti 的实战
需要预先说明的是,
Activiti 提供了几个 Service 类,用来管理工作流,常用的有以下四项:
- 1)RepositoryService:提供流程定义和部署等功能。比如说,实现流程的的部署、删除,暂停和激活以及流程的查询等功能
- 2)RuntimeService:提供了处理流程实例不同步骤的结构和行为。包括启动流程实例、暂停和激活流程实例等功能
- 3)TaskService:提供有关任务相关功能的服务。包括任务的查询、删除以及完成等功能
- 4)HistoryService:提供 Activiti 引擎收集的历史记录信息服务。主要用于历史信息的查询功能
还有以下两项: - 1)ManagementService:job 任务查询和数据库操作
- 2)DynamicBpmnService:无需重新部署就能修改流程定义内容
而 Spring Boot 集成 Activiti 实现工作流功能,也主要是采用这些 Service 所提供的 相应的 API 来实现的
1 配置文件
application.yml 文件的配置
spring:
datasource:
url: jdbc:mysql://localhost:3306/activiti_spring?useUnicode=true&characterEncoding=utf8&nullCatalogMeansCurrent=true
username: root
password: 123456
driver-class-name: com.mysql.cj.jdbc.Driver
activiti:
# flase: 默认值。activiti在启动时,会对比数据库表中保存的版本,如果没有表或者版本不匹配,将抛出异常。(生产环境常用)
# true: activiti会对数据库中所有表进行更新操作。如果表不存在,则自动创建。(开发时常用)
# create_drop: 在activiti启动时创建表,在关闭时删除表(必须手动关闭引擎,才能删除表)。(单元测试常用)
# drop-create: 在activiti启动时删除原来的旧表,然后在创建新表(不需要手动关闭引擎)。
database-schema-update: true
#默认不生成历史表,这里开启
db-history-used: true
#历史登记
# none: 不记录历史流程,性能高,流程结束后不可读取
# activity: 归档流程实例和活动实例,流程变量不同步
# audit: 默认值,在activiti基础上同步变量值,保存表单属性
# full: 性能较差,记录所有实例和变量细节变化,最完整的历史记录,如果需要日后跟踪详细可以开启full(一般不建议开启)
history-level: full
deployment-mode: never-fail # 关闭 SpringAutoDeployment
除了数据库的配置信息以外,在我们的 demo 演示环境,Activiti 的配置如下:
- database-schema-update 配置为 true,即每次项目启动,都会对数据库进行更新操作,如果表不存在,则自动创建
- db-history-used 配置为 true 由于默认是不生成历史表的,配置为 true,表示需要生成
- history-level 配置 为 full,表示记录最完整的历史记录
- deployment-mode 配置为 never-fail ,即关闭掉 SpringAutoDeployment。如果不关闭,每次重新启动项目的时候,总是会在 ACT_RE_DEPLOYMENT 自动创建一个名为 SpringAutoDeployment 工作流记录。但是在开发阶段,需要经常重启项目,久而久之就会导致 ACT_RE_DEPLOYMENT 的记录越来越大了
2 表结构创建
首次启动时,根据以上的配置,Activiti 会进行表结构的自动创建,以下是项目初次启动时的日志
由于上述我们配置了开启历史表的使用开关:db-history-used: true
所以,这里除了创建 Activiti 的非历史表结构以外,还创建了其历史表结构
项目启动之后,会发现,我们所配置的 activiti_spring 数据库中,便增加了 25 张 ACT 开头的表
备注:这些表的说明,也可以参考上一篇文章:Activiti工作流(一):OA 上的那些请假流程如何快速实现呢?
3 流程部署
总得来说,可以分为两种方式:自动部署和手动部署
自动部署,实际上是 Spring Boot 会在启动项目时,会自动部署项目目录下的 processes 文件夹中的所有流程,而没有在这个目录下的所有流程定义文件,则需要手动方式进行部署了
我们先来看一下自动部署的方式
1)自动部署
a) 创建流程定义
备注:具体创建方式本文不再赘述,大家可以参考上一篇文章:Activiti工作流(一):OA 上的那些请假流程如何快速实现呢?
在 resources 目录下,创建一个 processes 文件夹,在该文件夹下分别创建两个简单的流程:
- 请假申请(leaveApplication)
- 出差申请(myEvection)
其中,请假流程定义了两个步骤:
创建申请和审批申请,其负责人分别定义为 ${assignee0} 和 ${assignee1}
b)启动项目
项目启动时,完成 process 目录下的流程文件的自动部署
观察日志,可以看到我们预先创建好的两个流程定义,均被自动部署了
我们知道,Activiti 的逻辑,实际上是通过对一系列表的操作,来实现工作流的控制。而流程的部署,则是把我们所创建的流程定义文件,真正与数据库的表关联起来
那么,我们来看看看流程定义表:ACT_RE_PROCDEF
发现表中已有相应的两条记录,验证了这两个流程的确完成了自动部署
当然,如果定义好的流程文件没有在 processes 文件夹下,就需要我们手动部署了
2)手动部署
可以通过如下方式指定 bpmn 文件的目录:filePath 进行部署
repositoryService.createDeployment()
.addClasspathResource(filePath)
.deploy();
由于是对流程定义的操作,所以我们采用 RepositoryService 这个服务进行部署
4 查询流程定义
查询流程定义,依旧是对流程定义的操作,所以采用 RepositoryService 服务进行查询,具体代码与上篇文章中的查询方式类似
/**
* 查询流程
* @param key
* @return
*/
@GetMapping(value = {"/list/{key}","/list"})
public ResponseResult getProcessList(@PathVariable(name = "key",required = false) String key) {
ProcessDefinitionQuery definitionQuery = repositoryService.createProcessDefinitionQuery();
List<ProcessDefinition> definitionList;
if (key!=null){
definitionList = definitionQuery
.processDefinitionKey(key)
.list();
}
definitionList = definitionQuery.list();
//提取所有的流程名称
List<String> processList = new ArrayList<>();
for (ProcessDefinition processDefinition : definitionList) {
processList.add(processDefinition.getName());
}
return ResponseResult.getSuccessResult(processList);
}
采用 Jack 用户登录之后,带上其 Cookie 头参数,进行如下访问
成功访问
5 启动流程
本次实战,我们来启动请假申请(leaveApplication)流程,由于是运行时状态,所以采用 RuntimeService 的 startProcessInstanceByKey(key,map) 方法进行启动,具体代码如下:
/**
* 启动流程定义(由流程定义-》流程实例)
* @param key
* @return
*/
@PostMapping("start/{key}")
public ResponseResult startProcess(@PathVariable(name = "key") String key){
Map<String,Object> map = new HashMap<>();
map.put("assignee0","Jack");
map.put("assignee1","Marry");
//启动 key 标识的流程定义,并指定 流程定义中的两个参数:assignee0和assignee1
ProcessInstance processInstance = runtimeService.startProcessInstanceByKey(key,map);
ResponseResult result = ResponseResult.getSuccessResult(processInstance.getProcessDefinitionName());
log.info("流程实例的内容:{}",processInstance);
return result;
}
测试启动:
指定参数 key 为 leaveApplication ,进行启动操作
访问成功后,看看表中的数据有没有变化呢,查看 ACT_RU_TASK 表,该表中新增了一条记录,为创建申请,负责人为 Jack,表示我们的这个流程已经成功启动,目前进行到了创建申请这一任务了,其负责人为 Jack
当前登录的用户就是 Jack,此时我们通过接口 /process/task/list 接口来查看 Jack 的任务列表
发现目前在 Jack 名下的确存在一个待办任务:创建申请
6 Jack -创建申请
对任务的完成,依旧是采用 TaskService 进行,具体代码如下:
/**
* 完成任务
* @param key
* @param assigne
* @return
*/
@PostMapping("complete")
public ResponseResult doTask(@RequestParam(name = "key") String key,@RequestParam(name = "assignee")String assigne){
List<Task> tasks = taskService.createTaskQuery().processDefinitionKey(key)
.taskAssignee(assigne)
.list();
if (tasks!=null && tasks.size()>0){
for (Task task : tasks) {
log.info("任务名称:{}",task.getName());
taskService.complete(task.getId());
log.info("{},任务已完成",task.getName());
}
}
return ResponseResult.getSuccessResult(null);
}
由 Jack 来完成“创建申请”的待办任务,分别指定 key 为 leaveApplication ,assignee 为 Jack ,进行任务的完成操作:
访问成功之后,我们再来查看 ACT_RU_TASK(当前任务表)
按照预期,此时正要处理的任务为审批申请,并且负责人为 Marry
当前我们采用 Jack 登录的这个 Cookie 来进行查询,发现 task 列表已经变成了空的
7 Marry -审批申请
1)登录
访问 localhost:8080/logout 登出,会跳转到登录页面
此时,采用 Marry 进行登录
2)查看其名下的任务列表
发现的确存在一个任务:审批申请
3)完成任务
指定 key 为 leaveApplication,assignee 为 Marry,访问接口 /process/complete
接口返回成功
此时,再次查询我们的 ACT_RU_TASK 表,会发现我们已经没有了正在处理的任务,说明我们已完成了所有的任务
再次查看历史表 ACT_HI_TASKINST,会看到我们所处理过的两个任务
好了,走到这一步,我们便成功完成了 Spring Boot 集成 Activiti 进行流程定义、流程部署、流程启动、任务完成等工作流管理的一系列操作
总结
今天带领大家完成了 Spring Boot 集成 Activiti 的功能,网上目前可能很难找到类似的案例,因为我们这里采用的 Spring Boot 和 Activiti 以及 Security 均是当前最新的版本
Spring Boot 与 Activiti 集成,使得我们不仅可以继续使用 Activiti 本身所提供的简易的 API, 而且 Spring Boot 还提供了很多自动化的东西,包括启动时自动创建表结构,自动完成 processes 目录下的流程部署操作等等
------------------------------------------------------------------------------------------标签:http,定义,activiti,流程,Activiti,工作,org From: https://www.cnblogs.com/hanease/p/16941324.html