Activiti实战——Springboot整合Activiti

目录

一、Activiti数据库表名说明

 二、Spring boot整合activiti

1. 创建springboot项目

2. 引入activiti依赖及项目依赖

3. 配置数据源

（1）创建数据源配置文件

（2）配置文件

4. 配置Acitviti引擎

5. 启动项目

 三、Activiti接口

1. 流程引擎API和服务

 2. 使用Activiti服务

（1）绘制流程图，生成bpmn文件

（2）部署流程定义

 （3）启动流程

（4）查询待办任务列表

（5）完成任务

 （6）暂停和激活流程定义

（7）查询接口

（8）EUL表达式

 四、BPMN2.0简介

1. 定义一个过程

 五、查询历史

 1. 历史过程实例查询

 2. 历史变量实例查询

 3. 历史活动实例查询

 4. 历史细节查询

5. 历史任务实例查询

6. 历史配置

---

Activiti官方文档：Activiti User Guide

本篇博客代码地址：https://gitee.com/zhangyin_0116/springboot-activiti-learn.git

一、Activiti数据库表名说明

 二、Spring boot整合activiti

1. 创建springboot项目

2. 引入activiti依赖及项目依赖

    
        
            org.springframework.boot
            spring-boot-starter-security
        

        
            org.projectlombok
            lombok
            true
        
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
        
            org.springframework.security
            spring-security-test
            test
        
        
        
        
            mysql
            mysql-connector-java
            8.0.26
        

        
            com.alibaba
            druid
            1.2.8
        

        
        
            org.activiti
            activiti-spring-boot-starter
            7.1.0.M6
        
    

        通过引入activiti-spring-boot-starter依赖项，可以轻松地在Spring Boot应用程序中集成和配置Activiti引擎，而无需手动配置所有的Activiti相关组件和依赖项。

        该依赖项提供了一系列自动配置类和默认配置，使得Activiti的集成变得更加简单。它会自动配置数据库连接、事务管理器、流程引擎以及与Spring Boot框架的其他集成。

        使用activiti-spring-boot-starter依赖项，可以通过@Autowired注解轻松注入Activiti的各种服务接口（如RepositoryService、RuntimeService、TaskService等），并使用它们操作流程引擎。

        此外，该依赖项还提供了一些自定义属性配置，您可以通过在application.properties或application.yml文件中进行相应配置来定制Activiti的行为。 

3. 配置数据源

（1）创建数据源配置文件

@Configuration
public class DruidConfig {

    @Value("${spring.datasource.url}")
    private String url;

    @Value("${spring.datasource.username}")
    private String username;

    @Value("${spring.datasource.password}")
    private String password;

    @Value("${spring.datasource.driver-class-name}")
    private String driverClassName;

    @Bean
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        dataSource.setDriverClassName(driverClassName);
        // 其他 Druid 相关配置，如最大连接数、初始连接数等
        return dataSource;
    }

    @Bean
    public PlatformTransactionManager transactionManager() {
        return new DataSourceTransactionManager(dataSource());
    }

}

（2）配置文件

# 数据源配置
spring:
  datasource:
    driverClassName: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/activiti-learn?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8&nullCatalogMeansCurrent=true
    username: root
    password: 123456

4. 配置Acitviti引擎

@Configuration
public class ActivitiConfiguration {
    @Autowired
    private DataSource dataSource;
    @Autowired
    private PlatformTransactionManager platformTransactionManager;

    public ActivitiConfiguration() {
    }

    //通过@Bean注解将SpringProcessEngineConfiguration实例声明为Spring Bean，使其可供其他组件注入和使用
    @Bean
    public SpringProcessEngineConfiguration springProcessEngineConfiguration() {
        SpringProcessEngineConfiguration spec = new SpringProcessEngineConfiguration();
        //设置数据源，将注入的数据源设置到SpringProcessEngineConfiguration实例中
        spec.setDataSource(this.dataSource);
        //设置事务管理器将注入的事务管理器设置到SpringProcessEngineConfiguration实例中
        spec.setTransactionManager(this.platformTransactionManager);
        //设置数据库模式更新策略 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;
    }
}

5. 启动项目

启动项目，可以看到对应的数据库中自动生成了与Activiti相关的表。

 三、Activiti接口

1. 流程引擎API和服务

从 ProcessEngine 中，可以获取包含工作流/BPM 方法的各种服务。

ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();

RuntimeService runtimeService = processEngine.getRuntimeService();
RepositoryService repositoryService = processEngine.getRepositoryService();
TaskService taskService = processEngine.getTaskService();
ManagementService managementService = processEngine.getManagementService();
IdentityService identityService = processEngine.getIdentityService();
HistoryService historyService = processEngine.getHistoryService();
FormService formService = processEngine.getFormService();
DynamicBpmnService dynamicBpmnService = processEngine.getDynamicBpmnService();

 2. 使用Activiti服务

（1）绘制流程图，生成bpmn文件

这里是一个请假的流程定义bpmn文件：

  
    请假流程演示
    
    
    
    
      
        
      
    
    
    
    

    
    
    
    
    
    
    
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
  

（2）部署流程定义

部署流程定义的方法有很多种，这里只介绍一种实际项目中最常用的。

    @Autowired
    private ProcessEngine processEngine;

    @Autowired
    private RepositoryService repositoryService;

    @Test
    void deployProcessDefinition() throws FileNotFoundException {
        String processDefinitionFilePath = "D:\Java_Dev\IDEA_Projects\Personal_project\springboot-activiti-learn\src\main\resources\leave.bpmn";
        Deployment deploy = this.repositoryService.createDeployment()
                .addInputStream(processDefinitionFilePath, new FileInputStream(processDefinitionFilePath))
                .deploy();
        System.out.println("部署流程定义成功："+ deploy);
    }

查看数据库表 act_re_procdef：

可以看到已经部署成功

 （3）启动流程

启动流程的方法也有很多种，这里介绍的方法是比较常用的启动流程的方法，需要传递三个参数，分别是：

processDefinitionKey(流程定义key), businessKey(业务key), variables(参数)

这里我们使用流程定义的id去查询流程定义的key，用流程定义的key来启动流程

    @Test
    void startProcessInstance() {

        //启动流程时传递的参数列表 这里根据实际情况 也可以选择不传
        Map variables = new HashMap();
        variables.put("姓名", "张三");
        variables.put("请假天数", new Integer(4));
        variables.put("请假原因", "我很累！");

        // 根据流程定义ID查询流程定义  leave:1:10004是我们刚才部署的流程定义的id
        ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery()
                .processDefinitionId("leave:1:10004")
                .singleResult();

        // 获取流程定义的Key
        String processDefinitionKey = processDefinition.getKey();

        //定义businessKey  businessKey一般为流程实例key与实际业务数据的结合
        //假设一个请假的业务 在数据库中的id是1001
        String businessKey = processDefinitionKey + ":" + "1001";
        //设置启动流程的人
        Authentication.setAuthenticatedUserId("xxyin");
        ProcessInstance processInstance = this.runtimeService
                .startProcessInstanceByKey(processDefinitionKey, businessKey, variables);
        System.out.println("流程启动成功：" + processInstance);
    }

查看数据库表 act_hi_procinst：

（4）查询待办任务列表

    @Test
    void findTodoTask() {
        TaskQuery taskQuery = ((TaskQuery)taskService.createTaskQuery().orderByTaskCreateTime()).asc();
        // 
        //添加查询条件 查询指派给 zhangsan 的任务  假设这个任务指派给了zhangsan
        taskQuery.taskAssignee("zhangsan");
        //添加查询条件 查询流程定义key为 leave 的任务
        taskQuery.processDefinitionKey("leave");
        List tasks = taskQuery.list();
        // 处理查询结果
        for (Task task : tasks) {
            System.out.println("Task ID: " + task.getId());
            System.out.println("Task Name: " + task.getName());
            // 其他任务属性的获取和处理
        }
    }

运行结果：

Task ID: 15010
Task Name: 部门领导审批

（5）完成任务

通过查询可以看到当前流转到的任务是“部门领导审批”，可以在表act_ru_task中看到：

 

    @Test
    void complete() {
        //这里模拟传进来的参数
        String taskId = "15010";
        String assignee = "zhangsan";
        Map variables = new HashMap();
        variables.put("pass",true);
        variables.put("comment","同意请假");

        //根据任务id获取到当前的任务
        TaskQuery query = this.taskService.createTaskQuery();
        Task task = (Task)((TaskQuery)query.taskId(taskId)).singleResult();

        //将参数列表的评论赋值给comment
        String taskComment = variables.remove("comment").toString();
        //向特定的任务添加评论
        if (!taskComment.equals("")) {
            taskService.addComment(taskId, task.getProcessInstanceId(), taskComment);
        }
        //如果当前任务没有指派人，需要先使用 claim() 方法领取任务
        taskService.claim(taskId,assignee);
        //如果有指派人，直接完成任务
        taskService.complete(taskId,variables);
    }

完成该任务后，再次查看 act_ru_task 表，可以看到任务已经流转到了“人事审批”：

查看评论表act_hi_comment，可以看到任务评论已经添加到对应的任务上：

 （6）暂停和激活流程定义

可以挂起进程定义。挂起流程定义时，无法创建新的流程实例（将引发异常）。暂停进程定义是通过 ：RepositoryService

    @Test
    void suspendProcessDefinition() {
        repositoryService.suspendProcessDefinitionByKey("leave");
        try {
            runtimeService.startProcessInstanceByKey("leave");
        } catch (ActivitiException e) {
            e.printStackTrace();
        }
    }

 运行结果：

2023-05-21 21:10:08.425 ERROR 29036 --- [           main] o.a.e.impl.interceptor.CommandContext    : Error while closing command context

org.activiti.engine.ActivitiException: Cannot start process instance. Process definition 请假流程-普通表单 (id = leave:1:10004) is suspended

如果想要激活，执行：

repositoryService.activateProcessDefinitionByKey("leave");

（7）查询接口

有两种方式可以从引擎查询数据，查询API和native查询

• 查询 API

        允许使用流畅的 API 对完全类型安全的查询进行编程，例如：

List tasks = taskService.createTaskQuery()
    .taskAssignee("zhangsan")
    .processVariableValueEquals("name", "zhangsan")
    .orderByDueDate().asc()
    .list();

• native查询

         允许您编写自己的 SQL 查询。返回类型由您使用的 Query 对象定义，数据映射到正确的对象中，例如 Task、ProcessInstance、Execution 等。由于查询将在数据库中触发，因此必须使用数据库中定义的表名和列名;

这个是查询任务名为“人事审批”的任务：

    @Test
    void nativeAPI() {
        // 创建原生任务查询对象 查询任务名为 人事审批 的任务
        NativeTaskQuery nativeTaskQuery = taskService.createNativeTaskQuery()
                .sql("SELECT * FROM " + managementService.getTableName(Task.class) + " T WHERE T.NAME_ = #{taskName}")
                .parameter("taskName", "人事审批");

        // 执行查询并获取结果
        List tasks = nativeTaskQuery.list();

        // 处理查询结果
        for (Task task : tasks) {
            System.out.println("Task ID: " + task.getId());
            System.out.println("Task Name: " + task.getName());
            // 其他任务属性的获取和处理
        }
    }

这个是查询任务id为 35006 ，并且没有指派人的任务：

    @Test
    void nativeAPI2() {
        // 创建原生任务查询对象
        NativeTaskQuery nativeTaskQuery = taskService.createNativeTaskQuery()
                .sql("SELECT * FROM " + managementService.getTableName(Task.class) +
                        " T WHERE T.ID_ = #{taskId} AND T.ASSIGNEE_ = #{assignee}" )
                .parameter("taskId","35006")
                .parameter("assignee", "");

        // 执行查询并获取结果
        List tasks = nativeTaskQuery.list();

        // 处理查询结果
        for (Task task : tasks) {
            System.out.println("Task ID: " + task.getId());
            System.out.println("Task Name: " + task.getName());
            // 其他任务属性的获取和处理
        }
    }
}

运行结果：

Task ID: 35006
Task Name: 人事审批

（8）EUL表达式

