深入解析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遵循一個典型的“請求-實例化-注入”流程：

  1. 請求：應用程式請求某個服務（如UsersService）。
  2. 實例化：NestJS檢查該服務的構造函數參數，查找所有依賴項並遞歸地實例化這些依賴項。
  3. 注入：實例化後，NestJS將依賴項注入到服務中，並返回服務的實例。

2. 實際應用：模組、控制器、服務與自訂提供者

2.1 模組的配置

模組是NestJS的組織單位。每個模組都用@Module()裝飾器定義，包含提供者、控制器以及可能導入的其他模組。

users.module.ts
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()等裝飾器來標記為路由處理程序。

users.controller.ts
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 服務的配置

服務包含應用程式的業務邏輯，並通過依賴注入系統提供給控制器和其他服務使用。

users.service.ts
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進行異步初始化。

async.service.ts
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
}

在上述程式碼中，AsyncService通過工廠函數useFactory進行異步初始化。這種方式對於需要複雜配置或異步操作的依賴項非常有用。

總結

NestJS的依賴注入系統基於TypeScript的強型別特性和裝飾器，通過反射機制和依賴圖實現了靈活且強大的依賴管理。它不僅支持基本的類實例注入，還提供了豐富的自訂提供者配置選項，使開發者能夠輕鬆管理複雜的依賴關係。這種設計使得NestJS應用程式具備了高度的模組化、可測試性和可維護性。

相似的文章

如何區分開發環境和線上環境及其配置（NestJS + MySQL + TypeScript）

如何區分開發環境和線上環境及其配置（NestJS + MySQL + TypeScript）

NestJS Controller詳解：處理不同HTTP請求方法及路由參數

NestJS Controller詳解：處理不同HTTP請求方法及路由參數