NestJS使用forwardRef仍遇循环依赖错误，寻求解决方案

问题背景 #

在NestJS中遇到循环依赖错误，已尝试使用forwardRef但问题仍未解决，以下是相关代码和错误信息。

相关模块代码 #

AuthModule #

// AuthModule 
@Module({
  imports: [
    forwardRef(() => UserModule),
    JwtModule.register({
      global: true,
      secret: process.env.TOKEN_SECRET,
      signOptions: { expiresIn: process.env.TOKEN_DURATION },
    }),
  ],
  providers: [AuthService, AuthGuard],
  controllers: [AuthController],
  exports: [AuthService],
})
export class AuthModule {}

UserModule #

// UserModule
@Module({
  imports: [forwardRef(() => AuthModule)],
  controllers: [UserController],
  providers: [UserService],
  exports: [UserService],
})
export class UserModule {}

服务注入方式 #

在UserService中注入AuthService：

private readonly authService: AuthService,

命令行错误信息 #

[Nest] 2788  - 06/10/2023, 12:56:50 PM     LOG [InjectorLogger] Nest encountered an undefined dependency. This may be due to a circular import or a missing dependency declaration.
[Nest] 2788  - 06/10/2023, 12:56:50 PM   ERROR [ExceptionHandler] Nest can't resolve dependencies of the UserService (PrismaService, ?, CONFIGURATION(app)). Please make sure that the argument dependency at index [1] is available in the UserModule context.

系统提示的潜在解决方案 #

• UserModule是否为有效的NestJS模块？
• 如果该依赖是一个provider，它是否属于当前UserModule？
• 如果该依赖是从其他@Module导出的，是否已在UserModule中导入该模块？

@Module({
  imports: [ /* 包含该依赖的模块 */ ]
})

问题原因 #

你只在模块层面配置了forwardRef，但在服务注入环节没有配合使用forwardRef。NestJS处理循环依赖需要同时满足两个条件：

1. 模块间通过forwardRef互相引用（你已经完成这一步）
2. 服务注入时，使用@Inject(forwardRef(() => TargetService))的方式延迟解析依赖（这一步缺失）

由于注入时未使用forwardRef，Nest在初始化UserService时无法正确解析AuthService，导致出现依赖undefined的错误。

解决方案 #

1. 在UserService中正确注入AuthService #

修改UserService的构造函数，用forwardRef包裹AuthService的注入：

import { forwardRef, Inject } from '@nestjs/common';
import { AuthService } from '../auth/auth.service';

// ...
constructor(
  private readonly prismaService: PrismaService,
  @Inject(forwardRef(() => AuthService))
  private readonly authService: AuthService,
  // 其他依赖...
) {}

2. 同步处理AuthService对UserService的依赖（如果存在） #

如果AuthService也依赖UserService，需要同样在其构造函数中使用forwardRef：

import { forwardRef, Inject } from '@nestjs/common';
import { UserService } from '../user/user.service';

// ...
constructor(
  @Inject(forwardRef(() => UserService))
  private readonly userService: UserService,
  // 其他依赖...
) {}

3. 保持模块层面的forwardRef配置 #

当前模块的imports配置已经正确，无需修改，确保AuthModule和UserModule都通过forwardRef互相引用。

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