Activiti 使用 UEL 进行表达式解析。UEL 代表统一表达式语言，是 EE6 规范的一部分。分为两种：值表达式和方法表达式

• 值表达式：解析为一个值。默认情况下，所有流程变量都可供使用。

${myVar}
${myBean.myProperty}

•  方法表达式：调用方法，带或不带参数。调用不带参数的方法时，请确保在方法名称后添加空括号（因为这会将表达式与值表达式区分开来）。传递的参数可以是文本值或自行解析的表达式。例子：

${printer.print()}
${myBean.addNewOrder('orderName')}
${myBean.doSomething(myVar, execution)}

在所有流程变量之上，还有一些默认对象可用于表达式：

• execution：保存有关正在进行的执行的其他信息的 。DelegateExecution

• task：保存有关当前任务的其他信息的 。注意：仅适用于从任务侦听器计算的表达式。DelegateTask

• authenticatedUserId：当前经过身份验证的用户的 ID。如果没有用户经过身份验证，则该变量不可用。

 四、BPMN2.0简介

1. 定义一个过程

• process：有两个属性 id 和 name。

  
    ..
  

• sequenceFlow：序列流

   100 && order.price 

• exclusiveGateway 排他网关

在XML中的表示：

  ${input == 1}



  ${input == 2}



  ${input == 3}

•  parallelGateway：并行网关

 XML定义如下：

 五、查询历史

在 API 中，可以查询所有 5 个历史记录实体：

 1. 历史过程实例查询

    @Test
    void historyAPI1() {
        List processInstances = historyService.createHistoricProcessInstanceQuery()
                .processDefinitionKey("leave")
                .orderByProcessInstanceDuration()
                .desc()
                .listPage(0, 10);
        System.out.println("ProcessInstance: "+ processInstances);
    }

 2. 历史变量实例查询

    @Test
    void historyAPI2() {
        List historicVariableInstances = historyService.createHistoricVariableInstanceQuery()
                .processInstanceId("60002")
                .orderByVariableName().desc()
                .list();
        System.out.println("historicVariableInstances: "+ historicVariableInstances);
    }

 3. 历史活动实例查询

查询已经完成的任务（用户任务）：

    @Test
    void historyAPI3() {
        List userTask = historyService.createHistoricActivityInstanceQuery()
                .activityType("userTask")
                .processDefinitionId("leave:1:10004")
                .finished()
                .orderByHistoricActivityInstanceEndTime()
                .desc()
                .listPage(0, 1);
        System.out.println("userTask: "+ userTask);
    }

 4. 历史细节查询

    @Test
    void historyAPI4() {
        List historicDetails = historyService.createHistoricDetailQuery()
                .variableUpdates()
                .processInstanceId("60002")
                .orderByVariableName().asc()
                .list();
        System.out.println("historicDetails: "+ historicDetails);
    }

5. 历史任务实例查询

查询已完成的任务：

    @Test
    void historyAPI5() {
        List historicTaskInstances = historyService.createHistoricTaskInstanceQuery()
                .finished()
                .orderByHistoricTaskInstanceDuration()
                .desc()
                .listPage(0, 10);
        System.out.println("historicTaskInstances: "+ historicTaskInstances);
    }

 查询未完成的任务：

    @Test
    void historyAPI6() {
        List historicTaskInstances = historyService.createHistoricTaskInstanceQuery()
                .unfinished()
                .orderByHistoricTaskInstanceDuration()
                .desc()
                .listPage(0, 10);
        System.out.println("historicTaskInstances: "+ historicTaskInstances);
    }

6. 历史配置

• none：跳过所有历史记录存档。这是运行时进程执行的最高性能，但没有历史信息可用。

• activity：存档所有流程实例和活动实例。在流程实例结束时，顶级流程实例变量的最新值将被复制到历史变量实例中。不会存档任何详细信息。

• audit：这是默认值。它存档所有流程实例、活动实例，使变量值持续同步以及提交的所有表单属性，以便通过表单进行的所有用户交互都是可追溯的并且可以审核的。

• full：这是历史存档的最高级别，因此速度最慢。此级别存储级别中的所有信息以及所有其他可能的详细信息，主要是过程变量更新。audit