【NestJS系列】核心概念：Module模塊

theme: fancy
highlight: atelier-dune-dark

前言

模塊指的是使用@Module裝飾器修飾的類，每個應用程序至少有一個模塊，即根模塊。根模塊是Nest用於構建應用程序的起點，理論上Nest程序可能只有根模塊，但在大多數情況下是存在多個模塊的，每個模塊各自封裝一組相關的功能。

@Module裝飾器

@Module()裝飾器可以傳入一個對象，屬性值如下：

providers	將由 Nest 注入器實例化的提供程序，並且至少可以在該模塊中共享
controllers	該模塊中定義的必須實例化的控制器集
imports	導入模塊的列表，導出該模塊所需的提供程序
exports	該子集providers由該模塊提供，並且應該在導入該模塊的其他模塊中可用

@Module({
  imports: [NanjiuModule, UserModule],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

模塊共享

如果你想把當前模塊的service暴露給其它模塊使用，則可以使用exports到處該服務

比如我使用nest g resource info新建了一個info類，並且使用export導出該服務

// info.module.ts
import { Module } from '@nestjs/common';
import { InfoService } from './info.service';
import { InfoController } from './info.controller';

@Module({
  controllers: [InfoController],
  providers: [InfoService], // 提供者
  exports: [InfoService] // 導出 InfoService 供其他模塊使用
})
export class InfoModule {}

然後我在user模塊中使用imports導入該模塊

// user.module.ts
import { Module } from '@nestjs/common';
import { UserService } from './user.service';
import { UserController } from './user.controller';
import { InfoModule } from 'src/info/info.module';

@Module({
  imports: [InfoModule], // 導入 InfoModule
  controllers: [UserController],
  providers: [UserService]
})
export class UserModule {}

最後在controller中依賴注入並使用

// user.controller.ts
import { InfoService } from 'src/info/info.service';

@Controller('user')
export class UserController {
  constructor(
    private readonly userService: UserService,
    private readonly infoService: InfoService, // 注入 InfoService
    ) {}

  @Post()
  create(@Body() createUserDto: CreateUserDto) {
    return this.infoService.findAll() // 調用 InfoService 的 findAll 方法

    // return this.userService.create(createUserDto);
  }
  //...
}

這樣就完成模塊共享了，可以看到我們在user模塊中可以調用info的服務

模塊再導出

可以把一些常用的，公共的模塊，全部先import進一個CommonModule，然後再把它們從exprots全部導出，以後如果有那個模塊想要使用其中某個模塊的Service，只需要將這個CommonModule導入即可，不用再導入所有的依賴模塊

// common.module.ts
@Module({
  imports: [Module1, Module2, Module3, Module4],
  exports: [Module1, Module2, Module3, Module4],
})
export class CommonModule {}

依賴注入

模塊類也可以注入provider服務

@Module({
  controllers: [UserController],
  providers: [UserService],
})
export class UserModule {
  constructor(private userService: UserService) {}
}

全局模塊

通過@Global()裝飾器聲明一個全局模塊，只需要在根模塊imports註冊該全局模塊，就可以在其他所有模塊內使用它導出的Service

比如：將info聲明爲全局模塊

// info.module.ts
@Global() // 全局模塊
@Module({
  controllers: [InfoController],
  providers: [InfoService], // 提供者
  exports: [InfoService] // 導出 InfoService 供其他模塊使用
})
export class InfoModule {}

然後在user模塊中無需導入，只需依賴注入就可直接使用（前提是已在根模塊導入）

// user.controller.ts
import { CreateUserDto } from './dto/create-user.dto';
import { InfoService } from 'src/info/info.service';

@Controller('user')
export class UserController {
  constructor(
    private readonly userService: UserService,
    private readonly infoService: InfoService, // 注入 InfoService
    ) {}

  @Post()
  create(@Body() createUserDto: CreateUserDto) {
    return this.infoService.findAll() // 調用 InfoService 的 findAll 方法
  }
}

動態模塊

動態模塊能夠讓我們創建可定製的模塊，當導入模塊並向其傳入某些選項參數，這個模塊根據這些選項參數來動態的創建不同特性的模塊。

創建動態模塊

動態模塊其實就是給當前Module類提供一個forRoot方法，該方法返回一個新的Module，這個Module的類型是一個DynamicModule，在其他模塊需要註冊使用時，可以使用xxxModule.forRoot(args)來動態的註冊不同的Module，以達到提供不同providers的目的。

這裏我們創建一個config的動態模塊

// config.module.ts
import { Module, DynamicModule, Global } from '@nestjs/common';
import { NanjiuService } from 'src/nanjiu/nanjiu.service';
import { UserService } from 'src/user/user.service';

interface Options {
    name: string
}
@Global()
@Module({
})
export class ConfigModule {
    static forRoot(options: Options): DynamicModule {
        console.log('options', options)
        return {
            module: ConfigModule,
            providers: [
                {provide: 'config', useClass: options.name === 'nanjiu' ? NanjiuService : UserService},
            ],
            exports: [
                {provide: 'config', useClass: options.name === 'nanjiu' ? NanjiuService : UserService}
            ]
        }
    }
}

這個例子很簡單，首先需要自己編寫一個靜態方法，該方法通過接收傳遞進來的參數判斷使用哪一個service，並且爲了方便，我這裏直接使用@Global()裝飾器將該模塊聲明稱了全局模塊

傳遞參數使用

調用靜態方法傳遞參數

// app.module.ts
@Module({
  imports: [ConfigModule.forRoot({name: 'fe'})],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

然後在controller中使用

import { Controller, Get, Inject } from '@nestjs/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(
    private readonly appService: AppService, 
    @Inject('config') private readonly configService // 注入 ConfigService
    ) {}

  @Get('/hello2')
  get2() {
    return this.configService.getHello() // 調用 ConfigService 的 getHello 方法
  }
}

比如上面forRoot傳遞的參數是{name: 'nanjiu'}，所以此時的ConfigModule注入的應該是UserService

修改forRoot參數

// app.module.ts
@Module({
  imports: [ConfigModule.forRoot({name: 'nanjiu'})],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

此時通過get方式再訪問同樣的路由，應該是訪問到NanjiuService提供的服務了。

以上就是動態模塊的簡單用法，後續內容我們還會再遇到它～