快捷導(dǎo)航

NestJS系列核心概念之Module模塊示例詳解

更新時(shí)間：2023年09月03日 15:20:53 作者：南玖

這篇文章主要為大家介紹了NestJS系列核心概念之Module模塊示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪

前言

模塊指的是使用@Module裝飾器修飾的類，每個(gè)應(yīng)用程序至少有一個(gè)模塊，即根模塊。根模塊是Nest用于構(gòu)建應(yīng)用程序的起點(diǎn)，理論上Nest程序可能只有根模塊，但在大多數(shù)情況下是存在多個(gè)模塊的，每個(gè)模塊各自封裝一組相關(guān)的功能。

@Module裝飾器

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

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

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

模塊共享

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

比如我使用nest g resource info新建了一個(gè)info類，并且使用export導(dǎo)出該服務(wù)

// 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] // 導(dǎo)出 InfoService 供其他模塊使用
})
export class InfoModule {}

然后我在user模塊中使用imports導(dǎo)入該模塊

// 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], // 導(dǎo)入 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() // 調(diào)用 InfoService 的 findAll 方法

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

這樣就完成模塊共享了，可以看到我們在user模塊中可以調(diào)用info的服務(wù)

模塊再導(dǎo)出

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

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

依賴注入

模塊類也可以注入provider服務(wù)

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

全局模塊

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

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

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

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

// 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() // 調(diào)用 InfoService 的 findAll 方法
  }
}

動(dòng)態(tài)模塊

動(dòng)態(tài)模塊能夠讓我們創(chuàng)建可定制的模塊，當(dāng)導(dǎo)入模塊并向其傳入某些選項(xiàng)參數(shù)，這個(gè)模塊根據(jù)這些選項(xiàng)參數(shù)來動(dòng)態(tài)的創(chuàng)建不同特性的模塊。

創(chuàng)建動(dòng)態(tài)模塊

動(dòng)態(tài)模塊其實(shí)就是給當(dāng)前Module類提供一個(gè)forRoot方法，該方法返回一個(gè)新的Module，這個(gè)Module的類型是一個(gè)DynamicModule，在其他模塊需要注冊使用時(shí)，可以使用xxxModule.forRoot(args)來動(dòng)態(tài)的注冊不同的Module，以達(dá)到提供不同providers的目的。

這里我們創(chuàng)建一個(gè)config的動(dòng)態(tài)模塊

// 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}
            ]
        }
    }
}

這個(gè)例子很簡單，首先需要自己編寫一個(gè)靜態(tài)方法，該方法通過接收傳遞進(jìn)來的參數(shù)判斷使用哪一個(gè)service，并且為了方便，我這里直接使用@Global()裝飾器將該模塊聲明稱了全局模塊

傳遞參數(shù)使用

調(diào)用靜態(tài)方法傳遞參數(shù)

// 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() // 調(diào)用 ConfigService 的 getHello 方法
  }
}

比如上面forRoot傳遞的參數(shù)是{name: 'nanjiu'}，所以此時(shí)的ConfigModule注入的應(yīng)該是UserService

修改forRoot參數(shù)

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

此時(shí)通過get方式再訪問同樣的路由，應(yīng)該是訪問到NanjiuService提供的服務(wù)了。