Spring Boot 2集成Activiti7

Posted by Kaka Blog on March 25, 2021

Activiti简介

Activiti是一个开源的工作流引擎,它实现了BPMN 2.0规范,可以发布设计好的流程定义,并通过api进行流程调度。其核心是基于 JAVA 的超快速、超稳定的 BPMN2.0 流程引擎,强调流程服务的可嵌入性和可扩展性,同时更加强调面向业务人员。

Activiti快速使用

1、创建Spring Boot应用,最近Spring Initializr默认https://start.spring.io访问超时,改成https://start.springboot.io才可以。

2、pom文件添加相关依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.1.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <java.version>1.8</java.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.54</version>
    </dependency>

    <dependency>
        <groupId>org.activiti</groupId>
        <artifactId>activiti-spring-boot-starter</artifactId>
        <version>7.1.0.M2</version>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

3、修改配置文件

spring.datasource.url=jdbc:mysql://localhost:5218/activitidemo?nullCatalogMeansCurrent=true&useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

spring.activiti.history-level=full
spring.activiti.db-history-used=true
  • 默认会加载classpath路径下面processes文件夹下面的bpmn文件
  • spring.activiti.history-levelactiviti的历史记录级别分为以下四种:none, activity, audit, full
    • none: 不记录历史流程,性能高,流程结束后不可读取
    • activity: 归档流程实例和活动实例,流程变量不同步
    • audit: 默认值,在activiti基础上同步变量值,保存表单属性
    • full: 性能较差,记录所有实例和变量细节变化,最完整的历史记录,如果需要日后跟踪详细可以开启full(一般不建议开启)
  • spring.activiti.db-history-used:表示是用历史表,如果不设置为true那么只会生成17张表,只有设置为true后才会生成25张表。如果不生成历史表那么,流程图及运行节点无法展示。

4、Activiti7引入了Spring Security,所以需要配置注入UserDetailsService

@Configuration
public class ActivitiConfig {
    private Logger logger = LoggerFactory.getLogger(ActivitiConfig.class);

    @Bean
    public UserDetailsService myUserDetailsService() {

        InMemoryUserDetailsManager inMemoryUserDetailsManager = new InMemoryUserDetailsManager();

        String[][] usersGroupsAndRoles = {
                {"salaboy", "password", "ROLE_ACTIVITI_USER", "GROUP_activitiTeam"},
                {"wangwu", "password", "ROLE_ACTIVITI_USER", "GROUP_activitiTeam"},
                {"lisi", "password", "ROLE_ACTIVITI_USER", "GROUP_activitiTeam"},
                {"zhangsan", "password", "ROLE_ACTIVITI_USER", "GROUP_otherTeam"},
                {"admin", "password", "ROLE_ACTIVITI_ADMIN"},
        };

        for (String[] user : usersGroupsAndRoles) {
            List<String> authoritiesStrings = Arrays.asList(Arrays.copyOfRange(user, 2, user.length));
            logger.info("> Registering new user: " + user[0] + " with the following Authorities[" + authoritiesStrings + "]");
            inMemoryUserDetailsManager.createUser(new User(user[0], passwordEncoder().encode(user[1]),
                    authoritiesStrings.stream().map(s -> new SimpleGrantedAuthority(s)).collect(Collectors.toList())));
        }


        return inMemoryUserDetailsManager;
    }


    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }
}

5、在resources文件夹创建processes文件夹,创建bpmn文件,需要先安装ActiBPM插件,插件安装可查看https://blog.csdn.net/x15011238662/article/details/86488754

6、编写测试类

package com.fang.demo.activitidemo;

import com.alibaba.fastjson.JSON;
import org.activiti.engine.*;
import org.activiti.engine.history.HistoricTaskInstance;
import org.activiti.engine.runtime.ProcessInstance;
import org.activiti.engine.task.Task;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.HashMap;
import java.util.List;

@SpringBootTest
class ActivitiDemoApplicationTests {

    @Autowired
    private ProcessEngine processEngine;
    @Autowired
    private RepositoryService repositoryService;
    @Autowired
    private HistoryService historyService;
    @Autowired
    private TaskService taskService;
    @Autowired
    private RuntimeService runtimeService;

    /**
     * 启动审批流程
     */
    @Test
    public void startProcess() {
        ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("myOutside");
        System.out.println("processInstance.getId() = " + processInstance.getId());
    }

    /**
     * 获取审批列表
     */
    @Test
    public void listProcess() {
        List<Task> list = taskService.createTaskQuery().processDefinitionKey("myOutside").taskCandidateOrAssigned("zhangsan").list();
        System.out.println("list = " + list);
    }

    /**
     * 完成审批
     */
    @Test
    public void completeTask() {
        Task task = taskService.createTaskQuery().processDefinitionKey("myOutside").taskCandidateOrAssigned("wangwu").singleResult();
//        taskService.claim(task.getId(), task.getAssignee());
        HashMap<String, Object> vars = new HashMap<>();
        vars.put("sign", "同意");
        taskService.complete(task.getId(), vars);
        System.out.println("task = " + task);
    }

