Activiti工作流

Activiti5是由Alfresco软件在2010年5月17日发布的业务流程管理（BPM）框架，它是覆盖了业务流程管理、工作流、服务协作等领域的一个开源的、灵活的、易扩展的可执行流程语言框架。Activiti基于Apache许可的开源BPM平台，创始人Tom Baeyens是JBoss jBPM的项目架构师，它特色是提供了eclipse插件，开发人员可以通过插件直接绘画出业务

流程图。

工作流引擎

ProcessEngine对象，这是Activiti工作的核心。负责生成流程运行时的各种实例及数据、监控和管理流程的运行

BPMN

业务流程建模与标注（Business Process Model and Notation，BPMN) ，描述流程的基本符号，包括这些图元如何组合成一个业务流程图（Business Process Diagram）

数据库

Activiti数据库支持

Activiti的后台是有数据库的支持，所有的表都以ACT_开头。第二部分是表示表的用途的两个字母标识。用途也和服务的API对应。

ACT_RE_*: 'RE'表示repository。这个前缀的表包含了流程定义和流程静态资源（图片，规则，等等）。

ACT_RU_*: 'RU'表示runtime。这些运行时的表，包含流程实例，任务，变量，异步任务，等运行中的数据。 Activiti只在流程实例执行过程中保存这些数据，在流程结束时就会删除这些记录。这样运行时表可以一直很小速度很快。

ACT_ID_*: 'ID'表示identity。这些表包含身份信息，比如用户，组等等。

ACT_HI_*: 'HI'表示history。这些表包含历史数据，比如历史流程实例，变量，任务等等。

ACT_GE_*: 通用数据，用于不同场景下，如存放资源文件。

资源库流程规则表

act_re_deployment 部署信息表
act_re_model 流程设计模型部署表
act_re_procdef 流程定义数据表

运行时数据库表

act_ru_execution 运行时流程执行实例表
act_ru_identitylink 运行时流程人员表，主要存储任务节点与参与者的相关信息
act_ru_task 运行时任务节点表
act_ru_variable 运行时流程变量数据表

历史数据库表

act_hi_actinst 历史节点表
act_hi_attachment 历史附件表
act_hi_comment 历史意见表
act_hi_identitylink 历史流程人员表
act_hi_detail 历史详情表，提供历史变量的查询
act_hi_procinst 历史流程实例表
act_hi_taskinst 历史任务实例表

act_hi_varinst 历史变量表

组织机构表

act_id_group 用户组信息表
act_id_info 用户扩展信息表
act_id_membership 用户与用户组对应信息表
act_id_user 用户信息表

这四张表很常见，基本的组织机构管理，关于用户认证方面建议还是自己开发一套，组件自带的功能太简单，使用中有很多需求难以满足

通用数据表

act_ge_bytearray 二进制数据表

act_ge_property 属性数据表存储整个流程引擎级别的数据,初始化表结构时，会默认插入三条记录，

activiti.cfg.xml（activiti的配置文件）

Activiti核心配置文件，配置流程引擎创建工具的基本参数和数据库连接池参数。

定义数据库配置参数：

jdbcUrl: 数据库的JDBC URL。
jdbcDriver: 对应不同数据库类型的驱动。
jdbcUsername: 连接数据库的用户名。
jdbcPassword: 连接数据库的密码。

基于JDBC参数配置的数据库连接会使用默认的MyBatis连接池。下面的参数可以用来配置连接池（来自MyBatis参数）：

jdbcMaxActiveConnections: 连接池中处于被使用状态的连接的最大值。默认为10。
jdbcMaxIdleConnections: 连接池中处于空闲状态的连接的最大值。
jdbcMaxCheckoutTime: 连接被取出使用的最长时间，超过时间会被强制回收。默认为20000（20秒）。
jdbcMaxWaitTime: 这是一个底层配置，让连接池可以在长时间无法获得连接时，打印一条日志，并重新尝试获取一个连接。（避免因为错误配置导致沉默的操作失败）。默认为20000（20秒）。

