记录开发最核心的部分,理论结合业务实操减少废话,从未接触工作流快速带入开发。假设你是后端的同学学过JAVA和流程图,则可以继续向后看,否则先把基础课程书准备好先翻翻。
为什么要工作流
比起直接使用状态字段,工作流有以下几个好处:
- 直观管理:可以直接通过维护流程图设计来实现状态流转。流程变化可直接维护BMP流程图发布来实现变更
- 复杂流程:会签、序签、指定时间半数以上通过等等
- 低代码:基于表单的审批数据模式性很强,可以比较方便的实现低代码,高效开发
其它理由不用多说,光这3项的场景就有充分使用的理由。如果模式非常简单,还是状态字段来的直接。
从流程图说起
我们知道,一个流程图包括开始状态、结束状态、任务节点、流程条件。嗯,看起来像这样
对应Activiti的概念:
实例:开始一个任务后,则产生一个流程实例,即ProcessInstance
任务:当走到一个任务节点时,则产生任务,任务有单个和多个两种模式,多个任务有顺序和并行模式
执行:通常一个任务节点会产生一个执行,但是并行节点或分支任务会产生多个执行,一个进行中的任务对应一个执行,每个执行可以有多个子执行(多个任务节点时)。这里的执行,相当于有多少个“待办任务”在进行。当对应的任务完成时,执行表的对应记录也会被删除
变量:流程的数据容器,在整个流转过程中。变量分为两种,一种是实例级别的变量,另一种是执行级别的变量。对应task.setVariable和execution.setVariable,区别是execution variable只在当前的执行节点有效,而task variable是针对任务的变量。
变量生命周期:对于task和execution,都有setVariable和setLocalVariable两种。变量的setVariable设置的值针对整个流程实例生命周期有效,而setLocalVariable设置的值针对当前任务节点有效。可以理解为始终使用还是一次性使用(针对网关使用一次后作废)。
边界事件:定时、信号等事件,在事件网关时,可以根据事件来定义。实现时间或信号特性的约束,常见的场景例如客服1小时处理不完投诉则交给主管处理。
约束条件与网关
以前面的流程图为例,超过3天和不超过3天为根据约束条件产生的两种不同的操作任务。在Activiti7里用网关(gateway)来表示。网关有表达式(SPEL)、脚本和Java类3中处理。常用的为表达式模式。当前一个任务完成(complete)时,根据表达式不同走向不同的节点
网关有4种类型:
排他网关(Exclusive Gateway)
会按照给定的条件,产生一个任务实例
蛋疼理论:如果多个分支条件都满足,或者一个分支都不满足,怎么办?
如果都满足,流程会按照id值升序,处理第一条分支(先定义的分支id通常值较小,但不绝对)
如果都不满足,则会抛出异常
并行网关(ParallelGateway)
会按照给定的条件,产生多个任务实例。并行网关可以并行作业,提高业务流程速度。
包容网关(Inclusive Gateway)
相当于排他和并行的综合体 ,同时执行时可以指定条件,例如某些需要补充材料的情况
事件网关(Event Gateway)
用于根据事件的触发选择分支路径。当指定的事件触发时,流程会选择对应的分支执行。
多实例与子执行
有那么一种业务,流程图可能表示为多个人参与同一个活动。例如你可能想到的流程图:
像这种活动,在BPM里,可以作为单个任务节点来实现。叫做多实例任务。
我们可以通过节点的MultiInstance来指定多实例,当指定多实例时,需要设置Collection的参数来决定进入任务时产生多少个子执行。Collection是一组java.util.Collection接口的数据。进入任务时,将产生一个对应的主执行,和多个子执行,这些子任务将分别指派给Collection的每一个人员。
对应的业务场景通常有会签和序签。序签用的较少,这里主要讲会签。
会签模式
会员的模式主要有:
按数量通过:达到一定数量的通过表决后,会签通过。
按比例通过:达到一定比例的通过表决后,会签通过。
一票否决:只要有一个表决是否定的,会签否决。
一票通过:只要有一个表决通过的,会签通过。
我们可以在Task的MultiInstance配置多实例的信息。可以配置的有:
模式参数
顺序(sequential ):执行顺序,必选项。true:多实例顺序执行。false:多实例并行。
并行(parallel):多个实例会同时并行发放给处理人
loop cardinality:循环基数(实例数量),可选项。可填整数,表示会签的人数。
Collection:集合,可选项。会签人数的集合list,与loop cardinality二选一。
Element variable:元素变量。选择Collection时必选,为collection集合每次遍历的元素。
Completion condition:完成条件,可选项。
完成条件
会签配置关键就是Completion condition,可以填写一个UEL(类似SPEL)。在流程流转时,对于多实例节点,会内置下面几个参数:
nrOfInstances:创建的实例总数,在进入任务节点时则设置好,一般等于Collection的数量
nrOfActiveInstances:当前活动的实例数,针对顺序类型的多实例,该变量值等于1;对于并行的类型,进入任务时为Collection数量,每完成一个执行,则活动任务数减1。
nrOfCompletedInstances:已执行实例数。每完成一个执行,则加1。
loopCounter:表示多实例流程循环的下标,顺序执行时记录执行顺序。
条件实现
理解上面的内容这样实现的方式就很明确了:
假设我们为会签设置了2个投票池(说白了就是变量)approveCount和denyCount。操作时,每点击"同意"或"拒绝"(先不考虑弃权情况)则变量+1
1)按数量通过:2人通过则通过#{approveCount > 2}
2)按比例通过:常见的过半数同意则通过 #{agreeCount/nrOfInstance > 0.5}
3)一票否决:#{denyCount== 1}
4)一票通过:#{approveCount== 1}
序签:较少使用。需要每个人员逐一完成任务。
抢单与代办
接下来讲两个常见业务场景,第一个是抢单。抢单的需求为我们可以将任务指定给一个处理小组,处理小组某个人点击“开始处理”后,其它人将无法再点击处理按钮或点击处理按钮提示已被抢单。
核心业务实现:
1)任务的CandidateUser属性可以指定一组处理人员,Task的Candidata Users属性可以通过SPEL指定一个列表。当指派列表后,任务流转到节点时所有的Candidata Users都会收到一个代办任务。
2)操作员点击开始处理时,通过taskService.setAssignee(taskId, assignee);指派给某个人员,指派后,其它操作员将再无法看到这个任务
3)当其他操作员点击操作时,需要检查操作列表,如果已经被指派给非当前操作员 ,需要返回前端提醒用户该任务已指派。否则直接使用Activity引擎来处理指派,将会导致任务重新分配(和后面讲的代办逻辑一样)
代办的模式和抢单的一样,当某任务已经指定给某个操作员后。可以通过setAssignee实现操作的重新指派。从而实现代办指派。当然这只是流程级别的操作,对于业务的具体流转记录,我们还时得借助日志的实现。
Activiti之历史记录
对于工作流业务,仅有流程状态支撑显然不够。我们还需要对历史数据进行查询和展示。Activiti提供了一组历史记录表,以ACT_HI_开头,记录了流程信息、流程任务信息、以及流程的变量信息。能够满足一些常见的业务场景需求,例如:
审批历史
在审批的过程,我们通常需要添加批示信息。一个流程的审批历史类似:
张三:提交请假申请
组长:同意请假
经理:同意请假
人事:请假申请处理完毕
如果不借助额外的数据表,我们可以使用流程变量。定义为一个String数组或者JSON,每经过一个处理节点添加一行记录。流程进行或完成时,将该记录拿出来展示,该信息记录在表act_hi_taskinst
注意如果使用流程实例变量记录审批过程JSON,需要留意String变量大小的限制(4000字符),以免在审批过程中超过大小。以每个节点审批信息256字符为例,我们可以推算最少大概15个节点审批信息填满会导致审批记录满。
流转节点
在任务记录表act_hi_taskinst里,记录了流程产生的任务以及经过的节点,以及对于流程图文件的任务节点的KEY。这样我们可以通过act_hi_taskinst,在BPMN流程定义图上绘制详细的节点流转标记进行展示
理论了很多,下一步来点干货实操
环境搭建
以springboot+Activiti7为例,开始环境搭建。
Activiti依赖的支持有:
- spring:提供了一组starter,启动后可以通过对应的Bean完成流程处理
- spring-security:activiti7.X默认整合了springsecurity,使用sa-token或Shiro等其他权限控制需要剥离对spring-security的依赖,否则会报错。对springsecurity的依赖主要包含群组权限的部分,我们不需要完全可以剥离它
- mybatis:数据存储层使用的是mybatis来进行控制
Activiti最新的版本
如果从sonatype公共的仓库去拿,仅能拿到4年前的版本7.1.0.M6。你可能满脑袋的问号:Activiti开源死掉了吗?不再支持了吗?
如果你去Activiti官网,会发现Activiti仍旧有维护,甚至发展到8.0版本。无法获得是因为我们没有配置Activiti官网仓库。以gradle为例,我们只需要添加这个仓库即可
maven { url 'https://artifacts.alfresco.com/nexus/content/repositories/activiti-releases' } // activiti最新版仓库
然后我们可以使用最新版本了,为了避免表结构出现不兼容,还是选择7.X的最新版本:
implementation("org.activiti:activiti-spring-boot-starter:7.11.0") implementation("org.activiti:activiti-core-dependencies:7.11.0")
升级注意
JDK版本依赖:Activiti自身仓库的版本都是使用JDK11编译,如果是使用JDK1.8编译会出现报错。解决办法1是升级JDK到11,2是重新使用JDK1.8编译整个Activity源(比较麻烦)。我选择的是升级到JDK11
剥离springsecurity依赖
剥离springsecurity依赖主要是方式是禁用Activiti里与springsecurity相关的starter
YAML配置的方式:
spring:autoconfigure:exclude:- org.activiti.spring.boot.ActivitiMethodSecurityAutoConfiguration- org.activiti.core.common.spring.identity.config.ActivitiSpringIdentityAutoConfiguration
代码配置方式:
@SpringBootApplication(exclude = {ActivitiMethodSecurityAutoConfiguration.class, ActivitiSpringIdentityAutoConfiguration.class}
)
然后启动你会发现,还会有Bean UserGroupManager报错,这个Bean是依赖spring security的群组功能。不使用群组的话,我们可以直接new个匿名类让spring装配不报错。
我的ActivitiConfiguration如下
package org.ccframe.app;import org.activiti.api.runtime.shared.identity.UserGroupManager;
import org.activiti.spring.SpringProcessEngineConfiguration;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.transaction.PlatformTransactionManager;import javax.sql.DataSource;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;@Configuration
public class ActivitiConfiguration {@Autowiredprivate DataSource dataSource;@Autowiredprivate PlatformTransactionManager transactionManager;//通过@Bean注解将SpringProcessEngineConfiguration实例声明为Spring Bean,使其可供其他组件注入和使用@Beanpublic SpringProcessEngineConfiguration springProcessEngineConfiguration() {SpringProcessEngineConfiguration spec = new SpringProcessEngineConfiguration();//设置数据源,将注入的数据源设置到SpringProcessEngineConfiguration实例中spec.setDataSource(this.dataSource);//设置事务管理器将注入的事务管理器设置到SpringProcessEngineConfiguration实例中spec.setTransactionManager(this.transactionManager);//设置数据库模式更新策略 true表示在启动时自动创建或更新Activiti引擎所需的数据库表结构spec.setDatabaseSchemaUpdate("true");Resource[] resources = null;//配置流程部署资源//使用PathMatchingResourcePatternResolver从classpath中的bpmn目录下加载所有以.bpmn为扩展名的文件作为流程定义资源,// 并将它们设置到SpringProcessEngineConfiguration实例中。try {resources = (new PathMatchingResourcePatternResolver()).getResources("classpath*:bpmn/*.bpmn");} catch (IOException var4) {var4.printStackTrace();}spec.setDeploymentResources(resources);return spec;}@Beanpublic UserGroupManager userGroupManager(){return new UserGroupManager(){@Overridepublic List<String> getUserGroups(String username) {return new ArrayList<>();}@Overridepublic List<String> getUserRoles(String username) {return new ArrayList<>();}@Overridepublic List<String> getGroups() {return new ArrayList<>();}@Overridepublic List<String> getUsers() {return new ArrayList<>();}};}
}
这里只是不使用group的功能,当然你可以使用自己的权限系统来实现group的功能,将group信息对应到自己权限系统的用户列表。
可控流转的实现
<编写中>