Nest.js如何基于ConfigService在模块装饰器中配置可注入服务

问题背景 #

在Nest.js模块开发中，需要根据配置值动态选择PublisherService的实现类：

• 直接读取process.env给useClass赋值的写法可以正常运行
• 尝试在@Module装饰器配置中直接调用ConfigService获取配置的写法无法生效，原因是装饰器执行阶段DI容器尚未完成初始化，无法获取ConfigService实例
• 改用useFactory直接new实例的写法存在缺陷：KafkaPublisherService、NatsPublisherService自身有依赖项，手动实例化无法自动解析依赖

核心结论 #

• 永远不要在@Module装饰器的元数据配置阶段尝试获取容器托管的实例（包括ConfigService），该阶段执行时机早于DI容器初始化，不可能拿到托管实例
• 所有依赖容器实例的动态Provider逻辑，必须通过useFactory工厂模式实现，工厂函数执行时容器已完成初始化，可以正常注入依赖

具体实现 #

方案一：直接注入所有可选实现类（简单场景推荐） #

把两个实现类都注册为Provider，直接注入到工厂函数中，根据配置返回对应实例即可，Nest会自动完成所有类的依赖解析：

@Module({
  imports: [ConfigModule], // 必须导入ConfigModule，保证ConfigService可注入
  providers: [
    KafkaPublisherService,
    NatsPublisherService,
    {
      provide: PublisherService,
      useFactory: (
        config: ConfigService,
        kafkaPublisher: KafkaPublisherService,
        natsPublisher: NatsPublisherService
      ) => {
        const useKafka = config.get<string>('PUBLISHER_TYPE').toUpperCase() === 'KAFKA';
        return useKafka ? kafkaPublisher : natsPublisher;
      },
      inject: [ConfigService, KafkaPublisherService, NatsPublisherService],
    },
  ],
  exports: [PublisherService]
})
export class SomeModule {}

该方案的缺点是两个实现类都会在应用启动时被实例化，如果实现类初始化开销大、存在不必要的资源占用，不适合用这个方案。 #

方案二：注入ModuleRef按需解析实例（复杂场景推荐） #

通过注入ModuleRef（Nest容器引用），动态从容器中获取需要的实现类实例，未被选中的实现类不会被实例化：

import { ModuleRef } from '@nestjs/core';
@Module({
  imports: [ConfigModule],
  providers: [
    KafkaPublisherService,
    NatsPublisherService,
    {
      provide: PublisherService,
      useFactory: async (config: ConfigService, moduleRef: ModuleRef) => {
        const publisherType = config.get<string>('PUBLISHER_TYPE').toUpperCase();
        const targetImpl = publisherType === 'KAFKA' ? KafkaPublisherService : NatsPublisherService;
        // 使用resolve按需实例化，strict:false允许跨模块查找依赖
        return moduleRef.resolve(targetImpl, undefined, { strict: false });
      },
      inject: [ConfigService, ModuleRef],
    },
  ],
  exports: [PublisherService]
})
export class SomeModule {}

注意：moduleRef.get会从已实例化的容器缓存中取实例，moduleRef.resolve会创建新的实例（支持请求范围的Provider），按需选择即可。

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