Activiti V5.21 用户手册中文版：快速入门与配置详解

5星 · 超过95%的资源需积分: 9 195 浏览量更新于2024-07-20 7 收藏 8.34MB PDF 举报

Activiti V5.21 用户手册是一份详尽的指南，专为那些想要了解和使用 Activiti 业务流程管理平台的用户设计。这份文档提供了从入门到高级配置的全面信息，涵盖了版本 5.21.0 的关键特性。 **1. 简介** 文档首先介绍了 Activiti 的协议，包括可能适用的开源许可。接着，用户可以通过指定的下载链接获取 V5.21 的安装包，适合使用 JDK 6 及以上的环境。对于开发工具，推荐使用 Eclipse Indigo 或 Juno。手册还强调了反馈机制，以便用户在遇到问题时及时沟通，并提到了一些实验性功能，可能在后续版本中会成为标准特性。 **2. 开始** **2.1. 一分钟入门** 提供了一个快速启动教程，让新用户对 Activiti 的基本概念有一个直观的认识。这通常包括创建并部署流程定义、启动流程实例等基础操作。 **2.2. 安装与配置** 这部分详细说明了如何安装 Activiti，包括数据库的设置。用户需要配置 ProcessEngine，这是一个核心组件，负责流程管理和执行。指南介绍了如何通过ProcessEngineConfiguration bean 进行配置，以及如何选择和配置数据库，如MySQL、PostgreSQL等，还包括数据库表的创建和升级。 **3. 配置选项** **3.9. 作业执行器与异步执行器** 在 V5.17.0 版本后，文档重点讲解了作业执行器和异步执行器的功能及启用方法，这对于处理后台任务和非阻塞流程至关重要。同时，邮件服务器、历史记录、表达式/脚本中的bean暴露、部署缓存、日志、诊断上下文和事件处理器的配置也得到了深入阐述。 **4. 技术细节** 内部实现类的介绍有助于开发者理解 Activiti 的工作原理，特别是对于那些希望深入探究底层技术的用户来说，这部分内容是不可或缺的。这份 Activiti V5.21 用户手册为用户提供了全面且实用的指导，无论是初次接触 Activiti 还是希望深入了解其最新特性的开发者，都能从中受益匪浅。通过遵循文档中的步骤和配置选项，用户可以有效地在项目中集成和优化 Activiti，提高业务流程管理的效率。

对于ActivitiRESTweb应用，新增activitiwebapprest2/src/main/webapp/METAINF/context.xml文件，包含下列配置：

可选步骤，可以删除ActivitiExplorer与ActivitiRESTweb应用中无用的db.properties文件。

3.4.2.配置Configuration

根据你使用的servlet容器应用不同，配置JNDI数据源的方式也不同。下面的介绍用于Tomcat，对于其他容器应用，请参考对应的文档。

Tomcat的JNDI资源配置在$CATALINA_BASE/conf/[enginename]/[hostname]/[warname].xml(对于ActivitiExplorer通常会是

$CATALINA_BASE/conf/Catalina/localhost/activitiexplorer.xml)。当应用第一次部署时，默认会从Activitiwar包中复制context.xml。所

以如果存在这个文件则需要替换。例如，如果需要将JNDI资源修改为应用连接MySQL而不是H2，按照下列修改文件：

3.5.支持的数据库Supporteddatabases

下面列出Activiti指定的数据库类型（区分大小写！）。

Activiti数据库类型示例JDBCURL 备注

h2 jdbc:h2:tcp://localhost/activiti 默认配置的数据库

mysql jdbc:mysql://localhost:3306/activiti?autoReconnect=true 已使用mysqlconnectorjava数据

库驱动测试

oracle jdbc:oracle:thin:@localhost:1521:xe

postgres jdbc:postgresql://localhost:5432/activiti

db2 jdbc:db2://localhost:50000/activiti

mssql jdbc:sqlserver://localhost:1433;databaseName=activiti

(jdbc.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver)

ORjdbc:jtds:sqlserver://localhost:1433/activiti

(jdbc.driver=net.sourceforge.jtds.jdbc.Driver)

已使用MicrosoftJDBCDriver4.0

(sqljdbc4.jar)与JTDSDriver测试

defaultAutoCommit="false"

initialSize="5"