示例数据库配置：

也可以使用javax.sql.DataSource。（比如，Apache Commons的DBCP）：

自己项目中的配置

<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns="http://www.springframework.org/schema/beans"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
						http://www.springframework.org/schema/beans/spring-beans.xsd">

    <!-- 配置一个流程引擎配置对象 -->
    <bean id="processEngineConfiguration"
          class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">
        <property name="jdbcDriver" value="com.mysql.jdbc.Driver"></property>
        <property name="jdbcUrl" value="jdbc:mysql://218.199.33.58:3306/webapp?characterEncoding=UTF-8"></property>
        <property name="jdbcUsername" value="huangruiwu"></property>
        <property name="jdbcPassword" value="huangruiwu"></property>
        <property name="databaseSchemaUpdate" value="true"></property>
    </bean>

    <!-- 配置一个流程引擎工厂bean，用于创建流程引擎对象 -->
    <bean id="processEngine" class="org.activiti.spring.ProcessEngineFactoryBean">
        <property name="processEngineConfiguration" ref="processEngineConfiguration"></property>
    </bean>
</beans>

logging.properties（日志处理）

日志的配置文件，Activiti操作数据库的时候，整合的日志文件

核心配置文件activiti-context.xml ：

在Actiiti5中定制流程必定会操作到数据库，如果都像上面那样写一大段代码会非常麻烦，所以我们可以把数据库连接配置写入配置文件。

在Activiti5的官方示例中并没有现成的配置文件，所以先得找到activiti-rest\WEB-INF\classes下有：

一个类似spring结构的配置文件，清空内容后改名为activiti.cfg.xml，用来做流程引擎的相关配置。

按照上面代码配置ProcessEngineConfiguration对象，主要定义数据库的连接配置和建表策略，配置文件代码如下：

Java代码如下：

createProcessEngineConfigurationFromResource的参数值为我们添加的配置文件activiti.cfg.xml的名称，执行java代码，流程引擎对象创建成功运行后数据库会自动建表。

3 核心API

1 ProcessEngine

说明：

在Activiti中最核心的类，其他的类都是由他而来。
产生方式：

在前面看到了两种创建ProcessEngine（流程引擎）的方式，而这里要简化很多，调用ProcessEngines的getDefaultProceeEngine方法时会自动加载classpath下名为activiti.cfg.xml文件。

3 可以产生RepositoryService

4 可以产生RuntimeService

5 可以产生TaskService

各个Service的作用：

RepositoryService	管理流程定义
RuntimeService	执行管理，包括启动、推进、删除流程实例等操作
TaskService	任务管理
HistoryService	历史管理(执行完的数据的管理)
IdentityService	组织机构管理
FormService	一个可选服务，任务表单管理
ManagerService

2 RepositoryService

是Activiti的仓库服务类。所谓的仓库指流程定义文档的两个文件：bpmn文件和流程图片。

产生方式、

2 可以产生DeploymentBuilder，用来定义流程部署的相关参数

3 删除流程定义

3 RuntimeService

是activiti的流程执行服务类。可以从这个服务类中获取很多关于流程执行相关的信息。

4 TaskService

是activiti的任务服务类。可以从这个类中获取任务的信息。

5HistoryService

是activiti的查询历史信息的类。在一个流程执行完成后，这个对象为我们提供查询历史信息。

6ProcessDefinition

流程定义类。可以从这里获得资源文件等。

7ProcessInstance

代表流程定义的执行实例。如范冰冰请了一天的假，她就必须发出一个流程实例的申请。一个流程实例包括了所有的运行节点。我们可以利用这个对象来了解当前流程实例的进度等信息。流程实例就表示一个流程从开始到结束的最大的流程分支，即一个流程中流程实例只有一个。

8Execution