    /**
     * 获取历史审批任务实例查询
     */
    @Test
    public void listHistoryTask() {
        List<HistoricTaskInstance> list = historyService.createHistoricTaskInstanceQuery().list();
        list.stream().forEach(item -> {
            System.out.println("item = " + JSON.toJSONString(item));
        });
    }

    /**
     * 获取历史流程实例
     */
    @Test
    public void listHistoryProcessInstance() {
        List<HistoricProcessInstance> list = historyService.createHistoricProcessInstanceQuery().list();
        list.stream().forEach(item -> {
            System.out.println("JSON.toJSONString(item) = " + JSON.toJSONString(item));
        });
    }
}

7、运行时先创建数据库,会自动生成25张表。

详细说明

数据库表说明

  • ACT_RE_*: ‘RE’表示repository。这个前缀的表包含了流程定义和流程 静态资源(图片、规则等等)
  • ACT_RU_*: ‘RU’表示runtime。这些运行时的表,包含流程实例,认为,变量,异步任务等运行中的数据。Activiti只在流程实例执行过程中保持这些数据,在流程结束时就会删除这些记录。这样运行时表可以一直很小速度很快。
  • ACT_HI_*: ‘HI’表示history。这些表包含历史数据,比如历史流程实例,遍历,任务等等。
  • ACT_GE_*: ‘GE’表示general。通用数据,用于不同场景。

  • 资源库流程规则表
    • 1)act_re_deployment 部署信息表
    • 2)act_re_model 流程设计模型部署表
    • 3)act_re_procdef 流程定义数据表
  • 运行时数据库表
    • 1)act_ru_execution 运行时流程执行实例表
    • 2)act_ru_identitylink 运行时流程人员表,主要存储任务节点与参与者的相关信息
    • 3)act_ru_task 运行时任务节点表
    • 4)act_ru_variable 运行时流程变量数据表
  • 历史数据库表
    • 1)act_hi_actinst 历史节点表
    • 2)act_hi_attachment 历史附件表
    • 3)act_hi_comment 历史意见表
    • 4)act_hi_identitylink 历史流程人员表
    • 5)act_hi_detail 历史详情表,提供历史变量的查询
    • 6)act_hi_procinst 历史流程实例表
    • 7)act_hi_taskinst 历史任务实例表
    • 8)act_hi_varinst 历史变量表
  • 组织机构表
    • 1)act_id_group 用户组信息表
    • 2)act_id_info 用户扩展信息表
    • 3)act_id_membership 用户与用户组对应信息表
    • 4)act_id_user 用户信息表
  • 通用数据表
    • 1)act_ge_bytearray 二进制数据表
    • 2)act_ge_property 属性数据表存储整个流程引擎级别的数据,初始化表结构时,会默认插入三条记录。

核心类

  • ProcessEngine:流程引擎的抽象,可以通过此类获取需要的所有服务。通过ProcessEngine获取,Activiti将不同生命周期的服务封装在不同Service中,包括定义、部署、运行。通过服务类可获取相关生命周期中的服务信息。
  • TaskService:流程运行过程中,每个任务节点的相关操作接口,如complete,delete,delegate等。
  • RepositoryService:流程定义和部署相关的存储服务。
  • RuntimeService:流程运行时相关的服务,如根据流程好启动流程实例startProcessInstanceByKey。
  • HistoryService:历史记录相关服务接口。

FAQ

1、Spring Boot 装配DataSource缺少依赖导致失败

Field dataSource in *.leaf.util.db.DBManager required a bean of type 'javax.sql.DataSource' that could not be found.
- Bean method 'dataSource' not loaded because @ConditionalOnClass did not find required class 'org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType'
- Bean method 'dataSource' not loaded because @ConditionalOnClass did not find required classes 'javax.transaction.TransactionManager', 'org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType'

解决:

增加依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

2、bpmn文件中文乱码,或异常二:ORG.ACTIVITI.BPMN.EXCEPTIONS.XMLEXCEPTION: 3 字节的 UTF-8 序列的字节 3 无效。

解决:

如果是64位:IntelliJ IDEA 14.0.2\bin\idea64.exe.vmoptions文件最后一行添加-Dfile.encoding=UTF-8

如果是32位:IntelliJ IDEA 14.0.2\bin\idea.exe.vmoptions文件最后一行添加-Dfile.encoding=UTF-8

3、异常一:ERROR UPDATING DATABASE. CAUSE: JAVA.SQL.SQLSYNTAXERROREXCEPTION: UNKNOWN COLUMN ‘VERSION_’ IN ‘FIELD LIST’

解决:

将依赖修改为 7.1.0.M2 版本即可解决

<dependency>
    <groupId>org.activiti</groupId>
    <artifactId>activiti-spring-boot-starter</artifactId>
    <version>7.1.0.M2</version>
</dependency>

参考资料