maxWait="5000"

maxActive="120"

maxIdle="5"/>

</Context>

1

2

3

4

5

6

7

8

9

<?xmlversion="1.0"encoding="UTF‐8"?>

<ContextantiJARLocking="true"path="/activiti‐rest2">

<Resourceauth="Container"

name="jdbc/activitiDB"

type="javax.sql.DataSource"

scope="Shareable"

description="JDBCDataSource"

url="jdbc:h2:mem:activiti;DB_CLOSE_DELAY=‐1"

driverClassName="org.h2.Driver"

username="sa"

password=""

defaultAutoCommit="false"

initialSize="5"

maxWait="5000"

maxActive="120"

maxIdle="5"/>

</Context>

1

2

3

4

5

6

7

8

9

<?xmlversion="1.0"encoding="UTF‐8"?>

<ContextantiJARLocking="true"path="/activiti‐explorer2">

<Resourceauth="Container"

name="jdbc/activitiDB"

type="javax.sql.DataSource"

description="JDBCDataSource"

url="jdbc:mysql://localhost:3306/activiti"

driverClassName="com.mysql.jdbc.Driver"

username="sa"

password=""

defaultAutoCommit="false"

initialSize="5"

maxWait="5000"

maxActive="120"

maxIdle="5"/>

</Context>

3.6.创建数据库表Creatingthedatabasetables

在你的数据库中创建标的最简单方法是：

在classpath中增加activitienginejar

增加合适的数据库驱动

在classpath中增加Activiti配置文件(activiti.cfg.xml)，指向你的数据库(参考数据库配置)

执行DbSchemaCreate类的main方法

然而，通常只有数据库管理员可以在数据库中执行DDL语句，在生产环境中这也是最明智的选择。DDL的SQL脚本可以在Activiti下载页

面或Activiti发布目录中找到，位于 database 子目录。引擎jar(activitienginex.jar)的org/activiti/db/create包中也有一份(drop目录存放删

除脚本)。SQL文件的格式为：

db为支持的数据库，而type为

engine:引擎执行所需的表，必需。

identity:存储用户、组、用户与组关系的表。这些表是可选的，但在使用引擎自带的默认身份管理时需要使用。

history:存储历史与审计信息的表。当历史级别设置为none时不需要。请注意不使用这些表会导致部分使用历史数据的功能失效

（如任务备注）。

MySQL用户请注意：低于5.6.4的MySQL版本不支持timestamps或包含毫秒精度的日期。更糟的是部分版本会在创建类似的列时抛出

异常，而另一些版本则不会。当使用自动创建/升级时，引擎在执行时会自动修改DDL语句。当使用DDL文件方式建表时，可以使用通

用版本，或使用文件名包含mysql55的特殊版本（用于5.6.4以下的任何版本）。特殊版本的文件中不会使用毫秒精度的列类型。

具体地说，对于MySQL的版本：

<5.6:不支持毫秒精度。可以使用DDL文件（使用包含mysql55的文件）。可以使用自动创建/升级。

5.6.05.6.3:不支持毫秒精度。不可以使用自动创建/升级。建议升级为较新版本的数据库。如果确实需要，可以使用包含mysql55的

DDL文件。

5.6.4+:支持毫秒精度。可以使用DDL文件（默认的包含mysql的文件）。可以使用自动创建/升级。

请注意在Activiti表已经创建/升级后，更新MySQL数据库，则需要手工修改列类型！

3.7.数据库表名说明Databasetablenamesexplained

Activiti的所有数据库表都以ACT_开头。第二部分是说明表用途的两字符标示符。服务API的命名也大略符合这个规则。

ACT_RE_*:'RE’代表 repository 。带有这个前缀的表包含“静态”信息，例如流程定义与流程资源（图片、规则等）。

ACT_RU_*:'RU’代表 runtime 。这些表存储运行时信息，例如流程实例（processinstance）、用户任务（usertask）、变量

（variable）、作业（job）等。Activiti只在流程实例运行中保存运行时数据，并在流程实例结束时删除记录。这样保证运行时表小和

快。

ACT_ID_*:'ID’代表 identity 。这些表包含身份信息，例如用户、组等。

ACT_HI_*:'HI’代表 history 。这些表存储历史数据，例如已完成的流程实例、变量、任务等。

