一、说明
此文章为SpringBoot2整合Activiti6设计器形成基于Activiti6的web项目实例的指导文档,整合工具使用的idea。从零开始,详尽的罗列了每一步整合步骤。需要一定整合者要有一定的技术基础,需要了解maven、springboot、activiti、js前端及h5相关的基础技术。
二、资料准备
- activiti-6.0.0官方实例:我的网盘下载链接:https://pan.baidu.com/s/1QOxn_AbpHvB5sEjjhG_vDA
提取码:iju7 ; - activiti-5.22.0(官方):Activiti5.22.0的官方代码实例,我的网盘下载链接:https://pan.baidu.com/s/1kE78B5rAdhXwlzDYFIOVEQ
提取码:d9x3 - stencilset.json:我网盘下载链接:https://pan.baidu.com/s/1BS3QDubAyhXAMNJJ-g5g0g ,提取码:u3jt
- bootstrap-3.3.7-dist.zip:bootstrap的类库,做页面时使用。我的网盘下载链接:https://pan.baidu.com/s/1wsBVGG6RppjuHfk75nb1jw ,提取码:ffb4
- jquery: 我的网盘下载链接:链接:https://pan.baidu.com/s/1EQmP8NaqP512B9CYR0XViQ
提取码:xq53
三、整合过程
3.1、创建数据库
解压 activiti-6.0.0官方实例 ,根据自己安装的数据库版本选择相应的activiti6数据库创建sql。解压后,sql存放路径:\activiti-6.0.0\database\create。创建完成后,会有28张表,我使用的数据库名称为“t1”。
注意:根据自己mysql版本选择xx.sql
28张表我是逐一创建,直接导入有问题
3.2、创建一个简单的SpringBoot项目
此步骤为创建SpringBoot项目,没有什么特殊,若熟悉springboot项目,此步可以略过。
3.3、整合资源代码到项目中
我们的在线设计器使用5.22.0版本。并将activiti5.22.0官方示例中的actiti-explorer.war包中的diagram-viewer、editor-app、favicon.ico 放入springboot静态资源目录static中;
整合后台代码:提取activiti-5.22.0\libs\activiti-modeler-5.22.0-sources.jar中的相关代码类,具体目录是:activiti-modeler-5.22.0-sources.jar\org\activiti\rest\editor\model\ModelEditorJsonRestResource.java(此类用于在线编辑器编辑工作流模型)、activiti-modeler-5.22.0-sources.jar\org\activiti\rest\editor\model\ModelSaveRestResource.java(此类用于保存工作流模型)、activiti-modeler-5.22.0-sources.jar\org\activiti\rest\editor\main\StencilsetRestResource.java(此类用于汉化在线编辑器)放到项目中。
至此,设计器所需的资源与代码整合完毕。
3.4、整合配置文件
pom.xml文件:主要引入Druid DataSource数据源、mysql、Activiti6.0及xml图形 这4中类库。
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.0.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.activity</groupId>
<artifactId>my_activity</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>my_activity</name>
<description>Demo project for Spring Boot</description>
<properties>
<springboot.version>2.2.0.RELEASE</springboot.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<xmlgraphics.version>1.7</xmlgraphics.version>
<druid.version>1.1.10</druid.version>
<activiti.version>6.0.0</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>
<exclusions>
<exclusion>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-core-asl</artifactId>
</exclusion>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</exclusion>
<exclusion>
<artifactId>spring-context</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>spring-jdbc</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>spring-tx</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>spring-orm</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>spring-beans</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>mybatis</artifactId>
<groupId>org.mybatis</groupId>
</exclusion>
<exclusion>
<artifactId>activation</artifactId>
<groupId>javax.activation</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-spring-boot-starter-basic</artifactId>
<version>${activiti.version}</version>
</dependency>
<!-- Activiti 流程图 -->
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-common-rest</artifactId>
<version>${activiti.version}</version>
</dependency>
<!-- Activiti 在线设计 -->
<dependency>
<groupId>org.activiti</groupId>
<artifactId>activiti-modeler</artifactId>
<version>5.22.0</version>
<exclusions>
<exclusion>
<artifactId>spring-beans</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>spring-context</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>spring-core</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>spring-tx</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>spring-web</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>spring-security-config</artifactId>
<groupId>org.springframework.security</groupId>
</exclusion>
<exclusion>
<artifactId>spring-security-core</artifactId>
<groupId>org.springframework.security</groupId>
</exclusion>
<exclusion>
<artifactId>spring-security-crypto</artifactId>
<groupId>org.springframework.security</groupId>
</exclusion>
<exclusion>
<artifactId>spring-security-web</artifactId>
<groupId>org.springframework.security</groupId>
</exclusion>
<exclusion>
<artifactId>spring-webmvc</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
<exclusion>
<artifactId>activation</artifactId>
<groupId>javax.activation</groupId>
</exclusion>
<exclusion>
<artifactId>commons-io</artifactId>
<groupId>commons-io</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>${springboot.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.3</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.10.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<!-- Druid DataSource -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>${druid.version}</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<version>RELEASE</version>
<scope>compile</scope>
</dependency>
<!-- xml 图像类库 -->
<dependency>
<groupId>org.apache.xmlgraphics</groupId>
<artifactId>batik-codec</artifactId>
<version>${xmlgraphics.version}</version>
</dependency>
<dependency>
<groupId>org.apache.xmlgraphics</groupId>
<artifactId>batik-css</artifactId>
<version>${xmlgraphics.version}</version>
</dependency>
<dependency>
<groupId>org.apache.xmlgraphics</groupId>
<artifactId>batik-svg-dom</artifactId>
<version>${xmlgraphics.version}</version>
</dependency>
<dependency>
<groupId>org.apache.xmlgraphics</groupId>
<artifactId>batik-svggen</artifactId>
<version>${xmlgraphics.version}</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<executable>true</executable>
</configuration>
</plugin>
</plugins>
</build>
</project>
application.yml文件:与普通springboot项目的yml文件基本相同,主要配置数据源及项目名
server:
port: 8080
# 应用的上下文路径,也可以称为项目路径,是构成url地址的一部分。
# 不配置时,默认为 / ,如:localhost:8080/xxxxxx
# 有配置时,比如 /act,此时的访问方式为localhost:8080/act/xxxxxx
servlet:
context-path: /act
debug: false #设置开发及调试模式
spring:
thymeleaf:
prefix: classpath:/templates/ #thymeleaf 所在路径
suffix: .html #thymeleaf 后缀
mode: HTML5 #thymeleaf 采用的标准
encoding: UTF-8 #thymeleaf 编码格式
#activiti rest 配置
activiti:
rest-api-enabled: true
rest-api-servlet-name: activiti-swagger-document
check-process-definitions: false
SpringProcessEngineConfiguration:
activityFontName: 宋体
labelFontName: 宋体
dataSource: datasource
#数据源
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver # mysql驱动包
# nullCatalogMeansCurrent=true 必须配置,
# 否则不会自动在数据库中创建28张表
url: jdbc:mysql://localhost:3306/t1?nullCatalogMeansCurrent=true&useUnicode=true&characterEncoding=utf-8&useSSL=false&autoReconnect=true&serverTimezone=UTC
username: root
password: root
type: com.alibaba.druid.pool.DruidDataSource
http:
encoding:
charset: UTF-8
mvc:
date-format: yyyy-MM-dd #时间参数的格式化
jackson:
time-zone: GMT+8 #默认为格林尼治时间,设置为北京时间
date-format: yyyy-MM-dd HH:mm:ss SSS #设置时间的json的格式
3.5、修改代码
整合的设计器代码只是能够满足官方设计器的使用,如果要整合成我们自己的web项目进行使用,还得根据自己项目的情况进行部分代码的修改与增加。
加映射:为ModelEditorJsonRestResource.java、ModelSaveRestResource.java(此类用于保存工作流模型)、StencilsetRestResource.java(此类用于汉化在线编辑器)这三个类加入映射访问路径 @RequestMapping("service")。
- 修改ModelSaveRestResource参数:将“@RequestBody MultiValueMap<String, String> values”的传参方式改为单个参数传参。
/**
* @param modelId 模型ID
* @param name 模型名称
* @param description 模型描述
* @param json_xml 对应的jsonxml
* @param svg_xml 对应的svgxml
*
* */
@RequestMapping(value="/model/{modelId}/save", method = RequestMethod.PUT)
@ResponseStatus(value = HttpStatus.OK)
public void saveModel(@PathVariable String modelId, String name, String description,
String json_xml,String svg_xml) {
try {
Model model = repositoryService.getModel(modelId);
ObjectNode modelJson = (ObjectNode) objectMapper.readTree(model.getMetaInfo());
modelJson.put(MODEL_NAME, name);
modelJson.put(MODEL_DESCRIPTION, description);
model.setMetaInfo(modelJson.toString());
model.setName(name);
repositoryService.saveModel(model);
repositoryService.addModelEditorSource(model.getId(), json_xml.getBytes("utf-8"));
InputStream svgStream = new ByteArrayInputStream(svg_xml.getBytes("utf-8"));
TranscoderInput input = new TranscoderInput(svgStream);
PNGTranscoder transcoder = new PNGTranscoder();
// Setup output
ByteArrayOutputStream outStream = new ByteArrayOutputStream();
TranscoderOutput output = new TranscoderOutput(outStream);
// Do the transformation
transcoder.transcode(input, output);
final byte[] result = outStream.toByteArray();
repositoryService.addModelEditorSourceExtra(model.getId(), result);
outStream.close();
} catch (Exception e) {
LOGGER.error("Error saving model", e);
throw new ActivitiException("Error saving model", e);
}
}
- 加入默认工作流文件:系统启动时默认加载工作流文件,建立一个文件放进去即可。
- 提示:需要提前下载并安装bpmn插件,网上搜索即可
- 修改app-cfg.js文件:系统启动时默认加载工作流文件,建立一个文件放进去即可。
- 修改modeler.html页面的js路径:根据自己的项目映射名称修改。
3.6、添加工作流控制器
package com.activity.my_activity.controller;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.activiti.bpmn.model.BpmnModel;
import org.activiti.editor.constants.ModelDataJsonConstants;
import org.activiti.editor.language.json.converter.BpmnJsonConverter;
import org.activiti.engine.HistoryService;
import org.activiti.engine.RepositoryService;
import org.activiti.engine.RuntimeService;
import org.activiti.engine.repository.Deployment;
import org.activiti.engine.repository.Model;
import org.activiti.engine.runtime.ProcessInstance;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* 工作流操作类
* @author Dongyang
*/
@Controller
public class ActititiCtrl {
//日志
private static final Logger logger = LoggerFactory.getLogger(ActititiCtrl.class);
@Autowired
//流程服务组件:用于流程定义和存取
private RepositoryService repositoryService;
@Autowired
//历史服务组件:用于获取正在运行或已经完成的流程实例的信息
private HistoryService historyService;
@Autowired
//运行时服务组件:提供了启动流程、查询流程实例、设置获取流程实例变量等功能。
private RuntimeService runtimeService;
@Autowired
//数据模型转换
private ObjectMapper objectMapper;
/**
* 首页控制器:获取工作流模型列表控制器
*
* @param modelAndView 页面对象
* @return 返回页面对象
*/
@RequestMapping("/")
public ModelAndView index(ModelAndView modelAndView) {
modelAndView.setViewName("index");
//通过流程服务组件获取当前的工作流模型列表
List<Model> actList = repositoryService.createModelQuery().list();
modelAndView.addObject("actList", actList);
return modelAndView;
}
/**
* 跳转编辑器/编辑工作流页面
*
* @return
*/
@GetMapping("/editor")
public String editor() {
return "modeler";
}
/**
* 创建模型
*
* @param response
*/
@RequestMapping("/create")
public void create(HttpServletResponse response) throws IOException {
//创建一个空模型
Model model = repositoryService.newModel();
//设置一下默认信息
String modelName = "new-model";//模型名称
String modelKey = "new-key";// 模型key
String modelDescription = ""; //模型描述
int modelVersion = 1; //默认版本号
ObjectNode modelNode = objectMapper.createObjectNode();
modelNode.put(ModelDataJsonConstants.MODEL_NAME, modelName);
modelNode.put(ModelDataJsonConstants.MODEL_DESCRIPTION, modelDescription);
modelNode.put(ModelDataJsonConstants.MODEL_REVISION, modelVersion);
model.setName(modelName);
model.setKey(modelKey);
model.setMetaInfo(modelNode.toString());
repositoryService.saveModel(model);
createObjectNode(model.getId());
response.sendRedirect("/act/editor?modelId=" + model.getId());
logger.info("创建模型结束,返回模型ID:{}", model.getId());
}
/**
* 创建模型时完善ModelEditorSource
*
* @param modelId
*/
@SuppressWarnings("/deprecation")
private void createObjectNode(String modelId) {
logger.info("创建模型完善ModelEditorSource入参模型ID:{}", modelId);
ObjectNode editorNode = objectMapper.createObjectNode();
editorNode.put("id", "canvas");
editorNode.put("resourceId", "canvas");
ObjectNode stencilSetNode = objectMapper.createObjectNode();
stencilSetNode.put("namespace", "http://b3mn.org/stencilset/bpmn2.0#");
editorNode.put("stencilset", stencilSetNode);
try {
repositoryService.addModelEditorSource(modelId, editorNode.toString().getBytes("utf-8"));
} catch (Exception e) {
logger.info("创建模型时完善ModelEditorSource服务异常:{}", e);
}
logger.info("创建模型完善ModelEditorSource结束");
}
/**
* 发布流程
*
* @param modelId 模型ID
* @return
*/
@ResponseBody
@RequestMapping("/publish")
public Object publish(String modelId) {
logger.info("流程部署入参modelId:{}", modelId);
Map<String, String> map = new HashMap<String, String>();
try {
Model modelData = repositoryService.getModel(modelId);
byte[] bytes = repositoryService.getModelEditorSource(modelData.getId());
if (bytes == null) {
logger.info("部署ID:{}的模型数据为空,请先设计流程并成功保存,再进行发布", modelId);
map.put("code", "FAILURE");
return map;
}
JsonNode modelNode = new ObjectMapper().readTree(bytes);
BpmnModel model = new BpmnJsonConverter().convertToBpmnModel(modelNode);
Deployment deployment = repositoryService.createDeployment()
.name(modelData.getName())
.addBpmnModel(modelData.getKey() + ".bpmn20.xml", model)
.deploy();
modelData.setDeploymentId(deployment.getId());
repositoryService.saveModel(modelData);
map.put("code", "SUCCESS");
} catch (Exception e) {
logger.info("部署modelId:{}模型服务异常:{}", modelId, e);
map.put("code", "FAILURE");
}
logger.info("流程部署出参map:{}", map);
return map;
}
/**
* 撤销流程定义
*
* @param modelId 模型ID
* @return
*/
@ResponseBody
@RequestMapping("/revokePublish")
public Object revokePublish(String modelId) {
logger.info("撤销发布流程入参modelId:{}", modelId);
Map<String, String> map = new HashMap<String, String>();
Model modelData = repositoryService.getModel(modelId);
if (null != modelData) {
try {
/**
* 参数不加true:为普通删除,如果当前规则下有正在执行的流程,则抛异常
* 参数加true:为级联删除,会删除和当前规则相关的所有信息,包括历史
*/
repositoryService.deleteDeployment(modelData.getDeploymentId(), true);
map.put("code", "SUCCESS");
} catch (Exception e) {
logger.error("撤销已部署流程服务异常:{}", e);
map.put("code", "FAILURE");
}
}
logger.info("撤销发布流程出参map:{}", map);
return map;
}
/**
* 删除流程实例
*
* @param modelId 模型ID
* @return
*/
@ResponseBody
@RequestMapping("/delete")
public Object deleteProcessInstance(String modelId) {
logger.info("删除流程实例入参modelId:{}", modelId);
Map<String, String> map = new HashMap<String, String>();
Model modelData = repositoryService.getModel(modelId);
if (null != modelData) {
try {
//先删除流程实例,再删除工作流模型
ProcessInstance pi = runtimeService.createProcessInstanceQuery().
processDefinitionKey(modelData.getKey()).singleResult();
if (null != pi) {
runtimeService.deleteProcessInstance(pi.getId(), "");
historyService.deleteHistoricProcessInstance(pi.getId());
}
//删除流程模型
repositoryService.deleteModel(modelId);
map.put("code", "SUCCESS");
} catch (Exception e) {
logger.error("删除流程实例服务异常:{}", e);
map.put("code", "FAILURE");
}
}
logger.info("删除流程实例出参map:{}", map);
return map;
}
}
3.7、添加工作流操作页面
该页面(index.html)用于创建、部署、撤销、删除、编辑工作流的测试,此页面使用前端框架bootstrap-3.3.7-dist与模板引擎 Thymeleaf 编写(可根据自己的需求选择前端框架)。用于对接ActititiCtrl控制器。
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
<meta charset="UTF-8">
<title>工作流模型列表</title>
<link rel="stylesheet" href="/act/js/bootstrap-3.3.7-dist/bootstrap.min.css">
<script src="/act/js/jquery-3.4.1.min.js"></script>
<script src="/act/js/bootstrap-3.3.7-dist/bootstrap.min.js"></script>
</head>
<body>
<div class="panel panel-default" style="margin: 10px" >
<div class="panel-heading">工作流管理</div>
<div class="panel-body">
<a href="/act/create" target="_blank">
<button type="button" class="btn btn-default" aria-label="Left Align">
创建模型
</button>
</a>
</div>
<table class="table">
<thead>
<tr>
<th width="10%">模型编号</th>
<th width="10%">版本</th>
<th width="20%">模型key</th>
<th width="30%">模型名称</th>
<th width="30%">操作</th>
</tr>
</thead>
<tbody>
<tr th:each="actModel,actStat:${actList}">
<th scope="row" th:text="${actModel.id}"></th>
<td th:text="${actModel.version}"></td>
<td th:text="${actModel.key}"></td>
<td th:text="${actModel.name}"></td>
<td>
<a th:href="@{'/publish?modelId='+${actModel.id}}" >部署</a>
<a th:href="@{'/revokePublish?modelId='+${actModel.id}}">撤销</a>
<a th:href="@{'/editor?modelId='+${actModel.id}}">编辑</a>
<a th:href="@{'/delete?modelId='+${actModel.id}}">删除</a>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>
4、整合效果展示
访问地址:http://localhost:8080/act/
创建工作流模型页面
访问:
效果: