Activiti——搭建环境(Maven+MySQL)

左手的ㄟ右手 2023-10-15 11:19 10阅读 0赞

#### 目录 ####

*  搭建Activiti开发环境
 *   *  1、引入依赖
     *  2、配置文件
     *   *  2.1、日志配置
         *  2.2、activiti配置
         *   *  2.2.1、直接配置processEngineConfiguration
             *  2.2.2、配置数据源后，在processEngineConfiguration 引用
     *  3、生成表结构
     *   *  3.1、Activiti支持的数据库
         *  3.2、在MySQL生成表
     *  4、表结构简介
     *   *  4.1、表的命名规则和作用
         *  4.2、Activiti数据表介绍
         *  
     *  5、Hello World
     *   *  5.1、流程定义文件
         *  5.2、单元测试
         *  5.3、添加业务节点

## 搭建Activiti开发环境 ##

### 1、引入依赖 ###

maven依赖如下：

<properties>
        <slf4j.version>1.6.6</slf4j.version>
        <log4j.version>1.2.12</log4j.version>
        <activiti.version>7.0.0.Beta1</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>
        </dependency>
        
        <dependency>
            <groupId>org.activiti</groupId>
            <artifactId>activiti-bpmn-model</artifactId>
            <version>${activiti.version}</version>
        </dependency>
        
        <dependency>
            <groupId>org.activiti</groupId>
            <artifactId>activiti-bpmn-converter</artifactId>
            <version>${activiti.version}</version>
        </dependency>
        
        <dependency>
            <groupId>org.activiti</groupId>
            <artifactId>activiti-json-converter</artifactId>
            <version>${activiti.version}</version>
        </dependency>
        
        <dependency>
            <groupId>org.activiti</groupId>
            <artifactId>activiti-bpmn-layout</artifactId>
            <version>${activiti.version}</version>
        </dependency>
        
        <dependency>
            <groupId>org.activiti.cloud</groupId>
            <artifactId>activiti-cloud-services-api</artifactId>
            <version>${activiti.version}</version>
        </dependency>
        
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.40</version>
        </dependency>
        
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>
        
        <dependency>
            <groupId>commons-dbcp</groupId>
            <artifactId>commons-dbcp</artifactId>
            <version>1.4</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
        
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
    </dependencies>

### 2、配置文件 ###

#### 2.1、日志配置 ####

log4j.properties

# Set root category priority to INFO and its only appender to CONSOLE.
    #log4j.rootCategory=INFO, CONSOLE debug info warn error fatal
    log4j.rootCategory=debug, CONSOLE, LOGFILE
    # Set the enterprise logger category to FATAL and its only appender to CONSOLE.
    log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE
    # CONSOLE is set to be a ConsoleAppender using a PatternLayout.
    log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
    log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
    log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r[%15.15t] %-5p %30.30c %x - %m\n
    # LOGFILE is set to be a File appender using a PatternLayout.
    log4j.appender.LOGFILE=org.apache.log4j.FileAppender
    log4j.appender.LOGFILE.File=log/activiti.log
    log4j.appender.LOGFILE.Append=true
    log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
    log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r[%15.15t] %-5p %30.30c %x - %m\n

#### 2.2、activiti配置 ####

默认方式的要求是在 resources 下创建 activiti.cfg.xml 文件，注意：默认方式目录和文件名不能修改，因为activiti的源码中已经设置，到固定的目录读取固定文件名的文件。

默认方式要在在activiti.cfg.xml中bean的名字叫processEngineConfiguration，名字不可修改。

在这里有2中配置方式：一种是单独配置数据源，一种是不单独配置数据源

##### 2.2.1、直接配置processEngineConfiguration #####

processEngineConfiguration 用来创建 ProcessEngine，在创建 ProcessEngine 时会执行数据库的操作。

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:context="http://www.springframework.org/schema/context"
           xmlns:tx="http://www.springframework.org/schema/tx"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
                        http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/contex
    http://www.springframework.org/schema/context/spring-context.xsd
    http://www.springframework.org/schema/tx
    http://www.springframework.org/schema/tx/spring-tx.xsd">
        
        
        
        <bean id="processEngineConfiguration"
              class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
            <property name="jdbcDriver" value="com.mysql.jdbc.Driver"/>
            <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/activiti"/>
            <property name="jdbcUsername" value="root"/>
            <property name="jdbcPassword" value="123456"/>
            
            <property name="databaseSchemaUpdate" value="true"/>
        </bean>
    </beans>

##### 2.2.2、配置数据源后，在processEngineConfiguration 引用 #####

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:context="http://www.springframework.org/schema/context"
           xmlns:tx="http://www.springframework.org/schema/tx"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
                        http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/contex
    http://www.springframework.org/schema/context/spring-context.xsd
    http://www.springframework.org/schema/tx
    http://www.springframework.org/schema/tx/spring-tx.xsd">
    
        
        <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
            <property name="driverClassName" value="com.mysql.jdbc.Driver" />
            <property name="url" value="jdbc:mysql://localhost:3306/activiti" />
            <property name="username" value="root" />
            <property name="password" value="123456" />
            <property name="maxActive" value="3" />
            <property name="maxIdle" value="1" />
        </bean>
    
        <bean id="processEngineConfiguration"
              class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
            
            <property name="dataSource" ref="dataSource" />
            
            <property name="databaseSchemaUpdate" value="true"/>
        </bean>
    </beans>

### 3、生成表结构 ###

#### 3.1、Activiti支持的数据库 ####

<table> 
 <thead> 
  <tr> 
   <th>数据库类型</th> 
   <th>最低版本</th> 
   <th>JDBC连接示例</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>h2</td> 
   <td>1.3.168</td> 
   <td>jdbc:h2:tcp://localhost/activiti</td> 
   <td>默认配置的数据库</td> 
  </tr> 
  <tr> 
   <td>mysql</td> 
   <td>5.1.21</td> 
   <td>jdbc:mysql://localhost:3306/activiti?autoReconnect=true</td> 
   <td>使用 mysql-connector-java 驱动测试</td> 
  </tr> 
  <tr> 
   <td>oracle</td> 
   <td>11.2.0.1.0</td> 
   <td>jdbc:oracle:thin:@localhost:1521:xe</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>postgres</td> 
   <td>8.1</td> 
   <td>jdbc:postgresql://localhost:5432/activiti</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>db2</td> 
   <td>DB2 10.1 using db2jcc4</td> 
   <td>jdbc:db2://localhost:50000/activiti</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>mssql</td> 
   <td>2008 using sqljdbc4</td> 
   <td>jdbc:sqlserver://localhost:1433/activiti</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

#### 3.2、在MySQL生成表 ####

创建数据库：

CREATE DATABASE activiti DEFAULT CHARACTER SET utf8;

创建一个测试类，调用activiti的工具类，生成acitivti需要的数据库表。

直接使用activiti提供的工具类ProcessEngines，会默认读取classpath下的activiti.cfg.xml文件，读取其中的数据库配置，创建 ProcessEngine，在创建ProcessEngine 时会自动创建表。

public class TestDemo {
        
    
        /**
         * 生成activiti的数据库表
         */
        @Test
        public void testCreateDbTable() {
        
            //使用classpath下的activiti.cfg.xml中的配置创建processEngine
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            System.out.println(processEngine);
        }
    }

说明：

1.  运行以上程序段即可完成 activiti 表创建，通过改变 activiti.cfg.xml 中databaseSchemaUpdate 参数的值执行不同的数据表处理策略。
2.  上 边 的 方法 getDefaultProcessEngine方法在执行时，从activiti.cfg.xml 中找固定的名称 processEngineConfiguration 。

![在这里插入图片描述][816796e7e0c548b79d3c62640adebcb6.png]

### 4、表结构简介 ###

#### 4.1、表的命名规则和作用 ####

第一部分，Activiti 的表都以`ACT_`开头。

第二部分是表示表的用途的两个字母标识。 用途也和服务的 API 对应。

*  `ACT_RE` ：'RE’表示 repository。 这个前缀的表包含了流程定义和流程静态资源 （图片，规则，等等）。
 *  `ACT_RU`：'RU’表示 runtime。 这些运行时的表，包含流程实例，任务，变量，异步任务，等运行中的数据。 Activiti 只在流程实例执行过程中保存这些数据， 在流程结束时就会删除这些记录。 这样运行时表可以一直很小速度很快。
 *  `ACT_HI`：'HI’表示 history。 这些表包含历史数据，比如历史流程实例， 变量，任务等等。
 *  `ACT_GE` ： GE 表示 general。 通用数据， 用于不同场景下 。