ACT_GE_*:通用数据。用于不同场景下。

3.8.数据库升级Databaseupgrade

在升级前，请确保你已经（使用数据库的备份功能）备份了数据库。

默认情况下，每次流程引擎创建时会进行版本检查，通常是在你的应用或者Activitiweb应用启动的时候。如果Activiti库发现库版本与

Activiti数据库表版本不同，会抛出异常。

要进行升级，首先需要将下列配置参数放入你的activiti.cfg.xml配置文件：

同时，在classpath中加上合适的数据库驱动。升级你应用中的Activiti库，或者启动一个新版本的Activiti，并将它指向旧版本的数据

库。将 databaseSchemaUpdate 设置为 true 。当Activiti发现库与数据库表结构不同步时，会自动将数据库表结构升级至新版本。

activiti.{db}.{create|drop}.{type}.sql

<beans>

<beanid="processEngineConfiguration"class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">

<!‐‐...‐‐>

<propertyname="databaseSchemaUpdate"value="true"/>

<!‐‐...‐‐>

</bean>

</beans>

你还可以直接运行升级DDL语句，也可以从Activiti下载页面获取升级数据库脚本并运行。

3.9.作业执行器与异步执行器（从5.17.0版本起）JobExecutorandAsyncExecutor(since

version5.17.0)

从5.17.0版本开始，在作业执行器之外，Activiti还提供了异步执行器。Activiti引擎可以通过它，以性能更好，也对数据库更友好的方式

执行异步作业。

此外，如果在JavaEE7下运行，容器还可以使用符合JSR236标准的 ManagedJobExecutor 与 ManagedAsyncJobExecutor 来管理线

程。要启用这个功能，需要在配置中如下加入线程工厂：

如果没有设置线程工厂，上述两个managedxx类都会退化为默认实现（非managed版本）。

3.10.启用作业执行器Jobexecutoractivation

JobExecutor 是管理一组线程的组件，这些线程用于触发定时器（包括后续的异步消息）。在单元测试场景下，使用多线程会很笨重。

因此API提供 ManagementService.createJobQuery 用于查询，以及 ManagementService.executeJob 用于执行作业。这样作业的执

行就可以在单元测试内部控制。为了避免作业执行器的干扰，可以将它关闭。

默认情况下， JobExecutor 在流程引擎启动时激活。当你不希望 JobExecutor 随流程引擎启动时，设置：

3.11.启用异步执行器Asyncexecutoractivation

AsyncExecutor 是管理线程池的组件，这个线程池用于触发定时器与异步任务。

默认情况下，由于历史原因，当使用 JobExecutor 时， AsyncExecutor 不生效。然而我们建议使用新的 AsyncExecutor 代替

JobExecutor ，通过定义两个参数实现

asyncExecutorEnabled参数用于启用异步执行器，代替老的作业执行器。第二个参数asyncExecutorActivate命令Activiti引擎在启动时

启动异步执行器线程池。

3.12.配置邮件服务器Mailserverconfiguration

配置邮件服务器是可选的。Activiti支持在业务流程中发送电子邮件。发送电子邮件需要配置有效的SMTP邮件服务器。查看电子邮件任

务了解配置选项。

3.13.配置历史Historyconfiguration

可以选择自定义历史存储的配置。你可以通过调整配置影响历史功能。查看历史配置了解细节。

3.14.配置在表达式与脚本中暴露的beanExposingconfigurationbeansinexpressionsandscripts

默认情况下，所有通过 activiti.cfg.xml 或你自己的Spring配置文件声明的bean，都可以在表达式与脚本中使用。如果你希望限制配

置文件中bean的可见性，可以使用流程引擎配置的 beans 参数。 ProcessEngineConfiguration 中的 beans 参数是一个map。当你配

置这个参数时，只有在这个map中声明的bean可以在表达式与脚本中使用。bean会使用你在map中指定的名字暴露。

3.15.配置部署缓存Deploymentcacheconfiguration

鉴于流程定义信息不会改变，为了避免每次使用流程定义时都读取数据库，所有的流程定义都会（在解析后）被缓存。默认情况下，这

个缓存没有限制。要限制流程定义缓存，加上如下的参数

<beanid="threadFactory"class="org.springframework.jndi.JndiObjectFactoryBean">

