如何在NestJs中全局复用同一RedisCluster连接？

我正在使用NestJs框架，已创建Redis Module与Bull Module。希望在RedisModule中定义Redis Cluster连接，并让Bull、Cache Manager等组件复用该连接，请问该如何实现？

原始代码 #

redis.module.ts

import { Module, Global } from '@nestjs/common';
import { Cluster, Redis } from 'ioredis';
import { RedisService } from './redis.service';
import { CacheModule } from '@nestjs/cache-manager';
import * as redisStore from 'cache-manager-ioredis';

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

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

bull.module.ts

import { Logger, Module } from '@nestjs/common';
import { BullModule, BullModuleAsyncOptions } from '@nestjs/bull';
import Redis from 'ioredis';

@Module({
  imports: [
    BullModule.forRootAsync({
      inject: ['REDIS_CLUSTER'],
      useFactory: (client) => ({
         // Code for same connection?
        },
      }),
    }),
  ],
})
export class BullModule { }

1. 调整RedisModule，实现Cluster实例全局共享并整合Cache Manager #

修改RedisModule，将Cache Manager配置为复用已创建的Redis Cluster实例，并确保所有需要复用的资源都被导出：

import { Module, Global } from '@nestjs/common';
import { Cluster, Redis } from 'ioredis';
import { RedisService } from './redis.service';
import { CacheModule } from '@nestjs/cache-manager';
import * as redisStore from 'cache-manager-ioredis';

@Global()
@Module({
  imports: [
    // 异步配置Cache Manager，复用Redis Cluster实例
    CacheModule.forRootAsync({
      inject: ['REDIS_CLUSTER'],
      useFactory: (redisCluster: Cluster) => ({
        store: redisStore,
        redisInstance: redisCluster, // 绑定已有的Cluster实例
        ttl: 300, // 可根据业务需求调整默认缓存过期时间
      }),
    }),
  ],
  providers: [
    {
      provide: 'REDIS_CLUSTER',
      useFactory: async (): Promise<Cluster> => {
        return new Redis.Cluster(
          [
            {
              host: process.env.REDIS_HOST || 'localhost',
              port: process.env.REDIS_PORT ? Number(process.env.REDIS_PORT) : 6379,
            },
          ],
          {
            enableAutoPipelining: true,
            redisOptions: {
              ...(process.env.REDIS_PASSWORD && { password: process.env.REDIS_PASSWORD }),
              maxRetriesPerRequest: null,
              enableReadyCheck: false,
            },
          }
        );
      },
    },
    RedisService,
  ],
  // 导出Cluster实例、自定义服务和CacheModule，供其他模块复用
  exports: ['REDIS_CLUSTER', RedisService, CacheModule],
})
export class RedisModule {}

2. 配置BullModule复用Redis Cluster连接 #

注意：避免自定义模块类名与@nestjs/bull的BullModule重名，这里改为CustomBullModule：

import { Module } from '@nestjs/common';
import { BullModule } from '@nestjs/bull';

@Module({
  imports: [
    BullModule.forRootAsync({
      inject: ['REDIS_CLUSTER'],
      useFactory: (redisCluster) => ({
        redis: redisCluster, // 直接传入已有的Cluster实例，复用连接
        defaultJobOptions: {
          removeOnComplete: true, // 任务完成后自动移除
          removeOnFail: false, // 失败任务保留，可根据需求调整
        },
      }),
    }),
  ],
  exports: [BullModule], // 导出BullModule供业务模块使用
})
export class CustomBullModule {}

3. 其他组件复用Redis Cluster的通用方法 #

任何需要使用Redis Cluster的服务，只需通过@Inject('REDIS_CLUSTER')注入实例即可：

import { Inject, Injectable } from '@nestjs/common';
import { Cluster } from 'ioredis';

@Injectable()
export class SomeBusinessService {
  constructor(@Inject('REDIS_CLUSTER') private readonly redisCluster: Cluster) {}

  async fetchCachedData(key: string) {
    return this.redisCluster.get(key);
  }
}

关键注意事项 #

• 避免重复创建连接：Bull和Cache Manager的配置中，不要重复设置host/port等参数，直接传入已有的Cluster实例即可。
• 全局模块导出：RedisModule标记为@Global()后，其他模块无需显式导入即可注入REDIS_CLUSTER和CacheManager。
• 环境变量校验：确保REDIS_HOST、REDIS_PORT、REDIS_PASSWORD等环境变量已正确配置，避免连接失败。

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