Lifecycle hodisalari

Nest ilovasi, shuningdek har bir ilova elementi, Nest tomonidan boshqariladigan lifecycle'ga ega. Nest lifecycle hooks ni taqdim etadi; ular asosiy lifecycle hodisalarini ko'rish imkonini beradi va ular sodir bo'lganda harakat qilish (modul, provayder yoki controllerlarda ro'yxatdan o'tkazilgan kodni ishga tushirish) imkonini beradi.

Lifecycle ketma-ketligi

Quyidagi diagrammada ilovaning bootstrappingidan boshlab node jarayoni yakunlangungacha bo'lgan asosiy lifecycle hodisalari ketma-ketligi ko'rsatilgan. Umumiy lifecycle'ni uch bosqichga bo'lishimiz mumkin: initializing, running va terminating. Ushbu lifecycle yordamida modullar va servislarning mos inicializatsiyasini rejalashtirishingiz, faol ulanishlarni boshqarishingiz va ilova tugatish signalini olganda uni silliq tarzda o'chirishingiz mumkin.

Lifecycle hodisalari

Lifecycle hodisalari ilovani bootstrap qilish va shutdown paytida sodir bo'ladi. Nest quyidagi lifecycle hodisalarining har birida modullar, provayderlar va controllerlardagi ro'yxatdan o'tgan lifecycle hook metodlarini chaqiradi (shutdown hooks avval yoqilishi kerak, quyida shunday ta'riflanganidek). Yuqoridagi diagrammada ko'rsatilganidek, Nest ulanishlarni tinglashni boshlash va ulanishlarni to'xtatish uchun mos underlying metodlarni ham chaqiradi.

Quyidagi jadvalda onModuleInit va onApplicationBootstrap faqat app.init() yoki app.listen() ni aniq chaqirganingizda ishga tushadi.

Quyidagi jadvalda onModuleDestroy, beforeApplicationShutdown va onApplicationShutdown faqat app.close() ni aniq chaqirganingizda yoki jarayon maxsus tizim signalini (masalan, SIGTERM) olganda va siz ilova bootstrapida enableShutdownHooks ni to'g'ri chaqirganingizda ishga tushadi (quyidagi Application shutdown bo'limiga qarang).

* Bu hodisalar uchun, agar app.close() ni aniq chaqirmayotgan bo'lsangiz, SIGTERM kabi tizim signallari bilan ishlashi uchun ularni yoqish kerak. Quyidagi Application shutdown bo'limiga qarang.

Foydalanish

Har bir lifecycle hook interfeys bilan ifodalanadi. Interfeyslar texnik jihatdan ixtiyoriy, chunki ular TypeScript kompilyatsiyasidan so'ng mavjud bo'lmaydi. Shunga qaramay, kuchli tipizatsiya va editor toolingdan foydalanish uchun ularni ishlatish yaxshi amaliyotdir. Lifecycle hookni ro'yxatdan o'tkazish uchun tegishli interfeysni amalga oshiring. Masalan, muayyan sinfda (masalan, Controller, Provider yoki Module) modul inicializatsiyasi paytida chaqiriladigan metodni ro'yxatdan o'tkazish uchun OnModuleInit interfeysini amalga oshirib, onModuleInit() metodini taqdim eting, quyida ko'rsatilganidek:

1import { Injectable, OnModuleInit } from '@nestjs/common';
2
3@Injectable()
4export class UsersService implements OnModuleInit {
5  onModuleInit() {
6    console.log(`The module has been initialized.`);
7  }
8}

Asinxron inicializatsiya

OnModuleInit ham, OnApplicationBootstrap ham ilovani inicializatsiya qilish jarayonini kechiktirishga imkon beradi (Promise qaytarish yoki metodni async deb belgilab, metod tanasida asinxron metod yakunlanishini await qilish).

1async onModuleInit(): Promise<void> {
2  await this.fetch();
3}

Ilovani o'chirish

onModuleDestroy(), beforeApplicationShutdown() va onApplicationShutdown() hook'lari terminating bosqichda chaqiriladi (app.close() aniq chaqirilganda yoki SIGTERM kabi tizim signallari olinganda va siz bu holatni yoqqan bo'lsangiz). Bu imkoniyat ko'pincha Kubernetes bilan konteyner lifecycle'larini boshqarishda, Heroku da dyno'lar yoki shunga o'xshash servislar uchun ishlatiladi.

Shutdown hook listenerlar tizim resurslarini iste'mol qiladi, shuning uchun ular standart holatda o'chirilgan. Shutdown hooklardan foydalanish uchun enableShutdownHooks() ni chaqirib listenerlarni yoqishingiz shart:

1import { NestFactory } from '@nestjs/core';
2import { AppModule } from './app.module';
3
4async function bootstrap() {
5  const app = await NestFactory.create(AppModule);
6
7  // Starts listening for shutdown hooks
8  app.enableShutdownHooks();
9
10  await app.listen(process.env.PORT ?? 3000);
11}
12bootstrap();

Ilova termination signalini olganda, ro'yxatdan o'tgan onModuleDestroy(), beforeApplicationShutdown(), so'ng onApplicationShutdown() metodlari (yuqorida ta'riflangan ketma-ketlikda) birinchi parametr sifatida tegishli signal bilan chaqiriladi. Agar ro'yxatdan o'tgan funksiya asinxron chaqiruvni kutsa (promise qaytarsa), Nest promise resolve yoki reject bo'lmaguncha ketma-ketlikni davom ettirmaydi.

1@Injectable()
2class UsersService implements OnApplicationShutdown {
3  onApplicationShutdown(signal: string) {
4    console.log(signal); // e.g. "SIGINT"
5  }
6}