首页
/ RuoYi-Vue-Pro项目中Flowable定时任务丢失租户上下文问题解析

RuoYi-Vue-Pro项目中Flowable定时任务丢失租户上下文问题解析

2025-05-05 02:49:28作者:江焘钦

问题背景

在RuoYi-Vue-Pro项目(v2.1.0版本)中,当使用Flowable工作流引擎并添加定时捕获事件时,发现后续用户任务无法正确获取租户信息。具体表现为:在流程定义中添加定时中间捕获事件后,定时触发后的任务执行会抛出"TenantContextHolder不存在租户编号"的异常。

问题现象

开发人员在流程设计中添加了一个10秒后触发的定时事件,流程结构为:开始事件 → 定时中间捕获事件 → 部门领导审批 → HR审批 → 结束事件。当流程实例启动后,10秒定时触发时,系统无法获取租户上下文,导致后续任务处理失败。

根本原因分析

经过深入排查,发现问题根源在于Flowable的异步执行机制:

  1. Flowable的定时任务是通过其内部的异步执行器(AsyncExecutor)来处理的
  2. 当定时事件触发时,任务会被提交到Flowable的异步线程池执行
  3. 线程切换导致原线程中的租户上下文信息(TenantContextHolder)丢失
  4. 由于多租户实现依赖于线程绑定的上下文,异步执行时未正确传递租户信息

解决方案

针对此问题,项目提供了两种解决方案:

方案一:自定义异步执行器

通过继承DefaultAsyncJobExecutor并重写executeAsyncJob方法,在任务执行前手动设置租户上下文:

public class CustomAsyncExecutor extends DefaultAsyncJobExecutor {
    @Override
    protected boolean executeAsyncJob(final JobInfo job, Runnable runnable) {
        if (StringUtil.isNotEmpty(job.getTenantId())) {
            TenantContextHolder.setTenantId(Long.parseLong(job.getTenantId()));
        }
        return super.executeAsyncJob(job, runnable);
    }
}

然后在流程引擎配置中注册这个自定义执行器:

@Bean
public EngineConfigurationConfigurer<SpringProcessEngineConfiguration> bpmProcessEngineConfigurationConfigurer(
        ObjectProvider<FlowableEventListener> listeners,
        BpmActivityBehaviorFactory bpmActivityBehaviorFactory) {
    return configuration -> {
        configuration.setEventListeners(ListUtil.toList(listeners.iterator()));
        configuration.setActivityBehaviorFactory(bpmActivityBehaviorFactory);
        configuration.setAsyncExecutor(new CustomAsyncExecutor());
    };
}

方案二:使用FlowableUtils工具类包装执行

在流程监听器等需要异步执行的代码处,使用FlowableUtils.execute方法包装执行逻辑,确保租户上下文正确传递:

@Override
public void processProcessInstanceCompleted(ProcessInstance instance) {
    FlowableUtils.execute(instance.getTenantId(), () -> {
        // 业务逻辑处理
        Integer status = (Integer) instance.getProcessVariables()
            .get(BpmnVariableConstants.PROCESS_INSTANCE_VARIABLE_STATUS);
        // 其他处理...
    });
}

最佳实践建议

  1. 对于定时任务、异步任务等场景,务必确保租户上下文的正确传递
  2. 优先使用项目提供的工具类(如FlowableUtils)来处理异步执行
  3. 在自定义Flowable组件时,注意检查租户信息的传递
  4. 对于复杂的业务流程,建议在流程变量中显式存储租户ID作为备份

总结

RuoYi-Vue-Pro项目中的多租户实现依赖于线程上下文,而Flowable的异步执行机制会导致上下文丢失。通过自定义异步执行器或使用工具类包装执行逻辑,可以确保租户信息在异步场景下的正确传递。开发人员在设计包含定时事件或异步任务的流程时,应当特别注意这一问题,选择合适的解决方案保证业务流程的正确执行。

登录后查看全文
热门项目推荐
相关项目推荐