添加SrvD服务后NestJS的onModuleInit钩子无法触发

我在NestJS项目中定义了多个服务，部分公共服务被大量其他服务使用，因此会在多个模块中导入。但发现当特定服务SrvD被注入到SrvE2的构造函数时，SrvE2的onModuleInit方法在项目启动时不会被调用，且项目启动无任何报错，无法定位问题。以下是项目结构示例，问题集中在SrvE2：

srvA.ts #

@Injectable()
export class SrvA {
  constructor(
    private somePkgSrv: SomePkgSrv,
  ) {}
}

srvB.ts #

@Injectable()
export class SrvB {
  constructor(
    private srvA: SrvA,
  ) {}
}

srvC.ts #

@Injectable()
export class SrvC {
  constructor(
    private srvA: SrvA,
    private srvB: SrvB,
  ) {}
}

srvD.ts #

@Injectable()
export class SrvD {
  constructor(
    private srvA: SrvA,
    private srvB: SrvB,
    private srvC: SrvC,
  ) {}
}

srvD.module.ts #

@Module({
  providers: [SrvA, SrvB, SrvC, SrvD],
  exports: [SrvD],
})

srvE1.ts #

export class SrvE1 implements OnModuleInit {
  constructor(
    private srvA: SrvA,
    private srvB: SrvB,
    private srvC: SrvC,
  ) {}

  async onModuleInit() {
    console.log ('I can print! Yay!')
  }
}

srvE2.ts #

export class SrvE2 implements OnModuleInit {
  constructor(
    private srvA: SrvA,
    private srvB: SrvB,
    private srvC: SrvC,
    private srvD: SrvD,
  ) {}

  async onModuleInit() {
    console.log ('I refuse to print so long as SrvD is here. Comment it and I will print')
  }
}

srvE.module.ts #

@Module({
  import: [SrvD], // the module
  providers: [SrvE1, SrvE2], // the services
  exports: [SrvE1, SrvE2],
})

问题分析与修复方案 #

1. 模块导入拼写错误

首先注意到srvE.module.ts中的import字段拼写错误，NestJS模块的导入配置必须是复数形式的imports，且应该导入SrvDModule类而非SrvD服务本身。这个错误会导致SrvD所在模块未被正确加载，依赖注入逻辑异常，进而影响SrvE2的生命周期钩子执行。

修复代码：

@Module({
  imports: [SrvDModule], // 修正为imports，导入正确的模块类
  providers: [SrvE1, SrvE2],
  exports: [SrvE1, SrvE2],
})
export class SrvEModule {}

2. 公共服务的导出缺失

SrvE1和SrvE2直接注入了SrvA、SrvB、SrvC，但这些服务仅在SrvDModule中声明为providers却未导出，导致SrvEModule无法获取到这些服务的正确实例，可能引发依赖解析冲突，干扰生命周期方法触发。

修复代码：

@Module({
  providers: [SrvA, SrvB, SrvC, SrvD],
  exports: [SrvD, SrvA, SrvB, SrvC], // 导出所有需要跨模块使用的服务
})
export class SrvDModule {}

3. 服务未被实际引用

如果SrvE2没有被任何控制器、其他服务或模块导出并引用，NestJS的树摇机制会将其视为未使用的服务，不会初始化该实例，自然不会调用onModuleInit。

验证方式：在某个控制器中注入SrvE2，或在其他模块中导入SrvEModule并引用SrvE2，确保服务被纳入初始化流程。

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