<propertyname="jndiName"value="java:jboss/ee/concurrency/factory/default"/>

</bean>

<beanid="customJobExecutor"class="org.activiti.engine.impl.jobexecutor.ManagedJobExecutor">

<!‐‐...‐‐>

<propertyname="threadFactory"ref="threadFactory"/>

<!‐‐...‐‐>

</bean>

1 <propertyname="jobExecutorActivate"value="false"/>

<propertyname="asyncExecutorEnabled"value="true"/>

<propertyname="asyncExecutorActivate"value="true"/>

1 <propertyname="history"value="audit"/>

1 <propertyname="processDefinitionCacheLimit"value="10"/>

设置这个参数，会将默认的hashmap替换为LRU缓存，以进行限制。当然，参数的“最佳”取值，取决于总的流程定义数量，以及实际使

用的流程定义数量。

你也可以注入自己的缓存实现。它必须是一个实现了 org.activiti.engine.impl.persistence.deploy.DeploymentCache 接口的

bean：

配置规则缓存(rulescache)可以使用类似的名为 knowledgeBaseCacheLimit 与 knowledgeBaseCache 的参数。只有在流程中使用规则

任务(rulestask)时才需要设置。

3.16.日志Logging

自Activiti5.12版本起，使用SLF4J作为日志框架，替代了之前使用的java.util.logging。所有日志(activiti,spring,mybatis,…)通过SLF4J

路由，并允许你自行选择日志实现。

默认情况下，Activiti引擎依赖不会提供SFL4J绑定jar。你需要自行将其加入你的项目，以便使用所选的日志框架。如果没有加入实现

jar，SLF4J会使用NOPlogger。这时除了一条警告外，任何日志都不会记录。可以从

http://www.slf4j.org/codes.html#StaticLoggerBinder获取关于绑定的更多信息。

使用Maven可以添加类似这样（这里使用log4j）的依赖，请注意你还需要加上版本：

activitiexplorer与activitirestweb应用配置为使用Log4j绑定。所有的activiti*模块运行测试时也会使用Log4j。

重要提示：当使用classpath中带有commonslogging的容器时：为了将spring的日志路由至SLF4j，需要使用桥接（参

考http://www.slf4j.org/legacy.html#jclOverSLF4J）。如果你的容器提供了commonslogging实现，请按

照http://www.slf4j.org/codes.html#release页面的指示来保证稳定性。

使用Maven的示例（省略了版本）：

3.17.映射诊断上下文MappedDiagnosticContexts

从5.13版本开始，Activiti支持SLF4J的映射诊断上下文特性。与需要日志记录的信息一起，下列基本信息也会传递给底层日志记录器：

processDefinitionId作为mdcProcessDefinitionID

processInstanceId作为mdcProcessInstanceID

executionId作为mdcExecutionId

默认情况下这些信息都不会被日志记录，但可以通过配置日志记录器，以使用想要的格式，与其他日志信息一起显示。例如在log4j中进

行如下简单的布局定义，就可以让日志记录器显示上述信息：

在系统任务很关键的情况下这很有用，可以通过例如日志分析器进行日志的严格检查。

3.18.事件处理器Eventhandlers

Activiti5.15引入了事件机制。它可以让你在引擎中发生多种事件的时候得到通知。查看所有支持的事件类型了解可用的事件。

可以只为特定种类的事件注册监听器，而不是在任何类型的事件发送时都被通知。可以通过配置增加引擎全局的事件监听器，在运行时

通过API增加引擎全局的事件监听器，也可以在BPMNXML文件为个别流程定义增加事件监听器。.

所有被分发的事件都是 org.activiti.engine.delegate.event.ActivitiEvent 的子类。事件（在可用时）提供 type ,

executionId , processInstanceId 与 processDefinitionId 。部分事件含有关于发生事件的上下文信息。关于事件包含的附加信

息，请参阅所有支持的事件类型。

<propertyname="processDefinitionCache">

<beanclass="org.activiti.MyCache"/>

</property>

<groupId>org.slf4j</groupId>

<artifactId>slf4j‐log4j12</artifactId>

</dependency>

<groupId>org.slf4j</groupId>

<artifactId>jcl‐over‐slf4j</artifactId>

</dependency>

