如何在NestJS中通过Bull复用全局RedisCluster连接？

问题场景 #

我已在AppModule中导入全局RedisModule，该模块创建RedisCluster连接并以REDIS_CONNECTION标识对外提供：

import { Module, Global } from '@nestjs/common';
import { Redis } from 'ioredis';

@Global()
@Module({
    providers: [{
        provide: 'REDIS_CONNECTION',
        useFactory: () => {
            return new Redis.Cluster([
                {
                    host: process.env?.REDIS_HOST,
                    port: process.env?.REDIS_PORT
                        ? Number(process.env?.REDIS_PORT)
                        : 6379,
                },
            ], {
                redisOptions: {
                    ...(process.env?.REDIS_PASSWORD && {
                        password: process.env.REDIS_PASSWORD,
                    }),
                    maxRetriesPerRequest: null,
                    enableReadyCheck: false,
                },
            });
        }

    }],
    exports: ['REDIS_CONNECTION'],
})
export class RedisModule { }

现有QueueModule需配置Bull，但不确定如何注入该全局RedisCluster连接：

@Module({
  imports: [
    BullModule.forRootAsync({
       // how to inject connection here?
    }),
  ],
  providers: [QueueProducerService, QueueConsumerService, Logger],
  exports: [QueueProducerService],
})
export class QueueModule {}

解决方案 #

通过BullModule.forRootAsync的inject和useFactory选项，直接复用全局的REDIS_CONNECTION实例，无需重新创建Redis连接。修改后的QueueModule代码如下：

import { Module } from '@nestjs/common';
import { BullModule } from '@nestjs/bull';
import { Redis } from 'ioredis';
// 替换为你的服务实际路径
import { QueueProducerService, QueueConsumerService, Logger } from './services';

@Module({
  imports: [
    BullModule.forRootAsync({
      // 注入全局RedisCluster连接
      inject: ['REDIS_CONNECTION'],
      useFactory: (redisCluster: Redis.Cluster) => ({
        // 指定Bull使用已有的RedisCluster实例
        createClient: () => redisCluster,
        // 可按需添加其他Bull配置项
        prefix: 'app-queues',
      }),
    }),
  ],
  providers: [QueueProducerService, QueueConsumerService, Logger],
  exports: [QueueProducerService],
})
export class QueueModule {}

注意事项 #

• 确保@nestjs/bull与bull依赖版本兼容
• RedisCluster的连接配置（如密码、重试策略）已在RedisModule中处理，无需重复配置
• 若需注册多个队列，可后续通过BullModule.registerQueue扩展

内容的提问来源于stack exchange，提问作者code_optimizer