Activiti用这个对象去描述流程执行的每一个节点。在没有并发的情况下，Execution就是同ProcessInstance。流程按照流程定义的规则执行一次的过程，就可以表示执行对象Execution。

如图为ProcessInstance的源代码：

从源代码中可以看出ProcessInstance就是Execution。但在现实意义上有所区别：

在单线流程中，如上图的贷款流程，ProcessInstance与Execution是一致的

这个例子有一个特点：wire money(汇钱)和archive(存档)是并发执行的。这个时候，总线路代表ProcessInstance，而分线路中每个活动代表Execution。

总结：

* 一个流程中，执行对象可以存在多个，但是流程实例只能有一个。

* 当流程按照规则只执行一次的时候，那么流程实例就是执行对象。

4 HelloWorld程序

1流程图

2 部署流程定义

这里使用RepositoryService部署流程定义

addClasspathResource表示从类路径下加载资源文件，一次只能加载一个文件

3 启动流程实例

项目中

 // 1 发布流程
        InputStream inputStreamBpmn = this.getClass().getResourceAsStream("/bpmn/breakrule.bpmn");
        InputStream inputStreamPng = this.getClass().getResourceAsStream("/bpmn/breakrule.png");
        processEngine.getRepositoryService()
                .createDeployment()
                .addInputStream("breakrule.bpmn", inputStreamBpmn)
                .addInputStream("breakrule.png", inputStreamPng)
                .deploy();

这里使用RuntimeService启动流程实例

4 查看我的个人任务

这里使用TaskService完成任务的查询

项目中是组查询

public void findCommentByTaskId() {
        List<Comment> list = new ArrayList<Comment>();
        //使用当前的任务ID，查询当前流程对应的历史任务ID
        //使用当前任务ID，获取当前任务对象
        // String userId = "毛哥.8";
        String userId = "宋博文.16";
        List<Task> taskList = processEngine.getTaskService()//
                .createTaskQuery()//
                .taskCandidateUser(userId)//指定组任务查询
                .list();
        String taskId = taskList.get(5).getId();
        log.info("任务id：" + taskId);

        Task task = taskService.createTaskQuery()//
                .taskId(taskId)//使用任务ID查询
                .singleResult();
        //获取流程实例ID
        String processInstanceId = task.getProcessInstanceId();

        list = taskService.getProcessInstanceComments(processInstanceId);
    }

5 完成我的个人任务

这里使用TaskService完成任务的办理

项目中

 @Test
    public void completeTask3() {
        String taskId = "15003";
        processEngine.getTaskService()
                .complete(taskId);
        System.out.println("财务完成任务，流程结束");
    }

5 管理流程定义

1设计流程定义文档

流程图

bpmn文件

BPMN 2.0根节点是definitions节点。这个元素中，可以定义多个流程定义（不过我们建议每个文件只包含一个流程定义，可以简化开发过程中的维护难度）。一个空的流程定义看起来像下面这样。注意，definitions元素最少也要包含xmlns 和 targetNamespace的声明。 targetNamespace可以是任意值，它用来对流程实例进行分类。

说明：流程定义文档有两部分组成：

bpmn文件

流程规则文件。在部署后，每次系统启动时都会被解析，把内容封装成流程定义放入项目缓存中。Activiti框架结合这个xml文件自动管理流程，流程的执行就是按照bpmn文件定义的规则执行的，bpmn文件是给计算机执行用的。

2展示流程图的图片

在系统里需要展示流程的进展图片，图片是给用户看的。

2 部署流程定义（classpath路径加载文件）

项目中

// 1 发布流程
        InputStream inputStreamBpmn = this.getClass().getResourceAsStream("/bpmn/breakrule.bpmn");
        InputStream inputStreamPng = this.getClass().getResourceAsStream("/bpmn/breakrule.png");
        processEngine.getRepositoryService()
                .createDeployment()
                .addInputStream("breakrule.bpmn", inputStreamBpmn)
                .addInputStream("breakrule.png", inputStreamPng)
                .deploy();

说明：

