Nest无法创建AuthModule实例 User模型关联Group触发模块导入undefined错误

我在尝试建立User模型和Group模型的关联时出现报错，不清楚问题成因。

报错日志 #

[Nest] 30312  - 06.12.2021, 20:53:42     LOG [NestFactory] Starting Nest application...
[Nest] 30312  - 06.12.2021, 20:53:42   ERROR [ExceptionHandler] Nest cannot create the AuthModule instance.
The module at index [1] of the AuthModule "imports" array is undefined.

Potential causes:
- A circular dependency between modules. Use forwardRef() to avoid it.
- The module at index [1] is of type "undefined". Check your import statements and the type of the module.

Scope [AppModule]
Error: Nest cannot create the AuthModule instance.
The module at index [1] of the AuthModule "imports" array is undefined.

触发条件 #

该错误是在user.model.ts中添加如下代码后触发的：

@Expose()
@HasMany(() => Group)
groups: Group[];

该错误核心是模型关联引入了循环依赖，导致模块导入时出现undefined，按以下步骤排查修复：

1. 模型关联添加forwardRef处理循环引用
   两个模型互相引用时，需要用forwardRef包裹关联类，避免初始化时类未定义：

// user.model.ts 修改为
import { forwardRef } from '@nestjs/common'; // 若使用特定ORM可导入对应包下的forwardRef

@Expose()
@HasMany(() => forwardRef(() => Group))
groups: Group[];

同时检查group.model.ts中的反向关联配置，同样添加forwardRef：

// group.model.ts 示例
@BelongsTo(() => forwardRef(() => User))
user: User;

2. 模块导入添加forwardRef处理循环依赖
   检查AuthModule、UserModule、GroupModule的导入关系，如果存在互相导入的场景，导入时用forwardRef包裹：

// 以AuthModule为例，修改imports配置
import { forwardRef, Module } from '@nestjs/common';

@Module({
  imports: [
    // 其他原有模块
    forwardRef(() => UserModule),
    forwardRef(() => GroupModule),
  ]
})
export class AuthModule {}

如果UserModule/GroupModule中也导入了AuthModule，对应位置也要做相同处理。
3. 检查模块导出与导入拼写
确认UserModule导出了User模型的提供者，GroupModule导出了Group模型的提供者；同时检查所有导入语句的路径、类名拼写是否正确，避免因路径错误导入undefined值。 #

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