#### 4.2、Activiti数据表介绍 ####

####  ####

<table> 
 <thead> 
  <tr> 
   <th><strong>表分类</strong></th> 
   <th><strong>表名</strong></th> 
   <th><strong>解释</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>一般数据</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_GE_BYTEARRAY]</td> 
   <td>通用的流程定义和流程资源</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_GE_PROPERTY]</td> 
   <td>系统相关属性</td> 
  </tr> 
  <tr> 
   <td>流程历史记录</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_HI_ACTINST]</td> 
   <td>历史的流程实例</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_HI_ATTACHMENT]</td> 
   <td>历史的流程附件</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_HI_COMMENT]</td> 
   <td>历史的说明性信息</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_HI_DETAIL]</td> 
   <td>历史的流程运行中的细节信息</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_HI_IDENTITYLINK]</td> 
   <td>历史的流程运行过程中用户关系</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_HI_PROCINST]</td> 
   <td>历史的流程实例</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_HI_TASKINST]</td> 
   <td>历史的任务实例</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_HI_VARINST]</td> 
   <td>历史的流程运行中的变量信息</td> 
  </tr> 
  <tr> 
   <td>流程定义表</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_RE_DEPLOYMENT]</td> 
   <td>部署单元信息</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_RE_MODEL]</td> 
   <td>模型信息</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_RE_PROCDEF]</td> 
   <td>已部署的流程定义</td> 
  </tr> 
  <tr> 
   <td>运行实例表</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_RU_EVENT_SUBSCR]</td> 
   <td>运行时事件</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_RU_EXECUTION]</td> 
   <td>运行时流程执行实例</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_RU_IDENTITYLINK]</td> 
   <td>运行时用户关系信息，存储任务节点与参与者的相关信息</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_RU_JOB]</td> 
   <td>运行时作业</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_RU_TASK]</td> 
   <td>运行时任务</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>[ACT_RU_VARIABLE]</td> 
   <td>运行时变量表</td> 
  </tr> 
 </tbody> 
</table>

### 5、Hello World ###

#### 5.1、流程定义文件 ####

![在这里插入图片描述][68e0a7bf05df4f688259b749a4417e92.png]

helloworld.bpmn20.xml

#### 5.2、单元测试 ####

public class HelloWorldProcessTest {
        
    
        @Test
        public void testProcess() {
        
            //创建流程引擎
            ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
            //部署流程定义文件
            RepositoryService repositoryService = processEngine.getRepositoryService();
            repositoryService.createDeployment().addClasspathResource("helloworld.bpmn20.xml").deploy();
            //验证已部署流程定义
            ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery().singleResult();
            Assert.assertEquals("helloworld", processDefinition.getKey());
            //启动流程并返回流程实例
            RuntimeService runtimeService = processEngine.getRuntimeService();
            ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("helloworld");
            Assert.assertNotNull(processInstance);
            System.out.println("pid=" + processInstance.getId() + ",pdid=" + processInstance.getProcessDefinitionId());
        }
    }

pid=4,pdid=helloworld:1:3

#### 5.3、添加业务节点 ####

前面运行了最简单的例子来说明流程执行过程（严格来说不是一个流程，因为根本没有做任何事情)，下面为这个例子添加一点实际业务使其可以正常工作起来。既然是请假流程就应该知道是哪个员工请了几天假（先处理不复杂的业务信息）。

首先需要为流程添加一个用户任务（userTask)来处理申请，根据申请内容决定运行申请还是驳回申请。下面先用如图所示的流程图来表示需求。

![在这里插入图片描述][aee48c92c5264333b3d976af34631f48.png]

