Flowable——配置详解

Flowable配置

1、创建ProcessEngine

Flowable流程引擎通过名为flowable.cfg.xml的XML文件进行配置。获取ProcessEngine，最简单的方式是使用org.flowable.engine.ProcessEngines类：

ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine()

这样会从classpath寻找flowable.cfg.xml，并用这个文件中的配置构造引擎。

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

    <bean id="processEngineConfiguration" class="org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration">
        <property name="dataSource" ref="dataSource"/>
        <property name="databaseSchemaUpdate" value="true" />
    </bean>


    <!-- 这里可以使用 链接池 dbcp-->
    <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/flowable?serverTimezone=UTC" />
        <property name="username" value="root" />
        <property name="password" value="123456" />
        <property name="maxActive" value="3" />
        <property name="maxIdle" value="1" />
    </bean>

</beans>

也可以通过编程方式使用配置文件，来构造ProcessEngineConfiguration对象。

ProcessEngineConfiguration.
  createProcessEngineConfigurationFromResourceDefault();
  createProcessEngineConfigurationFromResource(String resource);
  createProcessEngineConfigurationFromResource(String resource, String beanName);
  createProcessEngineConfigurationFromInputStream(InputStream inputStream);
  createProcessEngineConfigurationFromInputStream(InputStream inputStream, String beanName);

也可以不使用配置文件，使用默认配置:

ProcessEngineConfiguration.createStandaloneProcessEngineConfiguration();
ProcessEngineConfiguration.createStandaloneInMemProcessEngineConfiguration();

所有的ProcessEngineConfiguration.createXXX()方法都返回ProcessEngineConfiguration，并可以继续按需调整。调用buildProcessEngine()后，生成一个ProcessEngine：

ProcessEngine processEngine = ProcessEngineConfiguration.createStandaloneInMemProcessEngineConfiguration()
  .setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_FALSE)
  .setJdbcUrl("jdbc:h2:mem:my-own-db;DB_CLOSE_DELAY=1000")
  .setAsyncExecutorActivate(false)
  .buildProcessEngine();

2、ProcessEngineConfiguration

flowable.cfg.xml文件中必须包含一个id为’processEngineConfiguration’的bean。

这个bean用于构建ProcessEngine。有多个类可以用于定义processEngineConfiguration。这些类用于不同的环境，并各自设置一些默认值。最佳实践是选择最匹配你环境的类，以便减少配置引擎需要的参数。目前可以使用的类为：

• org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration：流程引擎独立运行。Flowable自行处理事务。在默认情况下，数据库检查只在引擎启动时进行（如果Flowable表结构不存在或表结构版本不对，会抛出异常）。
• org.flowable.engine.impl.cfg.StandaloneInMemProcessEngineConfiguration：这是一个便于使用单元测试的类。Flowable自行处理事务。默认使用H2内存数据库。数据库会在引擎启动时创建，并在引擎关闭时删除。使用这个类时，很可能不需要更多的配置（除了使用任务执行器或邮件等功能时）。
• org.flowable.spring.SpringProcessEngineConfiguration：在流程引擎处于Spring环境时使用。查看Spring集成章节了解更多信息。
• org.flowable.engine.impl.cfg.JtaProcessEngineConfiguration：用于引擎独立运行，并使用JTA事务的情况。

3、配置数据库

有两种方式配置Flowable引擎使用的数据库。第一种方式是定义数据库的JDBC参数：

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

通过提供的JDBC参数构造的数据源，使用默认的MyBatis连接池设置。可用下列属性调整这个连接池（来自MyBatis文档）：

• jdbcMaxActiveConnections: 连接池能够容纳的最大活动连接数量。默认值为10.
• jdbcMaxIdleConnections: 连接池能够容纳的最大空闲连接数量。
• jdbcMaxCheckoutTime: 连接从连接池“取出”后，被强制返回前的最大时间间隔，单位为毫秒。默认值为20000（20秒）。
• jdbcMaxWaitTime: 这是一个底层设置，在连接池获取连接的时间异常长时，打印日志并尝试重新获取连接（避免连接池配置错误，导致没有异常提示）。默认值为20000（20秒）。

