NestJSでModule, Service, Controllerの関係性

NestJS

NestJSにはよく使う三つの要素としてModule, Service, Controllerがあります。

1
erDiagram
2
    Module }|..|{ Controller: controllers
3
    Module }|..|{ Service: providers
4
    Module }|..|{ "X Module": imports

そしてX ModuleはY Moduleのような別のモジュールを読み込んでいたりします。

Module

@ModuleとついていればModuleになる。

1
@Module({
2
  controllers: [AppController], // Module -> Controllerを張る
3
  imports: [], // Module <- Moduleを張る
4
  providers: [AppService], // Module -> Serviceを張る
5
})
6
export class AppModule {}

importsには別で提供されているModuleを利用したい場合にここに登録しておくとよい。以下、よく使っているモジュールを紹介しておきます。

• PrometheusModule
  • アクセスのデータとか集められるModule
• PrismaModule
  • Prismaが利用できるModule
• ThrottlerModule
  • アクセス制限をかけられるModule
• ConfigModule
  • .envを読み込めるやつModule
• CacheModule
  • キャッシュを利用できるModule
• HttpModule
  • axiosを利用できるModule
• ScheduleModule
  • 定期実行が設定できるModule
• GraphQLModule
  • GraphQLを利用できるModule

で、これらは各Moduleに設定すべきかAppModuleに設定すべきかという問題があるのですが、まあ個人的にはよくわからんのでAppModuleに突っ込もうと思います。

いっぱい入れると立ち上げるのが重くなるのですがLazyModuleLoadを利用すれば良いとのこと、多分。

で、Moduleをimportsに突っ込むときにisGlobalというオプションを設定できるので、それを設定するとAppModuleに繋がっているController全てで利用できるようになります、多分。

Controller

@Controller()とついていればControllerになる。

ControllerからはServiceが主に以下のようなコードで利用できる。

1
@Controller()
2
export class AppController {
3
  constructor(private readonly service: AppService) {}
4

5
  async index(): Promise<string> {
6
    return this.service.index() // Serviceのコードが呼べる
7
  }
8
}

Service

@Injectable()とついていればServiceになる。

そこは@Service()じゃないのか…

1
@Injectable()
2
export class AppService {
3
  // Controllerから呼ぶコードを実装する
4
  async index(): Promise<string> {
5
    return 'Hello, World!'
6
  }
7
}