深入解析NestJS中的依赖注入：底层机制与应用实例

1214字
6分钟
2024-07-08
- NestJS

依赖注入（Dependency Injection, DI）是一种设计模式，旨在通过将组件的依赖关系作为参数传递，减少组件之间的耦合。NestJS作为一个进阶的Node.js框架，采用了强类型和模块化的方式来实现依赖注入。本文将从底层实现原理出发，详细探讨NestJS中的依赖注入机制及其实际应用。

1. NestJS中的依赖注入机制

NestJS的依赖注入机制是基于反射元数据和依赖图来实现的。它利用了TypeScript的装饰器和反射API来自动解析类的依赖，并根据依赖图进行实例化和注入。

1.1 反射与元数据

NestJS使用reflect-metadata库来实现反射元数据的收集和读取。在TypeScript中，可以使用@Injectable()、@Inject()等装饰器来标记类和属性，NestJS会在编译时收集这些元数据，并在运行时使用它们来构建依赖关系。

1
import "reflect-metadata";
2

3
@Injectable()
4
export class UsersService {
5
  constructor(private readonly userRepository: UserRepository) {}
6
}

在上述代码中，@Injectable()装饰器标记了UsersService类，这使得NestJS能够识别该类为可注入的服务。在构造函数中，userRepository被标记为private readonly，这告诉NestJS该类依赖于UserRepository。

1.2 依赖图与解析

NestJS在应用程序启动时，会扫描所有模块、控制器和提供者，收集它们的元数据并建立依赖图。这个依赖图是一种有向无环图（DAG），表示类之间的依赖关系。NestJS会根据这个图来解析依赖，并按需实例化对象。

1
@Module({
2
  providers: [UsersService, UserRepository],
3
})
4
export class UsersModule {}

在模块中声明的提供者会被NestJS注册到依赖图中。然后，NestJS会解析这些提供者的依赖项并创建实例。在这个过程中，NestJS遵循一个典型的“请求-实例化-注入”流程：

请求：应用程序请求某个服务（如UsersService）。
实例化：NestJS检查该服务的构造函数参数，查找所有依赖项并递归地实例化这些依赖项。
注入：实例化后，NestJS将依赖项注入到服务中，并返回服务的实例。

2. 实际应用：模块、控制器、服务与自定义提供者

2.1 模块的配置

模块是NestJS的组织单位。每个模块都用@Module()装饰器定义，包含提供者、控制器以及可能导入的其他模块。

1
import { Module } from "@nestjs/common";
2
import { UsersService } from "./users.service";
3
import { UsersController } from "./users.controller";
4
import { UserRepository } from "./user.repository";
5

6
@Module({
7
  providers: [UsersService, UserRepository], // 注册提供者
8
  controllers: [UsersController], // 注册控制器
9
})
10
export class UsersModule {}

在上述示例中，UsersModule注册了UsersService和UserRepository作为提供者，并声明了UsersController。

2.2 控制器的配置

控制器用来处理HTTP请求，并返回响应。控制器类通过@Controller()装饰器定义，方法通过@Get()、@Post()等装饰器来标记为路由处理程序。

1
import { Controller, Get } from "@nestjs/common";
2
import { UsersService } from "./users.service";
3

4
@Controller("users")
5
export class UsersController {
6
  constructor(private readonly usersService: UsersService) {}
7

8
  @Get()
9
  async findAll() {
10
    return this.usersService.findAll();
11
  }
12
}

在UsersController中，通过构造函数注入UsersService，从而使用服务的方法来处理业务逻辑。

2.3 服务的配置

服务包含应用程序的业务逻辑，并通过依赖注入系统提供给控制器和其他服务使用。

1
import { Injectable } from "@nestjs/common";
2
import { UserRepository } from "./user.repository";
3

4
@Injectable()
5
export class UsersService {
6
  constructor(private readonly userRepository: UserRepository) {}
7

8
  async findAll() {
9
    return this.userRepository.findAll();
10
  }
11
}

在UsersService中，UserRepository被注入并用于数据访问逻辑。@Injectable()装饰器使得该服务可以被NestJS的DI系统管理。

2.4 自定义提供者

自定义提供者允许开发者通过不同的方式（如useValue、useClass、useFactory）来提供依赖。例如，可以使用useFactory进行异步初始化。

1
import { Injectable } from "@nestjs/common";
2

3
@Injectable()
4
export class AsyncService {
5
  constructor(private readonly someDependency: any) {}
6

7
  async doSomething() {
8
    return "done";
9
  }
10
}
11

12
// app.module.ts
13
import { Module } from "@nestjs/common";
14
import { AsyncService } from "./async.service";
15

16
@Module({
17
  providers: [
18
    {
19
      provide: AsyncService,
20
      useFactory: async () => {
21
        const dependency = await someAsyncInitialization();
22
        return new AsyncService(dependency);
23
      },
24
    },
25
  ],
26
})
27
export class AppModule {}
28

29
async function someAsyncInitialization() {
30
  // 模拟异步初始化
31
  return new Promise((resolve) =>
32
    setTimeout(() => resolve("initialized dependency"), 1000),
33
  );
34
}