NestJS动态模块无需重复配置的实现问题求助

我开发了一个Sms动态模块，功能正常，但在多模块引入时遇到麻烦：每次导入都得添加配置信息。目前模块会创建带相同配置的服务单例，我希望仅在AppModule中配置一次，其他模块直接导入就能用导出的SmsService，而且暂时不想用全局模块配置。

初始代码 #

SmsModule #

@Module({})
export class SmsModule {
  static forRoot(options: Configs & { isGlobal?: boolean }): DynamicModule {
    return {
      module: SmsModule,
      global: options.isGlobal,
      providers: [{ provide: NEST_SMS_CONFIG_OPTIONS, useValue: options }, SmsService],
      exports: [SmsService],
    };
  }
}

SmsService #

@Injectable()
export class SmsService {
  private readonly smsProvider: string;
  private readonly api: ExternalApi;
  constructor(@Optional() @Inject(NEST_SMS_CONFIG_OPTIONS) private readonly options: Configs) {
    if ('apiKey' in this.options) {
      this.smsProvider = 'my-external-api';
      const apiKey = this.options?.apiKey;
      this.api = new ExternalApi({ apiKey });
    } else { throw new Error('Invalid SMS configuration options.') }
  }
}

AppModule配置 #

@Module({
  imports: [ SmsModule.forRoot({ apiKey: "api-key" }) ],
})
export class AppModule {}

AuthModule导入 #

@Module({
  imports: [ SmsModule ],
})
export class AuthModule {}

AuthService注入 #

@Injectable()
export class AuthService {
  constructor(private readonly smsService: SmsService){}
}

报错信息 #

此时运行报错：

Error: Nest can't resolve dependencies of the AuthService (?). Please make sure that the argument SmsService at index [0] is available in the AuthModule context.

尝试修改后的代码及问题 #

我尝试在SmsModule的@Module装饰器中直接添加SmsService：

@Module({
  providers: [SmsService],
  exports: [SmsService],
})
export class SmsModule {
  static forRoot( options: Configs & { isGlobal?: boolean } ): DynamicModule {
    return {
      module: SmsModule,
      global: options.isGlobal,
      providers: [ { provide: NEST_SMS_CONFIG_OPTIONS, useValue: options }, SmsService ],
      exports: [SmsService],
    };
  }
}

但此时SmsService构造函数中的options为undefined；移除@Optional()装饰器后，又报错：

Error: Nest can't resolve dependencies of the SmsService (?). Please make sure that the argument "NEST_SMS_CONFIG_OPTIONS" at index [0] is available in the SmsModule context.

我希望复用AppModule中通过forRoot注入的NEST_SMS_CONFIG_OPTIONS，但没搞懂NestJS ConfigModule的实现逻辑，求解决。

解决方案 #

核心思路是让SmsModule成为共享模块，将SmsService放在基础模块的providers中并导出，而forRoot仅负责提供配置项，利用NestJS同一模块类仅实例化一次的特性，实现配置复用。

修改后的SmsModule #

@Module({
  providers: [SmsService],
  exports: [SmsService],
})
export class SmsModule {
  static forRoot(options: Configs & { isGlobal?: boolean }): DynamicModule {
    return {
      module: SmsModule,
      global: options.isGlobal,
      // 仅提供配置项，无需重复声明SmsService
      providers: [{ provide: NEST_SMS_CONFIG_OPTIONS, useValue: options }],
    };
  }
}

修改后的SmsService #

移除@Optional()装饰器，因为配置会由forRoot确保存在：

@Injectable()
export class SmsService {
  private readonly smsProvider: string;
  private readonly api: ExternalApi;
  constructor(@Inject(NEST_SMS_CONFIG_OPTIONS) private readonly options: Configs) {
    if ('apiKey' in this.options) {
      this.smsProvider = 'my-external-api';
      const apiKey = this.options.apiKey;
      this.api = new ExternalApi({ apiKey });
    } else {
      throw new Error('Invalid SMS configuration options.');
    }
  }
}

为什么这样有效？ #

1. 当AppModule导入SmsModule.forRoot(...)时，NestJS会为SmsModule添加NEST_SMS_CONFIG_OPTIONS这个provider，同时保留基础模块中声明的SmsService。
2. 由于NestJS中同一模块类只会被实例化一次，当AuthModule导入SmsModule时，会复用已经配置好的模块实例，此时SmsService能直接获取到AppModule中注入的配置项。
3. 基础模块导出SmsService，所以AuthModule导入SmsModule后，就能在AuthService中正常注入SmsService。

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