#生命周期事件

Nest 应用程序以及其中的每个组件都拥有由 Nest 管理的生命周期。Nest 提供了生命周期钩子 ，这些钩子能让你观测到关键的生命周期事件，并在事件发生时执行相应操作（即在模块、提供者或控制器上运行注册的代码）。

#生命周期时序

下图展示了从应用启动到 Node 进程退出的关键生命周期事件序列。我们可以将整个生命周期划分为三个阶段： 初始化 、 运行中和终止 。利用这个生命周期机制，你可以规划模块和服务的适当时机初始化、管理活动连接，并在应用程序收到终止信号时优雅地关闭它。

#生命周期事件

生命周期事件发生在应用程序启动和关闭过程中。Nest 会在以下每个生命周期事件中调用模块、提供者和控制器上已注册的生命周期钩子方法（需先启用关闭钩子 ，具体说明见下文 ）。如上图所示，Nest 还会调用适当的底层方法来开始监听连接和停止监听连接。

在下表中，onModuleInit 和 onApplicationBootstrap 仅在你显式调用 app.init() 或 app.listen() 时触发。

在下表中，onModuleDestroy、beforeApplicationShutdown 和 onApplicationShutdown 仅在你显式调用 app.close()，或进程收到特殊系统信号（如 SIGTERM）且你在应用启动时正确调用了 enableShutdownHooks 时触发（参见下文应用关闭部分）。

* 对于这些事件，若未显式调用 app.close()，则需手动启用才能使其在系统信号（如 SIGTERM）下生效。详见下方应用关闭章节。

#使用说明

每个生命周期钩子都对应一个接口。从技术上讲这些接口是可选的，因为在 TypeScript 编译后它们不会存在。但为了获得强类型和编辑器工具支持，最佳实践仍是使用这些接口。要注册生命周期钩子，只需实现相应接口。例如，若要在特定类（如控制器、提供者或模块）上注册模块初始化时调用的方法，可通过实现 OnModuleInit 接口并提供 onModuleInit() 方法来完成，如下所示：

import { Injectable, OnModuleInit } from '@nestjs/common';

@Injectable()
export class UsersService implements OnModuleInit {
  onModuleInit() {
    console.log(`The module has been initialized.`);
  }
}

#异步初始化

OnModuleInit 和 OnApplicationBootstrap 钩子都允许您延迟应用初始化过程（返回一个 Promise 或将方法标记为 async 并在方法体内 await 异步方法完成）。

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

#应用关闭

onModuleDestroy()、beforeApplicationShutdown() 和 onApplicationShutdown() 钩子会在终止阶段被调用（响应显式的 app.close() 调用或在选择接收 SIGTERM 等系统信号时）。该特性常与 Kubernetes 配合管理容器生命周期，或被 Heroku 用于 dynos 或类似服务。

关机钩子监听器会消耗系统资源，因此默认处于禁用状态。要使用关机钩子，您必须启用监听器 ，通过调用 enableShutdownHooks() 方法：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  // Starts listening for shutdown hooks
  app.enableShutdownHooks();

  await app.listen(process.env.PORT ?? 3000);
}
bootstrap();

当应用接收到终止信号时，它将按照上述顺序调用所有已注册的 onModuleDestroy()、beforeApplicationShutdown() 以及 onApplicationShutdown() 方法，并将相应信号作为第一个参数传入。如果注册的函数需要等待异步调用（返回 promise），Nest 将在此 promise 被解析或拒绝前暂停执行后续序列。

@Injectable()
class UsersService implements OnApplicationShutdown {
  onApplicationShutdown(signal: string) {
    console.log(signal); // e.g. "SIGINT"
  }
}