1 log4j.appender.consoleAppender.layout.ConversionPattern=ProcessDefinitionId=%X{mdcProcessDefinitionID}

executionId=%X{mdcExecutionId}

mdcProcessInstanceID=%X{mdcProcessInstanceID}

mdcBusinessKey=%X{mdcBusinessKey}%m%n

3.18.1.事件监听器实现Eventlistenerimplementation

对事件监听器的唯一要求，是要实现 org.activiti.engine.delegate.event.ActivitiEventListener 接口。下面是一个监听器实

现的例子，它将接收的所有事件打印至标准输出，并对作业执行相关的事件特别处理。：

isFailOnException() 方法决定了当事件分发后， onEvent(..) 方法抛出异常时的行为。若返回 false ，忽略异常；返回 true ，异

常不会被忽略而会被上抛，使当前执行的命令失败。如果事件是API调用（或其他事务操作，例如作业执行）的一部分，事务将被回

滚。如果事件监听器中并不是重要的业务操作，建议返回 false 。

Activiti提供了少量基础实现，以简化常用的事件监听器用例。它们可以被用作监听器的示例或基类：

org.activiti.engine.delegate.event.BaseEntityEventListener:事件监听器基类，可用来监听实体（entity）相关事件，特定或所有

实体的事件都可以。它隐藏了类型检测，提供了4个需要覆盖的方法： onCreate(..) , onUpdate(..) 与 onDelete(..) 在实体创

建、更新及删除时调用；对所有其他实体相关事件， onEntityEvent(..) 会被调用。

3.18.2.配置与安装Configurationandsetup

在流程引擎中配置的事件监听器会在流程引擎启动时生效，引擎重启后也会保持有效。

eventListeners 参数配置为 org.activiti.engine.delegate.event.ActivitiEventListener 实例的列表(list)。与其他地方一

样，你可以声明内联bean定义，也可以用 ref 指向已有的bean。下面的代码片段在配置中增加了一个事件监听器，无论任何类型的事件

分发时，都会得到通知：

要在特定类型的事件分发时得到通知，使用 typedEventListeners 参数，取值为map。map的key为逗号分隔的事件名字列表（或者一

个事件的名字），取值为 org.activiti.engine.delegate.event.ActivitiEventListener 实例的列表。下面的代码片段在配置中

增加了一个事件监听器，它会在作业执行成功或失败时得到通知：

事件分发的顺序由加入监听器的顺序决定。首先，所有普通( eventListeners 参数定义的)事件监听器按照他们在 list

1

2

3

4

5

6

7

8

9

publicclassMyEventListenerimplementsActivitiEventListener{

@Override

publicvoidonEvent(ActivitiEventevent){

switch(event.getType()){

caseJOB_EXECUTION_SUCCESS:

System.out.println("Ajobwelldone!");

break;

caseJOB_EXECUTION_FAILURE:

System.out.println("Ajobhasfailed...");

break;

default:

System.out.println("Eventreceived:"+event.getType());

}

}

@Override

publicbooleanisFailOnException(){

//onEvent方法中的逻辑并不重要，日志失败异常可以被忽略……

returnfalse;

}

}

<beanid="processEngineConfiguration"class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">

...

<propertyname="eventListeners">

<list>

<beanclass="org.activiti.engine.example.MyEventListener"/>

</list>

</property>

</bean>

1

2

3

4

5

6

7

8

9

<beanid="processEngineConfiguration"class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">

...

<propertyname="typedEventListeners">

<map>

<entrykey="JOB_EXECUTION_SUCCESS,JOB_EXECUTION_FAILURE">

<list>

<beanclass="org.activiti.engine.example.MyJobEventListener"/>

</list>

</entry>

</map>

</property>

</bean>

剩余266页未读，继续阅读

本站的昵称

粉丝: 14
资源: 16

Activiti V5.21 用户手册中文版：快速入门与配置详解

activiti中文api（用户手册）

activiti6的手册pdf版和html版

activiti6.0 中文api

activiti5.21支持达梦

activiti工作流使用手册

activiti6 中文 用户指南 操作手册 开发api

activiti 5.22.0中文手册

activiti5 和activiti6

activiti实战.pdf

activiti中用户表

最新资源

activiti6 中文用户指南操作手册开发api