NestJS Mongoose双向关联时Schema未定义编译错误解决方案
NestJS Mongoose 双向关联循环依赖的规避方案
方案1:切断schema层循环导入,使用字符串作为ref标识
- 移除两个schema文件中互相顶层import对方类的代码
- 将ref配置中的类引用替换为对应模型的字符串名称:
- User Schema 中
product字段的 ref 从ref: Product修改为ref: 'Product' - Product Schema 中
user字段的 ref 从ref: User修改为ref: 'User'
- User Schema 中
- 这个写法是Mongoose原生支持的配置方式,populate时会自动匹配字符串对应的已注册模型,不需要在schema文件里直接引入对方的类,从代码加载链路层面就切断了循环依赖,自然不会出现类未初始化的问题。
方案2:保留类型提示,使用惰性解析的ref函数
如果不想丢失类引用带来的TypeScript类型提示,可以将ref配置从直接传入类调整为传入返回类的箭头函数,实现惰性加载:
- 修改 User Schema 的 product 字段配置:
@Prop({ type: [{ type: mongooseSchema.Types.ObjectId, ref: () => Product }] }) product: Product[]; - 修改 Product Schema 的 user 字段配置:
@Prop({ type: mongooseSchema.Types.ObjectId, ref: () => User }) user: User; - 装饰器初始化阶段不会立刻解析箭头函数内的类引用,等所有schema完成初始化、populate逻辑实际执行时,才会读取类对应的模型名,从根源上避免类为undefined的报错。
模块配置优化
- 不要在ProductModule的
MongooseModule.forFeature中重复注册User模型,将User模型的注册逻辑统一收敛到UserModule中,并通过exports导出:// user.module.ts @Module({ imports: [MongooseModule.forFeature([{ name: User.name, schema: UserSchema }])], exports: [MongooseModule] }) export class UserModule {} - ProductModule 仅需在 imports 中引入UserModule即可,无需重复注册User模型,避免模型重复初始化引发的衍生异常。
两种ref配置写法与直接引用类的效果完全等价,不会对populate功能产生任何影响。
内容的提问来源于stack exchange,提问作者Andon Mitev
相关产品推荐
相关产品推荐

