NestJS 模块

共享模块

假设我们将在几个模块之间共享 CatsService 实例。 我们需要把 CatsService 放到 exports 数组中。每个导入 CatsModule 的模块都可以访问 CatsService ，并且它们将共享相同的 CatsService 实例。

cats.module.ts

import { Module } from '@nestjs/common';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';

@Module({
  controllers: [CatsController],
  providers: [CatsService],
  exports: [CatsService]
})
export class CatsModule {}

模块导出

模块可以导出他们的内部提供者。 而且，他们可以再导出自己导入的模块。

@Module({
  imports: [CommonModule],
  exports: [CommonModule],
})
export class CoreModule {}

全局模块

@Global 装饰器使模块成为全局作用域。 全局模块应该只注册一次，最好由根或核心模块注册。 在上面的例子中，CatsService 组件将无处不在，而想要使用 CatsService 的模块则不需要在 imports 数组中导入 CatsModule。

import { Module, Global } from '@nestjs/common';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';

@Global()
@Module({
  controllers: [CatsController],
  providers: [CatsService],
  exports: [CatsService],
})
export class CatsModule {}

接口注入服务

定义一个接口

interface MyService {
  doSomething(): void;
}

创建一个实现该接口的服务类

@Injectable()
class MyServiceImpl implements MyService {
  doSomething(): void {
    console.log('Doing something...');
  }
}

在需要使用该服务的模块中，通过构造函数注入该服务

@Module({
  providers: [MyServiceImpl],
})
class AppModule {
  constructor(private readonly myService: MyService) {}
}

在模块中的任何地方使用myService来调用服务的方法

@Controller()
class MyController {
  constructor(private readonly myService: MyService) {}

  @Get()
  doSomething(): void {
    this.myService.doSomething();
  }
}

动态模块

动态模块能够让我们创建可定制的模块，当导入模块并向其传入某些选项参数，这个模块根据这些选项参数来动态的创建不同特性的模块。

动态模块其实就是给当前Module类提供一个forRoot方法，该方法返回一个新的Module，这个Module的类型是一个DynamicModule，在其他模块需要注册使用时，可以使用xxxModule.forRoot(args)来动态的注册不同的Module，以达到提供不同providers的目的。

首先需要自己编写一个静态方法，该方法通过接收传递进来的参数判断使用哪一个service，并且为了方便，我这里直接使用@Global()装饰器将该模块声明称了全局模块

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

传递参数使用

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