<?xml version="1.0" encoding="UTF-8"?>
    <definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:activiti="http://activiti.org/bpmn"
                 xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI"
                 xmlns:omgdc="http://www.omg.org/spec/DD/20100524/DC" xmlns:omgdi="http://www.omg.org/spec/DD/20100524/DI"
                 typeLanguage="http://www.w3.org/2001/XMLSchema" expressionLanguage="http://www.w3.org/1999/XPath"
                 targetNamespace="http://www.activiti.org/processdef">
    
        
        <process id="helloworld2" name="helloworld2" isExecutable="true">
            
            <startEvent id="startevent1" name="Start"></startEvent>
            
            <userTask id="usertask1" name="领导审批">
                <potentialOwner>
                    <resourceAssignmentExpression>
                        <formalExpression>deptLeader</formalExpression>
                    </resourceAssignmentExpression>
                </potentialOwner>
            </userTask>
            
            <endEvent id="endevent1" name="End"></endEvent>
            
            <sequenceFlow sourceRef="startevent1" targetRef="usertask1"
                          id="flow1" name=""></sequenceFlow>
            <sequenceFlow sourceRef="outputAuditResult" targetRef="endevent1"
                          id="flow2" name=""></sequenceFlow>
            
            <scriptTask id="outputAuditResult" name="输出审批结果"
                        scriptFormat="groovy">
                <script>
                    <![CDATA[out:println "applyUser:" + applyUser + ",days:" + days + ",approval:" + approved;]]>
                </script>
            </scriptTask>
            <sequenceFlow sourceRef="usertask1" targetRef="outputAuditResult"
                          id="flow3" name=""></sequenceFlow>
        </process>
        <bpmndi:BPMNDiagram id="BPMNDiagram_helloworld2">
            <bpmndi:BPMNPlane bpmnElement="helloworld2" id="BPMNPlane_helloworld2">
            </bpmndi:BPMNPlane>
        </bpmndi:BPMNDiagram>
    </definitions>

@Test
    public void testUserTaskProcess() {
        
        //创建流程引擎
        ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();
        //部署流程定义文件
        RepositoryService repositoryService = processEngine.getRepositoryService();
        repositoryService.createDeployment().addClasspathResource("helloworld.bpmn20.xml").deploy();
        //验证已部署流程定义
        ProcessDefinition processDefinition = repositoryService.createProcessDefinitionQuery().singleResult();
        Assert.assertEquals("helloworld2", processDefinition.getKey());
        //使用参数启动流程，参数会存入数据库
        RuntimeService runtimeService = processEngine.getRuntimeService();
        Map<String, Object> variables = new HashMap<String, Object>();
        //applyUser表示申请人的名称，days表示请假的天数
        variables.put("applyUser", "employee1");
        variables.put("days", 3);
        ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("helloworld2", variables);
        Assert.assertNotNull(processInstance);
        System.out.println("pid=" + processInstance.getId() + ",pdid=" + processInstance.getProcessDefinitionId());
        //查询组(Group)deptLeader的未签收任务并验证任务名称
        TaskService taskService = processEngine.getTaskService();
        Task taskOfDeptLeader = taskService.createTaskQuery().taskCandidateGroup("deptLeader").singleResult();
        Assert.assertNotNull(taskOfDeptLeader);
        Assert.assertEquals("领导审批", taskOfDeptLeader.getName());
        //通过taskService调用claim方法【签收】此任务归用户leaderUser所有
        taskService.claim(taskOfDeptLeader.getId(), "leaderUser");
        //处理的结果，approval为true表示审批通过
        variables = new HashMap<String, Object>();
        variables.put("approved", true);
        //完成任务，同时以流程变量的形式设置审批结果
        taskService.complete(taskOfDeptLeader.getId(), variables);
        //再次查询组deptLeader的未签收任务，因为任务已经办理完成，所以此时任务已经为空
        taskOfDeptLeader = taskService.createTaskQuery().taskCandidateGroup("deptLeader").singleResult();
        Assert.assertNull(taskOfDeptLeader);
        //获取历史记录查询接口
        HistoryService historyService = processEngine.getHistoryService();
        //统计已经完成的流程实例数量，接着验证预期的结果
        long count = historyService.createHistoricProcessInstanceQuery().finished().count();
        Assert.assertEquals(1, count);
    }

pid=4,pdid=helloworld2:1:3
    applyUser:employee1,days:3,approval:true

[816796e7e0c548b79d3c62640adebcb6.png]: https://img-blog.csdnimg.cn/816796e7e0c548b79d3c62640adebcb6.png
[68e0a7bf05df4f688259b749a4417e92.png]: https://img-blog.csdnimg.cn/68e0a7bf05df4f688259b749a4417e92.png
[aee48c92c5264333b3d976af34631f48.png]: https://img-blog.csdnimg.cn/aee48c92c5264333b3d976af34631f48.png