NestJS自定义模块导入时依赖解析失败，请求协助排查解决

问题描述 #

开发一个可部署到Verdaccio仓库的复用NestJS模块，用于多项目Guard中，模块依赖宿主应用的ConfigService，但导入时出现依赖解析错误，错误信息：

Nest 无法解析 OIDCModule 的依赖项 (?)。请确保参数 ConfigModule 在索引 [0] 处可用于 AppModule 上下文。

问题根源分析 #

1. 模块配置冗余：自定义模块中手动导入ConfigModule并声明ConfigService为provider，与宿主应用的全局ConfigModule冲突，导致Nest无法正确识别依赖来源。
2. 注入方式错误：服务中使用@Inject("ConfigService")手动指定令牌，而ConfigService本身有默认注入令牌，无需额外声明。
3. 应用模块配置错误：宿主AppModule中重复导入ConfigModule，并错误地将模块、服务放入providers数组（providers应只放服务类，模块需通过imports导入）。

修复步骤 #

1. 修正自定义模块代码 #

myModule.module.ts

移除冗余的ConfigModule导入和ConfigService声明，宿主已配置全局ConfigModule，模块只需确保能访问全局的ConfigService：

import { Module } from '@nestjs/common';
import { MyService } from './myModule.service';

@Module({
  providers: [MyService],
  exports: [MyService],
})
export class MyModule {}

myModule.service.ts

移除多余的@Inject("ConfigService")，直接注入ConfigService即可：

import { Injectable, Logger } from "@nestjs/common";
import { ConfigService } from "@nestjs/config";

@Injectable()
export class MyService { // 注意：原代码类名是OIDCService，需保持导出名一致或修正引用
    private readonly logger: Logger;

    constructor(private readonly configService: ConfigService) {
        this.logger = new Logger("MyService");
    }

    myMethod() {
        const param = this.configService.get("param");
        // ... 其他逻辑
    }
}

注意：原代码中服务类名为OIDCService但导出的是MyService，需保持类名与导出名一致，避免后续引用错误。

2. 修正宿主应用代码 #

app.module.ts

移除重复的ConfigModule导入，仅保留全局配置的ConfigModule.forRoot()，并将MyModule放入imports数组，移除providers中冗余的模块和服务：

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { ConfigModule } from '@nestjs/config';
import configValidator from './config/config.validator';
import { MyModule } from 'myModule';
import configSchema from './config/config.schema';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      validationSchema: configValidator,
      cache: true,
      load: [configSchema]
    }),
    MyModule // 仅需导入自定义模块
  ],
  controllers: [AppController],
  providers: [AppService], // 移除冗余的ConfigService、MyModule、MyService等
})
export class AppModule {}

myGuard.ts

移除多余的@Inject()装饰器，直接注入MyService：

import { CanActivate, ExecutionContext, Injectable, UnauthorizedException } from '@nestjs/common';
import { Request } from 'express';
import { Observable } from 'rxjs';
import { MyService } from 'myModule';

@Injectable()
export class MyGuard implements CanActivate {
  constructor(private readonly myService: MyService) {}

  canActivate(context: ExecutionContext): boolean | Promise<boolean> | Observable<boolean> {
    return this.myService.myMethod()
      .then(/* ... 你的逻辑 */);
  }
}

关键说明 #

• 当宿主应用配置了isGlobal: true的ConfigModule后，所有模块都能自动访问ConfigService，无需在自定义模块中重复导入ConfigModule。
• Nest的依赖注入系统会自动识别类作为注入令牌，除非使用自定义令牌，否则无需手动添加@Inject()装饰器。
• 模块必须通过imports数组导入，不能放入providers中，providers仅用于声明当前模块的服务类。

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