NestJs使用forwardRef仍无法解决服务循环依赖问题

问题根因 #

你当前的循环依赖不止存在于OrderModule和PriceModule之间，还存在更长的循环链：OrderModule → 引入ProductModule → ProductModule引入PriceModule → PriceModule引入forwardRef的OrderModule，你只处理了Order和Price的双向引用，没有处理整条链上的循环依赖，才会触发模块undefined的报错。

立即修复方案 #

1. 首先修改product.module.ts里对PriceModule的引入，加上forwardRef包裹：

// product.module.ts
@Module({
  imports: [
    forwardRef(() => PriceModule),
    MongooseModule.forFeature([{ name: 'Product', schema: ProductSchema }]),
  ],
  controllers: [ProductController],
  providers: [ProductService],
  exports: [ProductService],
})
export class ProductModule {}

2. 同步修改OrderModule对ProductModule的引入，也加上forwardRef包裹：

// order.module.ts
@Module({
  imports: [
    CustomerModule,
    forwardRef(() => ProductModule),
    MongooseModule.forFeature([{ name: 'Order', schema: OrderSchema }]),
    forwardRef(() => PriceModule),
  ],
  controllers: [OrderController],
  providers: [OrderService],
  exports: [OrderService],
})
export class OrderModule {}

如果PriceService里用到的ProductService不需要在类初始化阶段调用，也可以改为属性注入替代构造函数注入，减少初始化阶段的依赖加载压力：

// price.service.ts
@Injectable()
export class PriceService extends GenericCrudService<PriceDocument> {
  @Inject(forwardRef(() => ProductService))
  private productService: ProductService; // 改为属性注入，不写在constructor中

  constructor(
    @InjectModel(Price.name) readonly price: Model<PriceDocument>,
    private readonly customerService: CustomerService,
    private readonly salePriceService: SalePriceService,
    @Inject(forwardRef(() => OrderService))
    private readonly orderService: OrderService,
  ) {
    super(price);
  }
}

多依赖场景下处理循环依赖的注意事项 #

• 要梳理完整的依赖链路，不能只处理直接双向依赖的两个模块，所有涉及到循环链上的跨模块引用都需要用forwardRef包裹
• 构造函数注入的依赖会在模块初始化时同步加载，如果部分依赖只在业务逻辑运行时才会用到，优先选择属性注入，避免初始化阶段的依赖冲突
• 尽量不要把通用服务（比如示例中的ProductService）和业务强耦合的服务互相引入，有条件的话可以把公共的计算逻辑抽成单独的Shared模块，从根源上切断循环依赖
• 检查所有模块的export和import逻辑，不要引入不需要的模块，避免不必要的依赖链路产生
• 所有循环依赖的模块里互相注入的服务，都必须用@Inject(forwardRef(() => 服务类))包裹，不能只给模块加forwardRef不给服务加
• 不要出现循环导出的情况，比如A模块导出B模块的服务，B模块又导出A模块的服务，会加重依赖解析的复杂度

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