A modul egy @Module() dekorátorral ellátott osztály, amely kapcsolódó komponenseket — kontrollereket, providereket/szervezeteket — csoportosít egy összetartó egységbe. A modulok azt határozzák meg, hogy a NestJS hogyan szervezi az alkalmazást funkciók alapján, és minden Nest alkalmazásnak van legalább egy AppModule gyökérmodulja.
import { Module } from "@nestjs/common";
@Module({
controllers: [UsersController], // controllers belonging to this module
providers: [UsersService], // providers (services) this module creates
imports: [DatabaseModule], // OTHER modules whose exports this module needs
exports: [UsersService], // what this module makes available to importers
})
export class UsersModule {}
controllers → the controllers (request handlers) in this module
providers → the providers/services defined and instantiated here (for DI)
imports → other modules whose EXPORTED providers this module can use
exports → the subset of THIS module's providers shared with importing modules
A modulok egy DI hatókört képeznek: egy provider az adott modulon belül érhető el, és más modulokból csak akkor, ha exportálva van (és az adott modul importálja azt).
@Module({
imports: [UsersModule, AuthModule, DatabaseModule], // compose feature modules
})
export class AppModule {} // the root — bootstrapped to start the app
Minden alkalmazásnak van egy AppModule gyökérmodulja, amely importálja a funkció modulokat, összeállítva az egész alkalmazást.
src/
app.module.ts (root — imports feature modules)
users/
users.module.ts (groups users controller + service)
users.controller.ts
users.service.ts
auth/
auth.module.ts
database/
database.module.ts (shared infrastructure)
A szokás, hogy egy modul per funkció/domain (felhasználók, hitelesítés, termékek), amely összeköti a kapcsolódó kódot és explicit módon definiálja a függőségeket.
// UsersModule exports UsersService...
@Module({ providers: [UsersService], exports: [UsersService] })
export class UsersModule {}
// ...so AuthModule can use it by importing UsersModule
@Module({ imports: [UsersModule] }) // now AuthModule can inject UsersService
export class AuthModule {}
Ahhoz, hogy egy másik modul providerét használhassuk, az azt biztosító modul exportálnia kell azt, és a fogyasztó modul importálnia kell az azt biztosító modult — így a függőségek explicittek lesznek.
A modulok minden NestJS alkalmazás szervezeti gerincét képezik — csoportosítják a kapcsolódó kontrollereket és providereket összetartó funkció egységekbe, és meghatározzák a függőség-injektálás határait.
A négy tulajdonság (controllers, providers, imports, exports) megértése, és különösen a import/export mechanizmus a providerek modulok közötti megosztásához elengedhetetlen: így éri el a NestJS a moduláris, lazán csatolt architektúrát, ahol minden funkció önálló és a függőségek explicittek.
A funkció alapú modul szerkezet (egy modul per domain) a standard módja a Nest alkalmazások szervezésének a skálázhatóság és karbantarthatóság érdekében.
A modulok, a kontrollerek és a providerek mellett az NestJS alaparchitektúrájának alapját képezik, így alapvető ismeretnek számítanak — az alkalmazások modulokra történő felosztásának és a providerek modulok közötti összekapcsolásának az import/export mechanizmusokon keresztüli megértése szükséges bármilyen nem triviális NestJS alkalmazás fejlesztéséhez, és ez a korai szakaszban érdemes jól megérteni, mivel gyakori zavaros pont.