nestjs 全栈进阶--nest生命周期

136 阅读2分钟

  视频教程

12_nestjs生命周期_哔哩哔哩_bilibili

所有应用程序元素都有一个由 Nest 管理的生命周期。Nest 提供了生命周期钩子,提供了对关键生命时刻的可见性,以及在关键时刻发生时采取行动(在你的module,injectable或者controller中注册代码)的能力。

nest new lifecycle -p pnpm
pnpm start:dev

下图描述了关键应用生命周期事件序列,从应用引导之时到node应用退出。我们可以把整个生命周期划分为三个阶段:初始化,运行和终止。使用生命周期,你可以合理计划模块和服务的初始化,管理活动链接,并且在应用程序收到终止指令时优雅地退出。

首先,递归初始化模块,会依次调用模块内的 controller、provider 的 onModuleInit 方法,然后再调用 module 的 onModuleInit 方法。

全部初始化完之后,再依次调用模块内的 controller、provider 的 onApplicationBootstrap 方法,然后调用 module 的 onApplicationBootstrap 方法

然后监听网络端口。Nest 应用就正常运行。

nest g res aaa --no-spec
nest g res bbb --no-spec

接下来,我们在aaa和bbb的controller、service、module 里分别实现 OnModuleInit, OnApplicationBootstrap

bbb,同样的操作,然后重跑项目

这就是 onModuleInit 和 onApplicationBootstrap 生命周期的调用顺序

应用销毁的时候也同样有生命周期:

先调用每个模块的 controller、provider 的 onModuleDestroy 方法,然后调用 Module 的 onModuleDestroy 方法。

之后再调用每个模块的 controller、provider 的 beforeApplicationShutdown 方法,然后调用 Module 的 beforeApplicationShutdown 方法。

然后停止监听网络端口。

之后调用每个模块的 controller、provider 的 onApplicationShutdown 方法,然后调用 Module 的 onApplicationShutdown 方法。

之后停止进程。

onModuleDestory 和 beforeApplicationShutdown 的区别

beforeApplicationShutdown 是可以拿到 signal 系统信号的,比如 SIGTERM。这些终止信号是别的进程传过来的,让它做一些销毁的事情,比如用 k8s 管理容器的时候,可以通过这个信号来通知它。

接下来 我们给aaa和bbb加上这两个,看看效果

然后我们去main.ts文件中触发app.close() (app.close() 只是触发销毁逻辑,但不会真正退出进程)

生命周期方法是这样的执行顺序:

所有的生命周期函数都是支持 async 的。

生命周期的作用

一般都是通过 moduleRef 取出一些 provider 来销毁,比如关闭连接。

onApplicationShutdown 的生命周期里,拿到当前模块的引用 moduleRef,调用 get 方法,传入 token,取出对应的 provider 实例,然后调用它的方法。