扩展ConfigurableModuleClass的宿主模块引发依赖注入问题

错误原因 #

报错提示CONFIGURABLE_MODULE_OPTIONS[...]在模块上下文不可用，本质是CloudStorageService依赖的配置选项Token未被正确注册到模块的提供者列表中，或者注入的Token与模块提供的不匹配。

核心修复步骤 #

1. 正确使用ConfigurableModuleBuilder生成配置Token #

避免直接使用默认的CONFIGURABLE_MODULE_OPTIONS，而是通过ConfigurableModuleBuilder生成专属的模块配置Token，确保注入匹配：

// cloud-storage.module.ts
import { Module, DynamicModule } from '@nestjs/common';
import { ConfigurableModuleBuilder } from '@nestjs/common';
import { CloudStorageService } from './cloud-storage.service';

// 定义模块配置接口
export interface CloudStorageModuleOptions {
  bucketName: string;
  // 其他配置字段...
}

// 生成可配置模块类和专属配置Token
const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN } = new ConfigurableModuleBuilder<CloudStorageModuleOptions>()
  .build();

@Module({})
export class CloudStorageModule extends ConfigurableModuleClass {
  static register(options: CloudStorageModuleOptions): DynamicModule {
    return {
      ...super.register(options),
      providers: [
        // 注册配置提供者
        {
          provide: MODULE_OPTIONS_TOKEN,
          useValue: options,
        },
        CloudStorageService,
      ],
      // 导出服务和配置Token（如果其他模块需要注入配置）
      exports: [CloudStorageService, MODULE_OPTIONS_TOKEN],
    };
  }
}

2. 在CloudStorageService中正确注入配置 #

使用上面生成的MODULE_OPTIONS_TOKEN注入配置，确保Token一致：

// cloud-storage.service.ts
import { Injectable, Inject } from '@nestjs/common';
import { MODULE_OPTIONS_TOKEN, CloudStorageModuleOptions } from './cloud-storage.module';

@Injectable()
export class CloudStorageService {
  constructor(
    @Inject(MODULE_OPTIONS_TOKEN)
    private readonly options: CloudStorageModuleOptions,
  ) {}

  // 示例服务方法
  getBucketInfo() {
    return `当前存储桶: ${this.options.bucketName}`;
  }
}

3. 在AppModule中正确注册动态模块 #

// app.module.ts
import { Module } from '@nestjs/common';
import { CloudStorageModule } from './cloud-storage/cloud-storage.module';

@Module({
  imports: [
    CloudStorageModule.register({
      bucketName: 'my-cloud-bucket',
    }),
  ],
})
export class AppModule {}

常见错误排查点 #

• 未通过ConfigurableModuleBuilder生成专属Token，直接使用默认CONFIGURABLE_MODULE_OPTIONS导致Token不匹配。
• 动态模块的register方法中，未将配置提供者添加到providers数组，或未导出所需的服务/Token。
• 服务类中注入的Token与模块中注册的Token不一致。
• 未正确继承ConfigurableModuleClass，或未合并super.register(options)的返回值。

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