Module | 研究筆記

規範作用域

module 生成後元數據是空的，可以自己填入以下選項：

controllers：註冊 controller 元件
providers：註冊可以被注入的 service、repository 等元件
exports：將 provider 匯出，供其他 module 使用
imports：匯入其他 module，匯入後就能使用其他 module 中 exports 裡列出的 provider

1
@Module({
2
  controllers: [TodoController],
3
  providers: [TodoService],
4
  exports: [TodoService],
5
  imports: [UserModule],
6
})
7
export class TodoModule {}

module 會規範好作用域，controllers 和 providers 只能填入該模組下的元件，否則會因為無法找到正確的依賴而報錯。

imports / exports

將 module 中以 @Injectable 標記的元件匯出，如 service 或是自訂的 provider 邏輯，在其他模組就可以用 imports 匯入。

1
// 將 CopyService 填入 CopyModule 的 exports
2
@Module({
3
  //...
4
  exports: [CopyService],
5
})
6
export class CopyModule {}
7

8
// 在 TodoModule 的 imports 載入 CopyModule
9
@Module({
10
  //...
11
  imports: [CopyModule],
12
})
13
export class TodoModule {}

如果其中一邊忘了做匯入或匯出，在元件中注入時會報錯：

1
// 這個 import 匯入類別的定義
2
import { CopyService } from 'src/copy/copy.service';
3

4
// NestJS 用 CopyService 這個標記去尋找依賴注入容器中的實例時會報錯
5
// 因為沒有在各自的 @Module 中定義 imports 或 exports
6
@Controller('todos')
7
export class TodoController {
8
  constructor(private readonly copyService: CopyService) {}
9

10
  @Get('copy')
11
  getCopy() {
12
    return this.copyService.getCopy();
13
  }
14
}

常用模組

經常同時出現、互相綁定的模組，可以聚合成一包常用模組 (common module) 一起匯出：

1
@Module({
2
  imports: [TodoModule, CopyModule],
3
  exports: [TodoModule, CopyModule],
4
})
5
export class CommonModule {}

全域模組

在 @Module 前加入 @Global()，就會被標記成全域模組。

在根模組匯入之後，其他模組就可以跳過匯入的步驟：

1
@Global()
2
@Module({
3
  imports: [TodoModule, CopyModule],
4
  exports: [TodoModule, CopyModule],
5
})
6
export class CommonModule {}

1
// 在根模組匯入
2
@Module({
3
  controllers: [AppController, TodoController],
4
  providers: [AppService],
5
  imports: [TestModule, CommonModule],
6
})
7
export class AppModule {}

1
import { Module } from '@nestjs/common';
2
import { TestController } from './test.controller';
3

4
@Module({
5
  controllers: [TestController],
6
  // 不用寫 imports
7
})
8
export class TestModule {}

依賴注入後就可以成功呼叫：

1
import { Controller, Get } from '@nestjs/common';
2
import { TodoService } from 'src/todo/todo.service';
3

4
@Controller('test')
5
export class TestController {
6
  constructor(private readonly todoService: TodoService) {}
7

8
  @Get()
9
  getTest() {
10
    return this.todoService.getTodos();
11
  }
12
}

警告

大量使用的話也會有耦合的問題。

小結

module 元件主要是限制該資料夾下所有元件的作用域，由 imports 和 exports 來決定 module 可以存取的元件。

參考資料

Modules