Nest无法解析ChildService依赖问题 求排查解决

问题场景 #

ChildModule位于libs/childmodule/src/child.module.ts，已通过tsconfig.json映射为@app/child。在ParentModule中导入ChildModule后，未使用ChildService却出现依赖解析错误，提示SecretsService无法在ChildModule上下文找到。

ChildModule代码 #

import { Module } from '@nestjs/common';
import { ChildService } from './child.service';
import { LoggerModule } from '@app/logger';
import { CommonModule } from '@app/common';
import { SecretsModule } from '@app/secrets';

@Module({
  providers: [ChildService],
  exports: [ChildService],
  imports: [
    LoggerModule,
    CommonModule,
    SecretsModule,
  ],
})
export class ChildModule {}

ParentModule代码 #

import { ChildModule } from '@app/child';

@Module({
  imports: [SomeModule, LoggerModule, ChildModule],
  controllers: [ParentController],
  providers: [ParentService],
  exports: [ParentService],
})
export class ParentModule {}

错误信息 #

Error: Nest can't resolve dependencies of the ChildService (LoggerService, CommonService, ?). Please make sure that the argument SecretsService at index [2] is available in the ChildModule context.

Potential solutions:
- If SecretsService is a provider, is it part of the current ChildModule?
- If SecretsService is exported from a separate @Module, is that module imported within ChildModule?
  @Module({
    imports: [ /* the Module containing SecretsService */ ]
  })

SecretsModule代码 #

import { Global, Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { SecretsService } from './secrets.service';
import { Module1Module, Module1Service } from '@app/module1';

@Global()
@Module({})
export class SecretsModule {
  static forRoot(some_key) {
    return {
      module: SecretsModule,
      imports: [Module1Module, ConfigModule],
      providers: [
        {
          provide: SecretsService,
          useFactory: async (
            configService: ConfigService,
            service1: Module1Service,
          ) => {
            const secretsService = new SecretsService(
              configService,
              service1,
              some_key,
            );
            await secretsService.init();
            return secretsService;
          },
          inject: [ConfigService, Module1Service],
        },
      ],
      exports: [SecretsService],
    };
  }
}

问题原因 #

SecretsModule采用静态forRoot方法配置模块，但ChildModule直接导入了SecretsModule类，而非调用forRoot()的返回结果：

• SecretsModule的@Module装饰器内是空配置，所有providers、imports、exports都定义在forRoot方法返回的对象中
• 直接导入SecretsModule类相当于导入了一个空模块，SecretsService并未被注册到模块上下文，导致ChildService依赖的SecretsService无法被解析

解决方法 #

方法1：在ChildModule中调用SecretsModule.forRoot() #

修改ChildModule的imports数组，调用SecretsModule的forRoot方法并传入所需参数：

// ChildModule.ts
import { Module } from '@nestjs/common';
import { ChildService } from './child.service';
import { LoggerModule } from '@app/logger';
import { CommonModule } from '@app/common';
import { SecretsModule } from '@app/secrets';

@Module({
  providers: [ChildService],
  exports: [ChildService],
  imports: [
    LoggerModule,
    CommonModule,
    SecretsModule.forRoot('your_specific_key'), // 调用forRoot初始化模块
  ],
})
export class ChildModule {}

方法2：利用全局模块特性在根模块初始化（推荐） #

由于SecretsModule被标记为@Global()，只需在根模块（如AppModule）中调用一次forRoot()，整个应用即可全局使用SecretsService，无需在ChildModule中重复导入：

// AppModule.ts
import { Module } from '@nestjs/common';
import { ParentModule } from './parent/parent.module';
import { SecretsModule } from '@app/secrets';

@Module({
  imports: [
    SecretsModule.forRoot('your_specific_key'), // 根模块初始化全局模块
    ParentModule
  ],
})
export class AppModule {}

此时可移除ChildModule中对SecretsModule的导入，全局模块的SecretsService会自动在整个应用上下文可用。

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