NestJS如何像超级侦探一样识别循环依赖：使用madge

2023-10-06 18:16:58

在软件开发中，循环依赖是一个隐蔽而棘手的陷阱。它发生在两个或多个模块相互依赖时，导致它们无法独立存在或运行。在 NestJS 这个流行的 Node.js 框架中，循环依赖同样是一个需要警惕的问题。本文将介绍如何使用 madge 工具来识别 NestJS 中的循环依赖，并提供几种解决方案。

识别循环依赖

使用 madge 工具

madge 是一个强大的依赖分析库，可以帮助你发现代码中的循环依赖。以下是使用 madge 的步骤：

安装 madge
```
npm install madge
```
创建 madgefile.js

在项目根目录下创建一个 madgefile.js 文件，并添加以下内容：
```
const madge = require('madge');

const graph = madge('./src/**/*.ts');
```
生成依赖关系图

确保已安装 dot，然后在控制台中运行以下命令，它将创建一个名为 graph.png 的依赖关系图：
```
dot -Tpng graph.dot > graph.png
```
你可以在项目根目录下找到生成的 graph.png 文件，查看模块之间的依赖关系图，从而识别循环依赖。

解决循环依赖

方法一：减少依赖性

尝试减少服务之间的依赖关系。这可能涉及将服务分解为更小、更独立的模块。例如：

// UserService.ts
import { ProductService } from './product.service';

@Injectable()
export class UserService {
  constructor(private productService: ProductService) {}
}

// ProductService.ts
import { UserService } from './user.service';

@Injectable()
export class ProductService {
  constructor(private userService: UserService) {}
}

改为：

// UserService.ts
import { ProductService } from './product.service';

@Injectable()
export class UserService {
  constructor(private productService: ProductService) {}
}

// ProductService.ts
import { UserService } from './user.service';

@Injectable()
export class ProductService {
  constructor() {}
}

方法二：延迟加载

采用延迟加载来解决循环依赖。这意味着仅在需要时才加载服务。这可以通过惰性加载或依赖注入来实现。例如：

// UserService.ts
import { Optional } from '@nestjs/common';
import { ProductService } from './product.service';

@Injectable()
export class UserService {
  constructor(@Optional() private productService: ProductService) {}
}

方法三：接口和抽象类

使用一个服务为其他服务提供通用的界面。这使服务可以彼此独立，而无需相互依赖。例如：

// UserService.ts
import { Injectable } from '@nestjs/common';
import { IProductService } from './IProductService';

@Injectable()
export class UserService {
  constructor(private productService: IProductService) {}
}

// ProductService.ts
import { Injectable } from '@nestjs/common';
import { IUserService } from './IUserService';

@Injectable()
export class ProductService {
  constructor(private userService: IUserService) {}
}