基于Springboot+SpringSecurity+Activiti7实现的工作流系统可方便二次开发(附完整源码)
现在很多ToB的系统一般都会有工作流的相关需求,比如报价单、合同审批等等,如果是自己实现一套工作流引擎对于大多数中小企业不太实际, 并且在业务调整时也很难做到灵活的扩展,所以大家普遍会选择简单灵活易于集成的工作流引擎框架activiti。 本文就是要带大家了解在基于SpringSecurity权限框架的SpringBoot项目中怎么使用集成activiti7工作流,并且怎么把它融合到实际的单据(如请假)业务审批流程中。
Tip
:以下是我用SpringBoot+Activiti7实现的工作流的的源码,有兴趣可以自己获取,也欢迎大佬们提交PR一起学习
arduino
// Git代码
https://gitee.com/yeeevip/yeee-activiti7
1 功能演示
- 在线绘制流程定义
登录admin账号,进入菜单 - 工作流 > 流程定义 > 在线制作流程;我这里是模拟一个单据审批流程,申请人提交单据后需要 进过两级审批,只要有其中一级审批不通过就会打回到申请人提交节点让重新提交审批单。
给一级审批设置审批权限,可以设置审批用户或者设置审批的部门,这样当申请人提交单据后审批任务就会流转到设置好的用户下。
- 申请人提交审批单
进入菜单 - 工作流 > 流程定义 > (列表中找到'刚才绘制的'这个审批流程) > 新建实例,这样就模拟了一个用户提交审批流程。
- 一级审批进行任务审批
流程定义在不同的审批环节设置了不同部门的人员来审批,开始流程实例后,人员就可以登录自己账号进入菜单 - 工作流 > 代办任务 > 查看到自己当前的待完成审批项。 用户1可以选择 通过或者不通过,通过的话就会流转到二级审批的用户任务下,不通过就会回到申请人任务下。
2 二次开发与自己业务系统打通
2.1 通用扩展点
Activiti框架的整体架构服务按照功能领域来分的话可以分为三部分:
1
流程定义:主要负责管理流程绘制的内容视图
2
流程实例:实例就相当于在该流程定义下的审批流程,就拿请假流程来说,3个用户提交了3个审批单,相当于在这个请假留下下建了3个实例
3
审批任务:审批流程各节点的执行环节。如一个请假需要经过两个领导审批,之后流程流转过程中领导会进行各自的审批任务
所以基于以上3个领域划分后我按照功能进行了封装common-activiti7:
2.1.1 流程定义通用接口
typescript
public class CommonActiviti7Service {
// 分页获取流程定义
public PageVO<DefinitionVo> definitionList(PageReqVO<?> reqVO) {
PageVO<DefinitionVo> pageVO = new PageVO<>(reqVO.getPageNum(), reqVO.getPageSize());
...
return pageVO;
}
// 删除流程定义
public void definitionDelete(DefDeleteReq req) {
for (String depId : req.getIds()) {
repositoryService.deleteDeployment(depId, true);
}
}
// 保存绘制好的流程定义
public void definitionAddDeploymentByString(String stringBPMN) {
Deployment deployment = repositoryService.createDeployment()
.addString("CreateWithYeeeSystem.bpmn", stringBPMN)
.deploy();
}
// 查看流程定义详情
public void definitionDetailXml(HttpServletResponse response, String deploymentId, String resourceName) {
InputStream inputStream = repositoryService.getResourceAsStream(deploymentId, resourceName);
response.setContentType("text/xml");
try {
IoUtil.copy(inputStream, response.getOutputStream());
} catch (IOException e) {
log.error("获取失败", e);
}
}
}
2.1.2 流程实例通用接口
typescript
public class CommonActiviti7Service {
// 分页获取流程实例
public PageVO<InstanceVo> instanceList(PageReqVO<?> reqVO) {
PageVO<InstanceVo> pageVO = new PageVO<>(reqVO.getPageNum(), reqVO.getPageSize());
...
return pageVO;
}
// 新建流程实例
@Transactional(rollbackFor = Exception.class, isolation = Isolation.READ_COMMITTED)
public void instanceCreate(InstCreateReq req) {
String authenticatedUserId = securityManager.getAuthenticatedUserId();
Map<String,Object> variables = new HashMap<>();
variables.put("applicant", authenticatedUserId);
org.activiti.engine.runtime.ProcessInstance processInstance = runtimeService.startProcessInstanceById(req.getPdId(), variables);
org.activiti.engine.task.Task task = taskService.createTaskQuery()
.processInstanceId(processInstance.getProcessInstanceId())
.taskUnassigned()
.singleResult();
taskService.claim(task.getId(), authenticatedUserId);
taskService.complete(task.getId());
}
// 暂停流程实例
public void instanceSuspend(String instanceId) {
SuspendProcessPayload payload = ProcessPayloadBuilder
.suspend()
.withProcessInstanceId(instanceId)
.build();
processRuntime.suspend(payload);
}
}
2.1.3 审批任务通用接口
scss
public class CommonActiviti7Service {
// 查询待审批任务
public PageVO<TaskVo> taskList(PageReqVO<?> reqVO) {
PageVO<TaskVo> pageVO = new PageVO<>(reqVO.getPageNum(), reqVO.getPageSize());
...
return pageVO;
}
// 去完成审批任务
public void taskComplete(TaskCompleteReq req) {
Task task = taskRuntime.task(req.getTaskId());
if (task == null) {
throw new BizException("代办任务不存在");
}
if (task.getAssignee() == null) {
taskRuntime.claim(TaskPayloadBuilder.claim().withTaskId(task.getId()).build());
}
CompleteTaskPayload payload = TaskPayloadBuilder.complete().withTaskId(task.getId())
.withVariable("isPass", req.getIsPass())
.build();
taskRuntime.complete(payload);
}
}
具体更加完整的代码请去git仓库获取:
ruby
// Git代码
https://gitee.com/yeeevip/yeee-memo/tree/master/memo-parent/memo-common/common-workflow/common-activiti7
2.2 系统的单据业务与Activiti7打通
大多数人在使用工作流框架时都不知道怎么将自己的业务与工作流框架打通,比如我们系统里有合同业务, 现在要开发合同审批的需求,那改怎么做呢?我这里说一下大致的思路:
1
绘制合同审批业务流程定义,将绘制保存好的流程定义唯一key与合同业务绑定起来(可以使用配置表关联)
2
当合同填写完成后,想要提交审批时根据配置绑定关系就可以找到对应的流程定义
3
然后通过调用流程实例api的新建实例接口,这样就开启了一个审批流程
4
这样用户就可以调用审批任务api查询所属的审批任务,之后进行审批了
3 项目使用demo
项目模块
- 新建用户角色部门权限管理系统
用户角色部门权限系统采用的是我已经封装好的javaweb通用脚手架搭建的,只需要在pom.xml中引入我脚手架以下的坐标即可:
xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<!-- 通用脚手架父坐标,主要封装了一些通用模块Starter-->
<parent>
<groupId>vip.yeee.memo</groupId>
<artifactId>memo-parent</artifactId>
<version>3.2.2-SNAPSHOT</version>
<relativePath/>
</parent>
...
<dependencies>
<!-- 引入base-web模块就拥有了springweb的基本能力包括校验、监控等等-->
<dependency>
<groupId>vip.yeee.memo</groupId>
<artifactId>base-web</artifactId>
</dependency>
<!-- 项目采用的安全认证框架是SpringSecurity+oauth2-->
<!-- 这里引入的就是我封装好的Starter不需要额外开发开箱即用-->
<dependency>
<groupId>vip.yeee.memo</groupId>
<artifactId>common-platform-auth-server</artifactId>
</dependency>
<dependency>
<groupId>vip.yeee.memo</groupId>
<artifactId>common-platform-auth-client</artifactId>
</dependency>
<!-- 由于需要数据库操作我这里使用mybatis-plus-->
<dependency>
<groupId>vip.yeee.memo</groupId>
<artifactId>base-mybatis-plus</artifactId>
</dependency>
...
</dependencies>
</project>
到这里一个基于SpringSecurity+oauth2的SpringBoot用户权限系统所需的依赖基本都引入;管理界面前端的代码 我采用的是vue搭建的,具体的代码可以移步我仓库,这里不介绍了。
bash
// 用户权限系统前端UI代码
https://gitee.com/yeeevip/yeee-activiti7/tree/activiti7-master/app-h5/yeee-admin-ui
- 新建工作流模块引入工作流框架
为了代码结构清晰,我单独新建一个模块yeee-activiti7-manage来编写工作流相关的业务,Activiti7相关的service以及其他通用的 能力我也是都封装了一个Starter在我的JavaWeb通用脚手架里了,只需要引入对应的maven坐标到pom.xml中即可:
xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<dependencies>
<!-- 引入封装好的common-activiti7-->
<!-- 即拥有了activiti7工作流相关的通用service-->
<dependency>
<groupId>vip.yeee.memo</groupId>
<artifactId>common-activiti7</artifactId>
</dependency>
</dependencies>
</project>
工作流流程绘制的前端具体代码可以移步我仓库:
bash
// 工作流流程绘制前端UI代码
https://gitee.com/yeeevip/yeee-activiti7/tree/activiti7-master/app-h5/activiti-editor
- 将项目启动会自动生成工作流相关表
Activiti7相关表说明
最后
关于Activiti7的使用我就介绍到这里了,具体有什么问题大家可以评论区留意或者私信我哦~
Tip
:以下是我用SpringBoot+Activiti7实现的工作流的的源码,有兴趣可以自己获取,也欢迎大佬们提交PR一起学习
arduino
// Git代码
https://gitee.com/yeeevip/yeee-activiti7