如何在NestJS+BullMQ中使用常量管理队列名称？

我正在使用BullMQ和NestJS开发应用，目前功能运行正常，但有一个问题困扰着我：

注册新队列时，我会在Module中进行如下配置：

@Module({
  imports: [             
    BullModule.registerQueueAsync({
      name: 'email-queue',
    }),
  ],
  controllers: [EmailController],
  providers: [ ],
})

在NestJS服务中使用队列时，代码如下：

@Injectable()
export class WhatsappQueueService {
  constructor(
    @InjectQueue('email-queue') private queue: Queue,
  ) {}

  async addMessage(dtoSendMessage: any) {
    const included = await this.queue.add(
      'send-message',
      dtoSendMessage,
    );
    return included;
  }
}

我希望创建一个存储'email-queue'的常量，从服务中导出后在Module定义中使用，避免手动维护队列名称。但使用常量时，NestJS提示找不到队列，我怀疑这与@InjectQueue()装饰器有关。请问如何使用常量来命名队列？

你可以通过创建统一的常量并确保注册和注入环节引用同一个常量值，来解决这个问题，具体步骤如下：

1. 定义并导出队列名称常量
   创建一个独立的常量文件（比如queue-names.constants.ts），专门存放队列名称：

   // queue-names.constants.ts
   export const EMAIL_QUEUE_NAME = 'email-queue';
   

2. 在Module配置中使用常量
   在注册队列的Module里导入该常量，替换硬编码的字符串：

   import { EMAIL_QUEUE_NAME } from './queue-names.constants';
   
   @Module({
     imports: [             
       BullModule.registerQueueAsync({
         name: EMAIL_QUEUE_NAME,
       }),
     ],
     controllers: [EmailController],
     providers: [ ],
   })
   export class EmailModule {}
   

3. 在Service的@InjectQueue装饰器中使用常量
   在注入队列的Service里同样导入该常量，传入@InjectQueue装饰器：

   import { InjectQueue } from '@nestjs/bull';
   import { Queue } from 'bullmq';
   import { EMAIL_QUEUE_NAME } from './queue-names.constants';
   
   @Injectable()
   export class WhatsappQueueService {
     constructor(
       @InjectQueue(EMAIL_QUEUE_NAME) private queue: Queue,
     ) {}
   
     async addMessage(dtoSendMessage: any) {
       const included = await this.queue.add(
         'send-message',
         dtoSendMessage,
       );
       return included;
     }
   }
   

关键注意点 #

• 确保常量的导出和导入路径完全正确，避免因路径错误导致常量值不匹配（比如大小写、拼写错误）。
• NestJS的@InjectQueue装饰器接受字符串或Symbol类型的队列名称，只要注册和注入时使用的是同一个值，就能正常识别队列。
• 如果不想单独创建常量文件，也可以在队列服务文件顶部定义并导出常量，再让Module从服务文件导入该常量。

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