1 先获取流程引擎对象：在创建时会自动加载classpath下的activiti.cfg.xml

2首先获得默认的流程引擎，通过流程引擎获取了一个RepositoryService对象（仓库对象）

3由仓库的服务对象产生一个部署对象配置对象，用来封装部署操作的相关配置。

4这是一个链式编程，在部署配置对象中设置显示名，上传流程定义规则文件

5向数据库表中存放流程定义的规则信息。

6这一步在数据库中将操作三张表：

act_re_deployment（部署对象表）

存放流程定义的显示名和部署时间，每部署一次增加一条记录

2 act_re_procdef（流程定义表）

存放流程定义的属性信息，部署每个新的流程定义都会在这张表中增加一条记录。

注意：当流程定义的key相同的情况下，使用的是版本升级

3act_ge_bytearray（资源文件表）

存储流程定义相关的部署信息。即流程定义文档的存放地。每部署一次就会增加两条记录，一条是关于bpmn规则文件的，一条是图片的（如果部署时只指定了bpmn一个文件，activiti会在部署时解析bpmn文件内容自动生成流程图）。两个文件不是很大，都是以二进制形式存储在数据库中。

3 部署流程定义（zip格式文件）

将

压缩成zip格式的文件，使用zip的输入流用作部署流程定义

4：查看流程定义

查询流程定义的信息

结果：

再部署一次运行结果为：

可以看到流程定义的key值相同的情况下，版本是从1开始逐次升级的

流程定义的Id是【key：版本：生成ID】

说明：

流程定义和部署对象相关的Service都是RepositoryService。
创建流程定义查询对象，可以在ProcessDefinitionQuery上设置查询的相关参数
调用ProcessDefinitionQuery对象的list方法，执行查询，获得符合条件的流程定义列表
由运行结果可以看出：

Key和Name的值为：bpmn文件process节点的id和name的属性值

5 key属性被用来区别不同的流程定义。

6 带有特定key的流程定义第一次部署时，version为1。之后每次部署都会在当前最高版本号上加1

7 Id的值的生成规则为:{processDefinitionKey}:{processDefinitionVersion}:{generated-id}, 这里的generated-id是一个自动生成的唯一的数字

8 重复部署一次，deploymentId的值以一定的形式变化

规则act_ge_property表生成

5 删除流程定义

删除部署到activiti中的流程定义。

说明：

因为删除的是流程定义，而流程定义的部署是属于仓库服务的，所以应该先得到RepositoryService
如果该流程定义下没有正在运行的流程，则可以用普通删除。如果是有关联的信息，用级联删除。项目开发中使用级联删除的情况比较多，删除操作一般只开放给超级管理员使用。

6 获取流程定义文档的资源（查看流程图附件）

查询出流程定义文档。主要查的是图片，用于显示流程用。

说明：

deploymentId为流程部署ID
resourceName为act_ge_bytearray表中NAME_列的值
使用repositoryService的getDeploymentResourceNames方法可以获取指定部署下得所有文件的名称
使用repositoryService的getResourceAsStream方法传入部署ID和资源图片名称可以获取部署下指定名称文件的输入流

5 最后的有关IO流的操作，使用FileUtils工具的copyInputStreamToFile方法完成流程流程到文件的拷贝，将资源文件以流的形式输出到指定文件夹下

7 附加功能：查询最新版本的流程定义

8附加功能：删除流程定义（删除key相同的所有不同版本的流程定义）

9：总结

Deployment 部署对象

1、一次部署的多个文件的信息。对于不需要的流程可以删除和修改。

2、对应的表：

act_re_deployment：部署对象表

act_re_procdef：流程定义表

act_ge_bytearray：资源文件表

act_ge_property：主键生成策略表

ProcessDefinition 流程定义

1、解析.bpmn后得到的流程定义规则的信息，工作流系统就是按照流程定义的规则执行的。

6 流程实例、任务的执行

1 部署流程定义

