Flowable引擎与Spring框架集成指南

袁立春Spencer

于 2025-06-05 09:03:09 发布

阅读量274

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00258/article/details/148440551

Flowable引擎与Spring框架集成指南

flowable-engine A compact and highly efficient workflow and Business Process Management (BPM) platform for developers, system admins and business users. 项目地址: https://gitcode.com/gh_mirrors/fl/flowable-engine

概述

Flowable作为一款强大的开源业务流程管理(BPM)引擎，提供了与Spring框架的深度集成能力。本文将详细介绍如何在Spring环境中配置和使用Flowable CMMN引擎，帮助开发者快速实现业务案例管理。

Spring集成核心组件

CmmnEngineFactoryBean

CmmnEngineFactoryBean是Spring集成的核心类，它允许将CMMN引擎配置为标准的Spring bean。配置示例如下：

<bean id="cmmnEngineConfiguration" class="org.flowable.cmmn.spring.SpringCmmnEngineConfiguration">
    <!-- 配置项 -->
</bean>

<bean id="cmmnEngine" class="org.flowable.cmmn.spring.CmmnEngineFactoryBean">
  <property name="cmmnEngineConfiguration" ref="cmmnEngineConfiguration" />
</bean>

注意这里使用的是SpringCmmnEngineConfiguration类，这是专门为Spring环境提供的配置类。

完整Spring配置示例

下面是一个完整的Spring配置示例，包含数据源、事务管理器和Flowable服务：

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="...">
  
  <!-- 数据源配置 -->
  <bean id="dataSource" class="org.springframework.jdbc.datasource.SimpleDriverDataSource">
    <property name="driverClass" value="org.h2.Driver" />
    <property name="url" value="jdbc:h2:mem:flowable;DB_CLOSE_DELAY=1000" />
    <property name="username" value="sa" />
    <property name="password" value="" />
  </bean>

  <!-- 事务管理器 -->
  <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    <property name="dataSource" ref="dataSource" />
  </bean>

  <!-- Flowable CMMN引擎配置 -->
  <bean id="cmmnEngineConfiguration" class="org.flowable.cmmn.spring.SpringCmmnEngineConfiguration">
    <property name="dataSource" ref="dataSource" />
    <property name="transactionManager" ref="transactionManager" />
    <property name="databaseSchemaUpdate" value="true" />
  </bean>

  <!-- CMMN引擎 -->
  <bean id="cmmnEngine" class="org.flowable.cmmn.spring.CmmnEngineFactoryBean">
    <property name="cmmnEngineConfiguration" ref="cmmnEngineConfiguration" />
  </bean>

  <!-- Flowable服务 -->
  <bean id="cmmnRepositoryService" factory-bean="cmmnEngine" factory-method="getCmmnRepositoryService" />
  <bean id="cmmnRuntimeService" factory-bean="cmmnEngine" factory-method="getCmmnRuntimeService" />
  <bean id="cmmnTaskService" factory-bean="cmmnEngine" factory-method="getCmmnTaskService" />
  <bean id="cmmnHistoryService" factory-bean="cmmnEngine" factory-method="getCmmnHistoryService" />
  <bean id="cmmnManagementService" factory-bean="cmmnEngine" factory-method="getCmmnManagementService" />
</beans>

重要技术细节

数据源处理

当将数据源传递给SpringCmmnEngineConfiguration时，Flowable会在内部使用TransactionAwareDataSourceProxy包装传递的数据源。这确保了从数据源获取的SQL连接与Spring事务能够良好协作。

重要提示：如果自行在Spring配置中声明TransactionAwareDataSourceProxy，请确保不要将其用于已经支持Spring事务的资源（如DataSourceTransactionManager需要未代理的数据源）。

Spring表达式支持

在CMMN流程中使用表达式时，默认情况下可以访问所有Spring bean。可以通过配置限制可访问的bean：

<bean id="cmmnEngineConfiguration" class="org.flowable.cmmn.spring.SpringCmmnEngineConfiguration">
  ...
  <property name="beans">
    <map>
      <entry key="printer" value-ref="printer" />
    </map>
  </property>
</bean>

在CMMN定义中，可以这样使用表达式：

<task id="serviceTask" flowable:type="java" 
      flowable:expression="${printer.printMessage(var1)}" 
      flowable:resultVariableName="customResponse" />

自动资源部署

Spring集成提供了自动部署资源的功能：

<bean id="cmmnEngineConfiguration" class="org.flowable.cmmn.spring.SpringCmmnEngineConfiguration">
  ...
  <property name="deploymentResources"
    value="classpath*:/org/flowable/cmmn/spring/test/autodeployment/autodeploy.*.cmmn" />
</bean>

支持三种部署模式：

default：所有资源分组为单个部署（默认）
single-resource：每个资源单独部署
resource-parent-folder：按父文件夹分组部署

单元测试支持

Flowable提供了与Spring测试框架的集成支持：

JUnit 5测试示例

@ExtendWith(FlowableCmmnSpringExtension.class)
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = TestConfiguration.class)
class MyBusinessCaseTest {

  @Autowired
  private CmmnRepositoryService cmmnRepositoryService;

  @Test
  @CmmnDeployment
  public void simpleCaseTest() {
    // 测试逻辑
  }
}

JUnit 4测试示例

public class MyBusinessCaseTest {

  @Rule
  public FlowableCmmnRule cmmnRule = new FlowableCmmnRule("...");

  @Test
  public void simpleCaseTest() {
    // 测试逻辑
  }
}