文章目录
- 一、项目场景
- 二、问题描述
- 三、解决方案
- 方案一:官方实例化共享定义的方法
- 1. 部署共享定义
- 2. 在查询中包含共享的定义
- 3. 实例化共享定义
- 方案二:自定义TenantIdProvider方法,将租户id作为变量添加到启动的实例中
- 1. 采用自定义的TenantProvider,启动引擎实例
- 2. 自定义TenantIdProvider
- 3. 创建流程实例
- 方案三:(推荐)改造 Camunda cache 源码以修改Camunda查询流程定义逻辑
- 1. 租户 ID 支持,创建实例时引入租户概念
- 2. 修改Camunda查询流程定义逻辑
- 原代码分析
- 修改后的代码分析
- 实现效果
- 四、方案结果
一、项目场景
需求:
- 在 Camunda 中实现共享流程定义,不区分租户概念。每台服务器在创建流程实例时引入租户概念,以实现租户间的隔离。
- 具体要求是:共享的流程定义可在多个服务器上使用,但每台服务器只能执行各自创建的流程实例,从而确保实例的隔离性和安全性。
二、问题描述
- 目的:希望在 Camunda 中共享流程定义,但不共享流程实例。
- 问题:在创建流程定义时,若租户 ID 为空,则在创建流程实例并指定租户 ID 时,系统提示找不到对应租户 ID 的流程定义,导致流程实例无法创建。这一问题妨碍了租户隔离的实现。
三、解决方案
方案一:官方实例化共享定义的方法
http://camunda-cn.shaochenfeng.com/user-guide/process-engine/multi-tenancy/
有许多情况下,所有租户应该共享相同的定义。在这种情况下,最好是只部署一次定义,使其对所有租户可见。 然后,当某一租户创建一个新的实例时,它应该只对该租户(当然还有管理员)可见。 这可以通过一种我们称之为 “共享定义” 的使用模式来实现。 我们所说的 使用模式 是指它不是Camunda本身的一个功能,而是使用它来实现所需行为的特定方式。
1. 部署共享定义
部署一个共享定义只是一个 “常规” 的部署,而不用给部署分配一个租户身份。
repositoryService.createDeployment().addClasspathResource("processes/default/mainProcess.bpmn").addClasspathResource("processes/default/subProcess.bpmn").deploy();
2. 在查询中包含共享的定义
在一个应用程序中,我们经常希望向用户提供一个 “可用” 的流程定义的列表。 在一个共享资源的多租户环境中,我们希望这个列表包括具有以下属性的定义。
- 租户ID是当前用户的租户ID。
- 租户id为null = 流程是一个共享资源。
为了通过查询实现这一点,查询需要对用户的租户ID列表进行限制(通过调用tenantIdIn(…)),并包括没有租户ID的定义(includeProcessDefinitionsWithoutTenantId())。或者,反过来看:排除所有租户ID与当前用户的租户ID不同的定义。
实例:
repositoryService.createProcessDefinitionQuery().tenantIdIn("someTenantId").includeProcessDefinitionsWithoutTenantId().list();
3. 实例化共享定义
当创建(启动)一个新的流程实例时,流程定义的租户ID被传播到流程实例中。 共享资源没有租户ID,这意味着没有租户ID被自动传播。为了将启动流程实例的用户的租户ID分配给流程实例,需要提供TenantIdProvider SPI的实现。
当一个流程定义、案例定义或决策定义的实例被创建时,TenantIdProvider 会收到一个回调。然后它可以为新创建的实例分配一个租户ID(或者不分配)。
下面的例子显示了如何根据当前的认证给一个实例分配租户ID:
public class CustomTenantIdProvider implements TenantIdProvider {@Overridepublic String provideTenantIdForProcessInstance(TenantIdProviderProcessInstanceContext ctx) {return getTenantIdOfCurrentAuthentication();}@Overridepublic String provideTenantIdForCaseInstance(TenantIdProviderCaseInstanceContext ctx) {return getTenantIdOfCurrentAuthentication();}@Overridepublic String provideTenantIdForHistoricDecisionInstance(TenantIdProviderHistoricDecisionInstanceContext ctx) {return getTenantIdOfCurrentAuthentication();}protected String getTenantIdOfCurrentAuthentication() {IdentityService identityService = Context.getProcessEngineConfiguration().getIdentityService();Authentication currentAuthentication = identityService.getCurrentAuthentication();if (currentAuthentication != null) {List<String> tenantIds = currentAuthentication.getTenantIds();if (tenantIds.size() == 1) {return tenantIds.get(0);} else if (tenantIds.isEmpty()) {throw new IllegalStateException("no authenticated tenant");} else {throw new IllegalStateException("more than one authenticated tenant");}} else {throw new IllegalStateException("no authentication");}}}
使用 TenantIdProvider,必须在流程引擎配置中设置,例如使用 camunda.cfg.xml:
<beans><bean id="processEngineConfiguration" class="org.camunda.bpm.engine.impl.cfg.StandaloneProcessEngineConfiguration"><!-- ... --><property name="tenantIdProvider" ref="tenantIdProvider" /></bean><bean id="tenantIdProvider" class="org.camunda.bpm.CustomTenantIdProvider">
</beans>
如果是共享的流程引擎,提供者可以通过流程引擎插件来设置。
方案二:自定义TenantIdProvider方法,将租户id作为变量添加到启动的实例中
1. 采用自定义的TenantProvider,启动引擎实例
ProcessEngine engine = new StandaloneProcessEngineConfiguration().setJdbcUrl("jdbc:mysql://xxx.xxx.xxx.xxx/camunda_db?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=UTF-8&useSSL=false").setJdbcDriver("com.mysql.cj.jdbc.Driver") // MySQL JDBC 驱动.setJdbcUsername("xxxxx") // 数据库用户名.setJdbcPassword("xxxxx") // 数据库密码.setDatabaseSchemaUpdate(ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE) // 数据库模式更新策略.setHistory(ProcessEngineConfiguration.HISTORY_FULL) // 历史数据配置.setTenantIdProvider(new CustomTenantIdProvider()) // 设置自定义的 TenantIdProvider....setJobExecutorActivate(true) // 启用作业执行器.buildProcessEngine();
配置并创建一个独立的 Camunda 进程引擎实例,包含了一系列重要的设置:
-
setJdbcUrl:指定数据库连接的 URL,包括数据库类型、地址和其他参数(如字符编码和 SSL 选项)。
-
setJdbcDriver:设置 MySQL JDBC 驱动类。
-
setJdbcUsername 和 setJdbcPassword:提供连接数据库所需的用户名和密码。
-
setDatabaseSchemaUpdate:指定数据库模式更新策略,这里设置为自动更新数据库模式(
DB_SCHEMA_UPDATE_TRUE
)。 -
setHistory:设置历史数据的记录级别,这里选择记录所有历史信息(
HISTORY_FULL
)。 -
setTenantIdProvider:设置自定义的租户 ID 提供者,以便在多租户环境中动态提供租户 ID。
-
setJobExecutorActivate:启用作业执行器,以便处理异步任务和定时任务。
-
buildProcessEngine():根据上述配置构建并返回一个新的
ProcessEngine
实例。
全面配置了 Camunda 引擎,以支持多租户架构和数据库管理,为应用程序的流程管理提供了必要的环境。
2. 自定义TenantIdProvider
在自定义的TenantProvider中,只需像这样获取租户ID变量
public class CustomTenantIdProvider implements TenantIdProvider {@Overridepublic String provideTenantIdForProcessInstance(TenantIdProviderProcessInstanceContext ctx) {String tenantId = (String) ctx.getVariables().get("tenantId");return tenantId;}@Overridepublic String provideTenantIdForCaseInstance(TenantIdProviderCaseInstanceContext ctx) {String tenantId = (String) ctx.getVariables().get("tenantId");return tenantId;}@Overridepublic String provideTenantIdForHistoricDecisionInstance(TenantIdProviderHistoricDecisionInstanceContext ctx) {String tenantId = (String) ctx.getExecution().getVariable("tenantId");return tenantId;}
}
CustomTenantIdProvider
类实现了 TenantIdProvider
接口,用于在 Camunda 中动态提供租户 ID。具体方法的含义如下:
-
provideTenantIdForProcessInstance:根据流程实例上下文(
TenantIdProviderProcessInstanceContext
),从流程变量中获取tenantId
,并返回。这样可以确保在启动流程实例时使用正确的租户 ID。 -
provideTenantIdForCaseInstance:类似于上一个方法,但用于案例实例。它从上下文中获取租户 ID,确保案例实例与相应租户关联。
-
provideTenantIdForHistoricDecisionInstance:此方法用于历史决策实例,通过执行上下文获取租户 ID。这样可以在决策实例的历史记录中保持租户的关联性。
这个类的作用是支持多租户环境下的租户 ID 动态分配,使得每个流程实例、案例实例和决策实例能够正确地与相应的租户关联,从而实现租户间的隔离。
3. 创建流程实例
ProcessInstance processInstance = engine.getRuntimeService().createProcessInstanceByKey(msgVo.getDefinitionKey()).setVariable("tenantId", tenantId).execute();
-
engine.getRuntimeService():获取 Camunda 的运行时服务,允许你与正在运行的流程进行交互。
-
createProcessInstanceByKey(msgVo.getDefinitionKey()):根据传入的流程定义键(msgVo.getDefinitionKey())创建一个新的流程实例。
-
setVariable(“tenantId”, tenantId):设置流程变量 tenantId,用于动态提供租户 ID,确保该实例关联到正确的租户。
-
execute():执行创建实例的操作,启动流程实例
启动一个新流程实例,同时传入租户 ID,以支持多租户环境
方案三:(推荐)改造 Camunda cache 源码以修改Camunda查询流程定义逻辑
1. 租户 ID 支持,创建实例时引入租户概念
ProcessInstance processInstance = engine.getRuntimeService().createProcessInstanceByKey(msgVo.getDefinitionKey()).processDefinitionTenantId(tenantId).execute();
2. 修改Camunda查询流程定义逻辑
修改org.camunda.bpm.engine.impl.persistence.deploy.cache.ResourceDefinitionCache中的findNextJobsToExecute
方法
原代码分析
-
查找流程定义:
findLatestDefinitionByKeyAndTenantId(definitionKey, tenantId)
:根据流程定义的键和租户 ID 查找最新的流程定义。- 这样做的目的是确保在特定租户下使用的流程定义是最新的。
-
检查有效性:
checkInvalidDefinitionByKeyAndTenantId(definitionKey, tenantId, definition)
:检查找到的流程定义是否有效。- 可能会抛出异常或进行其他处理,以确保流程定义存在且符合要求。
-
解析定义:
definition = resolveDefinition(definition)
:将定义解析为实际的流程定义对象,准备后续使用。
修改后的代码分析
public T findDeployedLatestDefinitionByKeyAndTenantId(String definitionKey, String tenantId) {// 源码逻辑修改T definition = getManager().findLatestDefinitionByKeyAndTenantId(definitionKey, null);if(definition != null){definition.setTenantId(tenantId);}checkInvalidDefinitionByKey(definitionKey, definition);definition = resolveDefinition(definition);return definition;}
- 查找共享流程定义:
findLatestDefinitionByKeyAndTenantId(definitionKey, null)
:现在查找时不再指定租户 ID,意味着获取的是共享的流程定义。- 这样可以支持多个租户共享同一流程定义。
- 设置租户 ID:
if (definition != null) { definition.setTenantId(tenantId); }
:如果找到了定义,设置其租户 ID。- 这一步确保尽管定义是共享的,但在执行时能够与特定的租户关联。
- 检查有效性:
checkInvalidDefinitionByKey(definitionKey, definition)
:检查流程定义的有效性,但此时不再检查租户 ID,因为现在定义是共享的。
- 解析定义:
definition = resolveDefinition(definition)
:同样地,解析定义为实际的流程对象。
实现效果
- 共享与隔离:修改后的代码允许多个租户共享同一流程定义,而在使用时能够通过设置租户 ID 进行隔离。这使得流程管理更灵活,同时满足多租户环境的需求。
- 有效性检查:有效性检查仍然保持,但不再涉及租户 ID,这简化了流程定义的管理。
- 动态租户关联:通过设置租户 ID,确保在实际执行流程实例时能够正确地与特定租户关联。
该方法使得在多租户系统中,流程定义可以灵活共享,同时又确保实例的独立性和隔离性。
四、方案结果
(第三种方案测试)
-
流程实例创建成功
-
租户ID指定成功
-
流程实例执行成功