2 启动流程实例

说明：

操作数据库的act_ru_execution表,如果是用户任务节点，同时也会在act_ru_task添加一条记录

3 查询我的个人任务

说明：

因为是任务查询，所以从processEngine中应该得到TaskService
使用TaskService获取到任务查询对象TaskQuery
为查询对象添加查询过滤条件，使用taskAssignee指定任务的办理者（即查询指定用户的代办任务），同时可以添加分页排序等过滤条件
调用list方法执行查询，返回办理者为指定用户的任务列表
任务ID、名称、办理人、创建时间可以从act_ru_task表中查到。
Execution与ProcessInstance见5.6和5.7章节的介绍。在这种情况下，ProcessInstance相当于Execution
如果assignee属性为部门经理，结果为空。因为现在流程只到了”填写请假申请”阶段，后面的任务还没有执行，即在数据库中没有部门经理可以办理的任务，所以查询不到。
一个Task节点和Execution节点是1对1的情况，在task对象中使用Execution_来表示他们之间的关系
任务ID在数据库表act_ru_task中对应“ID_”列

附加：

在activiti任务中，主要分为两大类查询任务（个人任务和组任务）：

确切指定了办理者的任务，这个任务将成为指定者的私有任务，即个人任务。
无法指定具体的某一个人来办理的任务，可以把任务分配给几个人或者一到多个小组，让这个范围内的用户可以选择性（如有空余时间时）来办理这类任务，即组任务。

先知道个人任务的查询和办理，组任务的操作后面讲

4 办理任务

说明：

是办理任务，所以从ProcessEngine得到的是TaskService。
当执行完这段代码，再以员工的身份去执行查询的时候，会发现这个时候已经没有数据了，因为正在执行的任务中没有数据。
对于执行完的任务，activiti将从act_ru_task表中删除该任务，下一个任务会被插入进来。
以”部门经理”的身份进行查询，可以查到结果。因为流程执行到部门经理审批这个节点了。
再执行办理任务代码，执行完以后以”部门经理”身份进行查询，没有结果。
重复第3和4步直到流程执行完。

5查询流程状态（判断流程正在执行，还是结束）

在流程执行的过程中，创建的流程实例ID在整个过程中都不会变，当流程结束后，流程实例将会在正在执行的执行对象表中（act_ru_execution）被删除

因为是查询流程实例，所以先获取runtimeService
创建流程实例查询对象，设置实例ID过滤参数
由于一个流程实例ID只对应一个实例，使用singleResult执行查询返回一个唯一的结果，如果结果数量大于1，则抛出异常
判断指定ID的实例是否存在，如果结果为空，则代表流程结束，实例在正在执行的执行对象表中已被删除，转换成历史数据。

6 附加功能：查询历史任务

7 附加功能：查询历史流程实例

8 总结

Execution 执行对象

按流程定义的规则执行一次的过程.

对应的表：

act_ru_execution：正在执行的信息

act_hi_procinst：已经执行完的历史流程实例信息

act_hi_actinst：存放历史所有完成的活动

ProcessInstance 流程实例

特指流程从开始到结束的那个最大的执行分支，一个执行的流程中，流程实例只有1个。

注意

（1）如果是单例流程，执行对象ID就是流程实例ID

（2）如果一个流程有分支和聚合，那么执行对象ID和流程实例ID就不相同

（3）一个流程中，流程实例只有1个，执行对象可以存在多个。

Task 任务

执行到某任务环节时生成的任务信息。

对应的表：

act_ru_task：正在执行的任务信息

act_hi_taskinst：已经执行完的历史任务信息

7 流程变量

流程变量在整个工作流中扮演很重要的作用。例如：请假流程中有请假天数、请假原因等一些参数都为流程变量的范围。流程变量的作用域范围是只对应一个流程实例。也就是说各个流程实例的流程变量是不相互影响的。流程实例结束完成以后流程变量还保存在数据库中（存放到流程变量的历史表中）。