Moduuli on luokka, joka on korvattu @Module() -dekoraattorilla ja joka ryhmittelee toisiinsa liittyviä komponentteja — kontrollerit, palveluntarjoajat/palvelut — yhtenäiseksi yksiköksi. Moduulit ovat tapa, jolla NestJS järjestää sovelluksen ominaisuuksiin, ja jokaisessa Nest-sovelluksessa on vähintään yksi juurimoduuli AppModule.
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
Moduulit muodostavat DI scope -alueen: palveluntarjoaja on saatavilla sen moduulin sisällä ja muille moduuleille vain, jos se viedään (ja toinen moduuli tuo sen).
@Module({
imports: [UsersModule, AuthModule, DatabaseModule], // compose feature modules
})
export class AppModule {} // the root — bootstrapped to start the app
Jokaisella sovelluksella on juurimoduuli AppModule, joka tuo ominaisuusmoduulit ja muodostaa koko sovelluksen.
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)
Käytäntö on yksi moduuli per ominaisuus/alue (käyttäjät, autentikaatio, tuotteet), mikä pitää asiaan liittyvän koodin yhdessä ja tekee riippuvuuksista selvät.
// 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 {}
Jotta voit käyttää palveluntarjoajaa toisesta moduulista, tarjoava moduuli on vietävä se ja kuluttava moduuli on tuotava tarjoava moduuli — mikä tekee riippuvuuksista selkeät.
Moduulit ovat jokaisen NestJS-sovelluksen organisatorinen selkäranka — ne ryhmittelevät toisiinsa liittyviä kontrollerit ja palveluntarjoajat yhtenäisiksi ominaisuusyksikköiksi ja määrittelevät riippuvuuden injektoinnin rajat.
Neljän ominaisuuden (controllers, providers, imports, exports) ymmärtäminen ja erityisesti tuonti/vienti-mekanismi palveluntarjoajien jakamiseen moduulien välillä on olennaista: näin NestJS saavuttaa modulaarisen, löyhästi kytketyn arkkitehtuurin, jossa jokainen ominaisuus on itsensä sisältävä ja riippuvuudet ovat selkeät.
Ominaisuuksiin perustuva moduulirakenne (yksi moduuli per alue) on vakiotapa järjestää Nest-sovelluksia skaalautuvuuden ja ylläpidettävyyden kannalta.
Moduulit muodostavat yhdessä kontrollerien ja palveluntarjoajien kanssa NestJS:n ydinxe-arkkitehtuurin, mikä tekee niistä perusosaamista — sovelluksen rakenteemisen moduuleiksi ja palveluntarjoajien yhdistämisen niiden välillä tuonnin/viennin kautta hallitseminen on välttämätöntä minkä tahansa ei-triviaali NestJS-sovelluksen rakentamiseen ja se on usein sekaannuksen lähde, joka kannattaa ymmärtää hyvin aikaisessa vaiheessa.