也可以使用连接池：

<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/flowable" />
  <property name="username" value="flowable" />
  <property name="password" value="flowable" />
  <property name="defaultAutoCommit" value="false" />
</bean>

<bean id="processEngineConfiguration" class="org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration">
  <property name="dataSource" ref="dataSource" />
</bean>

无论使用JDBC还是数据源方式配置，都可以使用下列参数：

• databaseType: 通常不需要专门设置这个参数，因为它可以从数据库连接信息中自动检测得出。只有在自动检测失败时才需要设置。可用值：{h2, mysql, oracle, postgres, mssql, db2}。这个选项会决定创建、删除与查询时使用的脚本。查看“支持的数据库”章节了解我们支持哪些类型的数据库。
• databaseSchemaUpdate: 用于设置流程引擎启动关闭时使用的数据库表结构控制策略。
  • false (默认): 当引擎启动时，检查数据库表结构的版本是否匹配库文件版本。版本不匹配时抛出异常。
  • true: 构建引擎时，检查并在需要时更新表结构。表结构不存在则会创建。
  • create-drop: 引擎创建时创建表结构，并在引擎关闭时删除表结构。

4、配置JNDI数据源

默认情况下，Flowable的数据库配置保存在每个web应用WEB-INF/classes文件夹下的db.properties文件中。有时这样并不合适，因为这需要用户修改Flowable源码中的db.properties文件并重新编译war包，或者在部署后解开war包并修改db.properties文件。

通过使用JNDI（Java Naming and Directory Interface，Java命名和目录接口）获取数据库连接，连接就完全交由Servlet容器管理，并可以在WAR部署之外管理配置。同时也提供了比db.properties中更多的控制连接的参数。

4.1、配置

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

Tomcat的JNDI资源配置在$CATALIN{A}_{B}ASE/conf/[enginename]/[hostname]/[warname].xml(对于FlowableUI通常会是$CATALINA_BASE/conf/Catalina/localhost/flowable-app.xml)。当应用第一次部署时，默认会从Flowable war包中复制context.xml。所以如果存在这个文件则需要替换。例如，如果需要将JNDI资源修改为应用连接MySQL而不是H2，需要如下修改：

<?xml version="1.0" encoding="UTF-8"?>
    <Context antiJARLocking="true" path="/flowable-app">
        <Resource auth="Container"
            name="jdbc/flowableDB"
            type="javax.sql.DataSource"
            description="JDBC DataSource"
            url="jdbc:mysql://localhost:3306/flowable"
            driverClassName="com.mysql.jdbc.Driver"
            username="sa"
            password=""
            defaultAutoCommit="false"
            initialSize="5"
            maxWait="5000"
            maxActive="120"
            maxIdle="5"/>
        </Context>

4.2、JNDI参数

在Flowable UI的配置文件中使用下列参数配置JNDI数据源：

• spring.datasource.jndi-name=: 数据源的JNDI名
• datasource.jndi.resourceRef: 设置是否在J2EE容器中查找。也就是说，如果JNDI名中没有包含"java:comp/env/“前缀，是否需要添加它。默认为"true”。

5、支持的数据库

Flowable数据库类型	示例JDBC URL	备注
h2	jdbc:h2:tcp://localhost/flowable	默认配置的数据库
mysql	jdbc:mysql://localhost:3306/flowable?autoReconnect=true	已使用mysql-connector-java数据库驱动测试
oracle	jdbc:oracle:thin:@localhost:1521:xe
postgres	jdbc:postgresql://localhost:5432/flowable
db2	jdbc:db2://localhost:50000/flowable
mssql	jdbc:sqlserver://localhost:1433;databaseName=flowable (jdbc.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver) OR jdbc:jtds:sqlserver://localhost:1433/flowable (jdbc.driver=net.sourceforge.jtds.jdbc.Driver)	已使用Microsoft JDBC Driver 4.0 (sqljdbc4.jar)与JTDS Driver测试

