在NestJS中創建和管理模塊（Modules）：模塊間依賴關係和通信

843字
4分鐘
2024-07-09
- NestJS

模塊是NestJS的核心構建塊，它們幫助我們組織代碼並管理依賴關係。本文將介紹如何在NestJS中創建和管理模塊，探討模塊間的依賴關係和通信，並提供示例代碼展示複雜項目中的模塊組織和依賴管理。

模塊的創建和組織

創建模塊

在NestJS中，模塊是通過裝飾器 @Module() 定義的。以下示例展示了如何創建一個簡單的 UsersModule：

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

5
@Module({
6
  providers: [UsersService],
7
  controllers: [UsersController],
8
})
9
export class UsersModule {}

組織模塊

一個典型的NestJS項目會包含多個模塊，每個模塊負責不同的功能。例如，可以有一個 AuthModule 處理認證，一個 ProductsModule 處理產品管理，等等。

1
import { Module } from "@nestjs/common";
2
import { UsersModule } from "./users/users.module";
3
import { AuthModule } from "./auth/auth.module";
4
import { ProductsModule } from "./products/products.module";
5

6
@Module({
7
  imports: [UsersModule, AuthModule, ProductsModule],
8
})
9
export class AppModule {}

模塊間的依賴關係

導出和導入模塊

模塊可以通過 exports 屬性導出提供的服務，使其他模塊可以導入並使用這些服務。以下示例展示了如何導出 UsersService 並在 AuthModule 中導入 UsersModule：

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

5
@Module({
6
  providers: [UsersService],
7
  controllers: [UsersController],
8
  exports: [UsersService], // 導出 UsersService
9
})
10
export class UsersModule {}
11

12
// auth/auth.module.ts
13
import { Module } from "@nestjs/common";
14
import { AuthService } from "./auth.service";
15
import { UsersModule } from "../users/users.module";
16

17
@Module({
18
  imports: [UsersModule], // 導入 UsersModule
19
  providers: [AuthService],
20
})
21
export class AuthModule {}

模塊間的通信

模塊間的通信通常通過服務來實現。例如，AuthService 可以調用 UsersService 來驗證用戶：

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

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

8
  async validateUser(username: string, pass: string): Promise<any> {
9
    const user = await this.usersService.findOne(username);
10
    if (user && user.password === pass) {
11
      return user;
12
    }
13
    return null;
14
  }
15
}

複雜項目中的模塊組織和依賴管理

在複雜項目中，模塊的組織和依賴管理變得尤為重要。以下是一些最佳實踐：

使用特性模塊

將功能相關的代碼組織到特性模塊中。例如，所有與用戶相關的代碼都放在 UsersModule 中，所有與產品相關的代碼都放在 ProductsModule 中。

使用共享模塊

將常用的服務、管道、守衛等放在共享模塊中，並在需要的地方導入。例如，可以創建一個 SharedModule 來提供數據庫連接、日誌服務等。

1
import { Module } from "@nestjs/common";
2
import { DatabaseService } from "./database.service";
3
import { LoggerService } from "./logger.service";
4

5
@Module({
6
  providers: [DatabaseService, LoggerService],
7
  exports: [DatabaseService, LoggerService],
8
})
9
export class SharedModule {}
10

11
// app.module.ts
12
import { Module } from "@nestjs/common";
13
import { SharedModule } from "./shared/shared.module";
14
import { UsersModule } from "./users/users.module";
15
import { AuthModule } from "./auth/auth.module";
16

17
@Module({
18
  imports: [SharedModule, UsersModule, AuthModule],
19
})
20
export class AppModule {}

使用模塊間依賴注入

通過依賴注入機制，確保模塊間的松耦合。例如，通過構造函數注入服務，而不是在模塊內部直接實例化服務。

1
import { Injectable } from "@nestjs/common";
2
import { DatabaseService } from "../shared/database.service";
3

4
@Injectable()
5
export class ProductsService {
6
  constructor(private readonly databaseService: DatabaseService) {}
7

8
  async findAll(): Promise<any[]> {
9
    return this.databaseService.query("SELECT * FROM products");
10
  }
11
}

小結

通過本文的介紹，我們了解了如何在NestJS中創建和管理模塊，探討了模塊間的依賴關係和通信，並提供了示例代碼展示複雜項目中的模塊組織和依賴管理。