6、作业执行器(since 6.0.1)

在Flowable V6中唯一可用的作业执行器，是Flowable V5中的异步执行器(async executor)。因为它为Flowable引擎提供了性能更好，对数据库也更友好的执行异步作业的方式。 Flowable V5中的作业执行器(job executor)在V6中不再可用。

此外，如果在Java EE 7下运行，容器还可以使用符合JSR-236标准的ManagedAsyncJobExecutor来管理线程。要启用这个功能，需要在配置中如下加入线程工厂：

<bean id="threadFactory" class="org.springframework.jndi.JndiObjectFactoryBean">
   <property name="jndiName" value="java:jboss/ee/concurrency/factory/default" />
</bean>

<bean id="customJobExecutor" class="org.flowable.engine.impl.jobexecutor.ManagedAsyncJobExecutor">
   <!-- ... -->
   <property name="threadFactory" ref="threadFactory" />
   <!-- ... -->
</bean>

如果没有设置线程工厂，ManagedAsyncJobExecutor实现会退化为默认实现（AsyncJobExecutor）。

7、启用作业执行器

AsyncExecutor是管理线程池的组件，用于触发定时器与其他异步任务。也可以使用其他实现（如使用消息队列，参见用户手册的高级章节）。

默认情况下，AsyncExecutor并未启用，也不会启动。如下配置使异步执行器与Flowable引擎一同启动：

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

8、配置邮件任务

Flowable引擎使用支持SMTP的外部邮件服务器发送邮件。为了发送邮件，引擎需要了解如何连接邮件服务器。可以在flowable.cfg.xml配置文件中设置下面的参数：

参数	必填?	描述
mailServerHost	否	邮件服务器的主机名（如mail.mycorp.com）。默认为localhost
mailServerPort	是，如果不使用默认端口	邮件服务器的SMTP端口。默认值为25
mailServerDefaultFrom	否	若用户没有提供地址，默认使用的邮件发件人地址。默认为flowable@flowable.org
mailServerUsername	若服务器需要	部分邮件服务器发信时需要进行认证。默认为空。
mailServerPassword	若服务器需要	部分邮件服务器发信时需要进行认证。默认为空。
mailServerUseSSL	若服务器需要	部分邮件服务器要求ssl通信。默认设置为false。
mailServerUseTLS	若服务器需要	部分邮件服务器要求TLS通信（例如gmail）。默认设置为false。

9、配置历史

可以使用org.flowable.engine.impl.history.HistoryLevel枚举（或在5.11之前的版本中，ProcessEngineConfiguration中定义的HISTORY常量），以编程方式配置历史级别：

ProcessEngine processEngine = ProcessEngineConfiguration
  .createProcessEngineConfigurationFromResourceDefault()
  .setHistory(HistoryLevel.AUDIT.getKey())
  .buildProcessEngine();

也可以在flowable.cfg.xml或Spring上下文中配置级别：

<bean id="processEngineConfiguration" class="org.flowable.engine.impl.cfg.StandaloneInMemProcessEngineConfiguration">
  <property name="history" value="audit" />
  ...
</bean>

可以配置下列历史级别：

• none（无）：跳过所有历史的存档。这是流程执行性能最高的配置，但是不会保存任何历史信息。
• activity（活动）：存档所有流程实例与活动实例。在流程实例结束时，将顶级流程实例变量的最新值复制为历史变量实例。但不会存档细节。
• audit（审计）：默认级别。将存档所有流程实例及活动实例，并保持变量值与提交的表单参数的同步，以保证所有通过表单进行的用户操作都可追踪、可审计。
• full（完全）：历史存档的最高级别，因此也最慢。这个级别存储所有audit级别存储的信息，加上所有其他细节（主要是流程变量的更新）。

10、配置部署缓存

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

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

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

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

<property name="processDefinitionCache">
  <bean class="org.flowable.MyCache" />
</property>