雅關(guān)閉的完整實(shí)踐)
后端微服務(wù)云原生【免費(fèi)下載鏈接】midway A Node.js Serverless Framework for front-end/full-stack developers. Build the application for next decade. Works on AWS, Alibaba Cloud, Tencent Cloud and traditional VM/Container. Super easy integrate with React and Vue. 項(xiàng)目地址https://gitcode.com/gh_mirrors/mi/midway點(diǎn)擊查看免費(fèi)下載在 Node.js 服務(wù)端應(yīng)用中數(shù)據(jù)庫連接、配置預(yù)生成、資源清理這類操作理應(yīng)發(fā)生在應(yīng)用啟動(dòng)與停止的特定階段而不是在請(qǐng)求響應(yīng)中重復(fù)處理。Midway 為此內(nèi)置了一套完整的生命周期機(jī)制你只需在src/configuration.ts中實(shí)現(xiàn)ILifeCycle接口框架就會(huì)在啟動(dòng)、就緒、服務(wù)啟動(dòng)、關(guān)閉等關(guān)鍵節(jié)點(diǎn)自動(dòng)調(diào)用對(duì)應(yīng)方法。讀完本文你將掌握 Midway 項(xiàng)目生命周期與對(duì)象生命周期的全部鉤子函數(shù)、其底層執(zhí)行順序與超時(shí)機(jī)制并能在真實(shí)項(xiàng)目中完成連接建立、對(duì)象擴(kuò)充、健康檢查與優(yōu)雅關(guān)閉的落地。項(xiàng)目生命周期概覽Midway 為開發(fā)人員提供了四個(gè)項(xiàng)目級(jí)生命周期函數(shù)分別對(duì)應(yīng)應(yīng)用運(yùn)行的不同階段onConfigLoad配置文件加載階段可以在這里修改、補(bǔ)充配置onReady依賴注入容器準(zhǔn)備完畢可以在這個(gè)階段做大部分初始化事情onServerReady服務(wù)啟動(dòng)完成此時(shí)可以拿到 server 與端口信息onStop應(yīng)用即將關(guān)閉在這里清理資源onHealthCheck可選補(bǔ)充在健康檢查被調(diào)用時(shí)執(zhí)行用于上報(bào)組件/依賴的健康狀態(tài)。這些鉤子通過項(xiàng)目根目錄下的src/configuration.ts文件實(shí)現(xiàn)ILifeCycle接口即可被框架在啟動(dòng)時(shí)自動(dòng)加載。接口的完整定義如下與倉庫源碼 interface.ts 中ILifeCycle的定義保持一致interface ILifeCycle { /** * 在應(yīng)用配置加載后執(zhí)行 */ onConfigLoad?(container: IMidwayContainer, app: IMidwayApplication): Promisevoid; /** * 在依賴注入容器 ready 的時(shí)候執(zhí)行 */ onReady(container: IMidwayContainer, app: IMidwayApplication): Promisevoid; /** * 在應(yīng)用服務(wù)啟動(dòng)后執(zhí)行 */ onServerReady?(container: IMidwayContainer, app: IMidwayApplication): Promisevoid; /** * 在應(yīng)用停止的時(shí)候執(zhí)行 */ onStop?(container: IMidwayContainer, app: IMidwayApplication): Promisevoid; /** * 在健康檢查時(shí)執(zhí)行 */ onHealthCheck?(container: IMidwayContainer): PromiseHealthResult; }從源碼實(shí)現(xiàn)看每個(gè)鉤子函數(shù)實(shí)際上還會(huì)接收到第三個(gè)參數(shù)options: LifeCycleInvokeOptions其中包含timeout當(dāng)前生命周期超時(shí)配置與abortController中斷信號(hào)這在后文超時(shí)機(jī)制一節(jié)會(huì)詳細(xì)展開。底層執(zhí)行順序生命周期方法并非并行執(zhí)行而是由框架的MidwayLifeCycleService按嚴(yán)格順序調(diào)度。在 lifeCycleService.ts 中可以清晰看到完整執(zhí)行鏈掃描所有Configuration()修飾的類創(chuàng)建實(shí)例并收集為生命周期實(shí)例列表并行綁定四類對(duì)象生命周期鉤子onBeforeObjectCreated/onObjectCreated/onObjectInit/onBeforeObjectDestroy依次執(zhí)行所有配置類的onConfigLoad()返回的數(shù)據(jù)通過configService.addObject()合并進(jìn)配置依次執(zhí)行onReady()調(diào)用frameworkService.runFramework()啟動(dòng)框架此時(shí)監(jiān)聽端口、啟動(dòng) server依次執(zhí)行onServerReady()。而在應(yīng)用停止時(shí)stop 方法會(huì)先將生命周期實(shí)例列表倒序后依次執(zhí)行onStop()再停止框架。也就是說onStop的執(zhí)行順序與啟動(dòng)階段相反后初始化的組件會(huì)先被清理從而保證資源釋放的對(duì)稱性。onConfigLoad啟動(dòng)時(shí)修改配置onConfigLoad一般用于修改項(xiàng)目的配置文件比如根據(jù)運(yùn)行時(shí)環(huán)境預(yù)生成部分配置、注入密鑰等。它的返回值會(huì)被自動(dòng)合并進(jìn)全局配置// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onConfigLoad(): Promisevoid { // 直接返回?cái)?shù)據(jù)會(huì)自動(dòng)合并到配置中 return { test: 1 } } }此時(shí)在其他類中通過Config拿到的配置就包含了這段返回的數(shù)據(jù)例如Config(test)即可獲取到1。這種異步初始化配置的更多玩法可參考 異步初始化配置 章節(jié)。從源碼角度印證MidwayLifeCycleService在調(diào)用onConfigLoad時(shí)設(shè)置了resultHandler將每個(gè)配置類返回的非空數(shù)據(jù)通過configService.addObject(configData)合并到配置服務(wù)中見 lifeCycleService.ts。因此返回值的結(jié)構(gòu)會(huì)作為配置對(duì)象的一部分直接暴露給Config注入。onReady容器就緒后的主要初始化入口onReady是大部分場景下都會(huì)使用到的生命周期。:::info 注意這里的 ready 指的是依賴注入容器 ready并不是應(yīng)用 ready所以你可以對(duì)應(yīng)用做任意擴(kuò)展比如添加中間件、連接數(shù)據(jù)庫等。 :::典型場景在初始化時(shí)提前連接數(shù)據(jù)庫。由于配置類本身也是由容器管理的對(duì)象因此可以在其中通過Inject裝飾器注入數(shù)據(jù)庫連接工具類該實(shí)例包含connect和close兩個(gè)函數(shù)// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { Inject() db: any; async onReady(container: IMidwayContainer): Promisevoid { // 建立數(shù)據(jù)庫連接 await this.db.connect(); } async onStop(): Promisevoid { // 關(guān)閉數(shù)據(jù)庫連接 await this.db.close(); } }這樣我們就能在應(yīng)用啟動(dòng)時(shí)建立數(shù)據(jù)庫連接而不是在請(qǐng)求響應(yīng)時(shí)再去創(chuàng)建同時(shí)在應(yīng)用停止時(shí)也能優(yōu)雅地關(guān)閉數(shù)據(jù)庫連接避免連接泄漏。通過 registerObject 擴(kuò)充注入對(duì)象除了消費(fèi)容器中已有的對(duì)象onReady階段還可以對(duì)默認(rèn)注入的對(duì)象做擴(kuò)充將三方包、外部實(shí)例注冊進(jìn)容器之后在任何類中都可以直接注入使用。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; import * as sequelize from sequelize; Configuration() export class MainConfiguration implements ILifeCycle { async onReady(container: IMidwayContainer): Promisevoid { // 三方包對(duì)象 container.registerObject(sequelize, sequelize); } }在其他的類中可以直接注入使用export class IndexHandler { Inject() sequelize; async handler() { console.log(this.sequelize); } }這里container.registerObject注冊的對(duì)象與Provide()創(chuàng)建的對(duì)象一樣都遵循容器的依賴注入規(guī)則任何通過Inject聲明同名標(biāo)識(shí)符的類都能拿到該實(shí)例。onServerReady獲取 server 與服務(wù)端口當(dāng)需要獲取框架的服務(wù)對(duì)象、端口等信息時(shí)就需要用到onServerReady。因?yàn)榇藭r(shí)框架已完成啟動(dòng)frameworkService.runFramework()已執(zhí)行完畢server 實(shí)例已經(jīng)可用。以midwayjs/koa為例在啟動(dòng)時(shí)獲取它的 Server// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; import * as koa from midwayjs/koa; Configuration({ imports: [koa] }) export class MainConfiguration implements ILifeCycle { async onServerReady(container: IMidwayContainer): Promisevoid { // 獲取到 koa 中暴露的 Framework const framework await container.getAsync(koa.Framework); const server framework.getServer(); // ... } }這里的關(guān)鍵在于container.getAsync(koa.Framework)midwayjs/koa包導(dǎo)出的Framework類已被注冊進(jìn)依賴注入容器異步獲取其單例后即可通過framework.getServer()拿到底層 HTTP Server進(jìn)而讀取監(jiān)聽端口、注冊服務(wù)端事件或做端口相關(guān)操作。倉庫測試夾具 base-app-object-lifecycle/src/configuration.ts 也演示了在onServerReady中通過App()拿到應(yīng)用實(shí)例并設(shè)置屬性的用法。onStop優(yōu)雅清理資源應(yīng)用即將關(guān)閉時(shí)onStop會(huì)被執(zhí)行適合清理資源比如關(guān)閉數(shù)據(jù)庫連接、斷開消息隊(duì)列、釋放定時(shí)器等。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; import * as koa from midwayjs/koa; Configuration({ imports: [koa] }) export class MainConfiguration implements ILifeCycle { Inject() db: any; async onReady(container: IMidwayContainer): Promisevoid { // 建立數(shù)據(jù)庫連接 await this.db.connect(); } async onStop(): Promisevoid { // 關(guān)閉數(shù)據(jù)庫連接 await this.db.close(); } }onHealthCheck健康檢查上報(bào)當(dāng)內(nèi)置的健康檢查服務(wù)調(diào)用狀態(tài)獲取 API 時(shí)所有組件的onHealthCheck方法都會(huì)被自動(dòng)執(zhí)行。每個(gè)組件可以在該方法中探測自己依賴的狀態(tài)數(shù)據(jù)庫、緩存、外部服務(wù)等并返回統(tǒng)一的HealthResult結(jié)構(gòu)。下面模擬了一個(gè) db 健康檢查的方法// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, HealthResult } from midwayjs/core; Configuration({ namespace: db }) export class MainConfiguration implements ILifeCycle { Inject() db: any; async onReady(container: IMidwayContainer): Promisevoid { await this.db.connect(); } async onHealthCheck(): PromiseHealthResult { try { const result await this.db.isConnect(); if (result) { return { status: true, }; } else { return { status: false, reason: db is disconnect, }; } } catch (err) { return { status: false, reason: err.message, }; } } }上述onHealthCheck中調(diào)用了一個(gè)isConnect的狀態(tài)檢查根據(jù)結(jié)果返回了固定的HealthResult類型格式。HealthResult 與聚合結(jié)果HealthResult的定義位于 interface.ts必須包含status: boolean可選包含reason?: string失敗原因。所有組件的檢查結(jié)果會(huì)由MidwayHealthService.getStatus()聚合成HealthResultsstatus整體狀態(tài)只要存在任一失敗的組件即為falsenamespace第一個(gè)失敗組件的命名空間reason第一個(gè)失敗原因results每個(gè)組件的獨(dú)立檢查結(jié)果數(shù)組。從 healthService.ts 的實(shí)現(xiàn)可以看到兩個(gè)強(qiáng)約束若某個(gè)onHealthCheck的返回值不是包含status字段的對(duì)象該組件會(huì)被記為status: false并提示configuration.onHealthCheck return value must be object and contain status field若方法拋錯(cuò)或超時(shí)則捕獲異常并將reason記為錯(cuò)誤信息。這些行為在倉庫測試 feature.test.ts 中均有對(duì)應(yīng)的斷言驗(yàn)證。健康檢查的注意事項(xiàng)注意外部調(diào)用onHealthCheck可能會(huì)非常頻繁請(qǐng)盡可能保持檢查邏輯的可靠性和效率確保不會(huì)對(duì)檢查依賴有較大的壓力。同時(shí)請(qǐng)自行處理檢查超時(shí)后資源釋放的邏輯避免資源頻繁請(qǐng)求卻未返回結(jié)果導(dǎo)致內(nèi)存泄露的風(fēng)險(xiǎn)。例如在探測遠(yuǎn)端服務(wù)時(shí)應(yīng)給探測請(qǐng)求自身設(shè)置合理的超時(shí)時(shí)間并在 catch 中兜底返回status: false。全局對(duì)象生命周期所謂對(duì)象生命周期指的是每個(gè)對(duì)象在依賴注入容器中創(chuàng)建、銷毀的事件。通過這些生命周期我們可以在對(duì)象創(chuàng)建后、銷毀時(shí)做一些統(tǒng)一操作例如給所有業(yè)務(wù)對(duì)象附加通用屬性、統(tǒng)一替換對(duì)象、執(zhí)行通用的初始化或清理邏輯。export interface IObjectLifeCycle { onBeforeObjectCreated(/**...**/); onObjectCreated(/**...**/); onObjectInit(/**...**/); onBeforeObjectDestroy(/**...**/); }ILifeCycle定義中已經(jīng)包含了這些階段ILifeCycle extends PartialIObjectLifeCycle所以直接在配置類中實(shí)現(xiàn)對(duì)應(yīng)方法即可。:::caution 注意對(duì)象生命周期 API 會(huì)影響整個(gè)依賴注入容器以及業(yè)務(wù)的使用請(qǐng)謹(jǐn)慎操作。 :::完整接口見 interface.ts包含onBeforeBind、onBeforeObjectCreated、onObjectCreated、onObjectInit、onBeforeObjectDestroy五個(gè)階段。需要強(qiáng)調(diào)的是這些鉤子對(duì)容器中每一個(gè)對(duì)象生效屬于全局?jǐn)r截因此使用時(shí)要特別小心避免影響框架內(nèi)部對(duì)象或產(chǎn)生意外的副作用。onBeforeObjectCreated實(shí)例創(chuàng)建前在業(yè)務(wù)對(duì)象實(shí)例創(chuàng)建前執(zhí)行。注意框架內(nèi)部的某些對(duì)象由于已經(jīng)初始化無法被攔截。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectBeforeCreatedOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onBeforeObjectCreated(Clzz: new (...args), options: ObjectBeforeCreatedOptions): Promisevoid { // ... } }這里入?yún)⒂袃蓚€(gè)參數(shù)Clzz當(dāng)前待創(chuàng)建對(duì)象的原型類options一些參數(shù)參數(shù)如下:屬性類型描述options.contextIMidwayContainer依賴注入容器本身options.definitionIObjectDefinition對(duì)象定義options.constructorArgsany[]構(gòu)造器入?yún)nObjectCreated實(shí)例創(chuàng)建后可替換對(duì)象在對(duì)象實(shí)例創(chuàng)建后執(zhí)行這個(gè)階段可以替換創(chuàng)建的對(duì)象也可以給對(duì)象附加屬性。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectCreatedOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onObjectCreated(ins: any, options: ObjectCreatedOptions): Promisevoid { // ... } }這里入?yún)⒂袃蓚€(gè)參數(shù)ins當(dāng)前通過構(gòu)建器創(chuàng)出來的對(duì)象options一些參數(shù)參數(shù)如下:屬性類型描述options.contextIMidwayContainer依賴注入容器本身options.definitionIObjectDefinition對(duì)象定義options.replaceCallback(ins: any) void對(duì)象替換的回調(diào)方法示例動(dòng)態(tài)添加屬性// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectInitOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onObjectCreated(ins: any, options: ObjectInitOptions): Promisevoid { // 每個(gè)創(chuàng)建的對(duì)象都會(huì)添加一個(gè) _name 的屬性 ins._name xxxx; // ... } }示例替換對(duì)象// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectInitOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onObjectCreated(ins: any, options: ObjectInitOptions): Promisevoid { // 之后每個(gè)創(chuàng)建的對(duì)象都會(huì)被替換為 { bbb: aaa } options.replaceCallback({ bbb: aaa }); // ... } }第二個(gè)示例中replaceCallback是對(duì)象替換的關(guān)鍵一旦調(diào)用容器后續(xù)向消費(fèi)者提供的將是替換后的新對(duì)象。這種機(jī)制常被用于 AOP、代理包裝等場景但因?yàn)橛绊懨媸侨值膭?wù)必確認(rèn)替換邏輯對(duì)所有業(yè)務(wù)對(duì)象都安全。onObjectInit異步初始化完成后在對(duì)象實(shí)例創(chuàng)建后執(zhí)行異步初始化方法后執(zhí)行即在對(duì)象執(zhí)行完Init()標(biāo)記的初始化方法之后觸發(fā)。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectInitOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onObjectInit(ins: any, options: ObjectInitOptions): Promisevoid { // ... } }這里入?yún)⒂袃蓚€(gè)參數(shù)ins當(dāng)前通過構(gòu)建器創(chuàng)出來的對(duì)象options一些參數(shù)參數(shù)如下:屬性類型描述options.contextIMidwayContainer依賴注入容器本身options.definitionIObjectDefinition對(duì)象定義:::info 在這個(gè)階段也可以動(dòng)態(tài)給對(duì)象附加屬性、方法等和onObjectCreated的區(qū)別是這個(gè)階段是在初始化方法執(zhí)行之后。 :::onBeforeObjectDestroy對(duì)象銷毀前在對(duì)象實(shí)例銷毀前執(zhí)行適合做對(duì)象級(jí)別的資源清理。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectBeforeDestroyOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onBeforeObjectDestroy(ins: any, options: ObjectBeforeDestroyOptions): Promisevoid { // ... } }這里入?yún)⒂袃蓚€(gè)參數(shù)ins當(dāng)前通過構(gòu)建器創(chuàng)出來的對(duì)象options一些參數(shù)參數(shù)如下:屬性類型描述options.contextIMidwayContainer依賴注入容器本身options.definitionIObjectDefinition對(duì)象定義超時(shí)機(jī)制從 v4 開始框架內(nèi)置了超時(shí)機(jī)制防止某些生命周期函數(shù)阻塞應(yīng)用啟動(dòng)。每個(gè)生命周期鉤子都會(huì)在設(shè)定的時(shí)間內(nèi)執(zhí)行超時(shí)后由框架中斷并記錄避免單個(gè)卡死的初始化邏輯拖垮整個(gè)應(yīng)用的啟動(dòng)/停止流程。默認(rèn)超時(shí)時(shí)間不同生命周期方法有不同的默認(rèn)超時(shí)時(shí)間生命周期方法默認(rèn)超時(shí)時(shí)間配置項(xiàng)說明onConfigLoad10 秒core.configLoadTimeout配置加載階段onReady30 秒core.readyTimeout容器準(zhǔn)備階段onServerReady30 秒core.serverReadyTimeout服務(wù)啟動(dòng)階段onStop默認(rèn)無限制core.stopTimeout應(yīng)用停止階段onHealthCheck1 秒core.healthCheckTimeout健康檢查階段這些默認(rèn)值與倉庫 config.default.ts 中的實(shí)際配置一一對(duì)應(yīng)healthCheckTimeout: 1_000、configLoadTimeout: 10_000、readyTimeout: 30_000、serverReadyTimeout: 30_000?？梢钥吹絪topTimeout并未設(shè)置默認(rèn)值因此在未配置時(shí)onStop不設(shè)超時(shí)上限如果希望停止階段也有保護(hù)可以主動(dòng)配置該項(xiàng)。自定義超時(shí)時(shí)間可以通過配置修改每個(gè)生命周期的超時(shí)時(shí)間:::tip 注意這個(gè)配置是全局的。 :::// src/config/config.default.ts export default { core: { // 配置加載超時(shí)毫秒 configLoadTimeout: 15_000, // 15秒 } } as MidwayConfig;單位是毫秒。同理可配置core.readyTimeout、core.serverReadyTimeout、core.healthCheckTimeout與core.stopTimeout。這些值在運(yùn)行時(shí)由MidwayLifeCycleService通過configService.getConfiguration(core.xxxTimeout)讀取見 lifeCycleService.ts并配合createPromiseTimeoutInvokeChain實(shí)現(xiàn)超時(shí)中斷與錯(cuò)誤記錄。在生命周期中處理超時(shí)在生命周期方法中可以通過第三個(gè)入?yún)@取到當(dāng)前的超時(shí)配置以及中斷信號(hào)從而在超時(shí)前主動(dòng)感知并做兜底處理Configuration() export class MainConfiguration implements ILifeCycle { async onReady(container: IMidwayContainer, app: IMidwayApplication, options: { timeout?: number; abortController?: AbortController; }): Promisevoid { // 可以獲取到超時(shí)配置 console.log(當(dāng)前超時(shí)配置:, options.timeout); // 30000 // 可以監(jiān)聽中斷信號(hào) if (options.abortController) { options.abortController.signal.addEventListener(abort, () { console.log(生命周期被中斷); }); } // 執(zhí)行初始化邏輯 await this.initializeServices(); } }options.timeout即當(dāng)前生命周期方法對(duì)應(yīng)的超時(shí)毫秒數(shù)如onReady默認(rèn) 30000options.abortController則攜帶中斷信號(hào)。當(dāng)執(zhí)行超過時(shí)限時(shí)框架會(huì)觸發(fā)abort你可以在監(jiān)聽回調(diào)中做日志記錄、資源釋放等收尾工作。這在初始化依賴外部服務(wù)、網(wǎng)絡(luò)不確定的場景下尤為重要——即使初始化被中斷也能保證已占用的資源不被泄漏。小結(jié)與推薦實(shí)踐結(jié)合倉庫源碼與文檔可以總結(jié)出幾條實(shí)戰(zhàn)建議初始化時(shí)機(jī)選擇修改/補(bǔ)充配置用onConfigLoad依賴注入容器內(nèi)的初始化連數(shù)據(jù)庫、注冊對(duì)象、加中間件用onReady需要拿 server、端口時(shí)用onServerReady關(guān)閉連接、釋放資源用onStop。健康檢查要輕量onHealthCheck會(huì)被健康檢查 API 頻繁調(diào)用且默認(rèn)超時(shí)僅 1 秒務(wù)必保持探測邏輯高效并對(duì)超時(shí)與異常做好兜底返回合法的HealthResult必須含status字段。對(duì)象生命周期慎用onObjectCreated、onObjectInit等鉤子作用于容器內(nèi)所有對(duì)象適合做全局屬性注入、代理替換但要評(píng)估對(duì)業(yè)務(wù)與框架內(nèi)部對(duì)象的影響。善用超時(shí)保護(hù)為長耗時(shí)的初始化配置合理的core.*Timeout并在生命周期內(nèi)監(jiān)聽abortController信號(hào)完成資源釋放避免啟動(dòng)被阻塞或資源泄漏。如需繼續(xù)深入可在倉庫中查看生命周期服務(wù)的完整實(shí)現(xiàn) lifeCycleService.ts、健康檢查服務(wù) healthService.ts、生命周期接口定義 interface.ts 以及對(duì)應(yīng)的測試夾具 base-app-object-lifecycle/src/configuration.ts 與 app-with-health-check/src/configuration.ts。贊分享后端微服務(wù)云原生【免費(fèi)下載鏈接】midway A Node.js Serverless Framework for front-end/full-stack developers. Build the application for next decade. Works on AWS, Alibaba Cloud, Tencent Cloud and traditional VM/Container. Super easy integrate with React and Vue. 項(xiàng)目地址https://gitcode.com/gh_mirrors/mi/midway點(diǎn)擊查看免費(fèi)下載相關(guān)推薦Chainlit 生命周期鉤子應(yīng)用啟動(dòng)與關(guān)閉事件處理Chainlit 生命周期鉤子應(yīng)用啟動(dòng)與關(guān)閉事件處理 你是否在開發(fā) Python LLM 應(yīng)用時(shí)遇到過資源管理難題啟動(dòng)時(shí)需要初始化模型關(guān)閉時(shí)必須釋放連接人工智能大模型AI 應(yīng)用后端前端python-diskcache核心API詳解Cache、FanoutCache和DjangoCache的完整使用教程python diskcache核心API詳解Cache、FanoutCache和DjangoCache的完整使用教程 python diskcache是一個(gè)后端ttf-parser實(shí)戰(zhàn)構(gòu)建自定義字體渲染引擎的10個(gè)步驟ttf parser實(shí)戰(zhàn)構(gòu)建自定義字體渲染引擎的10個(gè)步驟 ttf parser是一個(gè)高級(jí)、安全且零分配的TrueType字體解析器它為開發(fā)者提供了強(qiáng)大的字上一篇AutoTrain Advanced圖像分割評(píng)估指標(biāo)mIoU與Dice系數(shù)詳解下一篇Markdown 新標(biāo)簽頁插件使用指南創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考 Midway 生命周期指南：從配置加載到優(yōu)雅關(guān)閉的完整實(shí)踐
后端微服務(wù)云原生【免費(fèi)下載鏈接】midway A Node.js Serverless Framework for front-end/full-stack developers. Build the application for next decade. Works on AWS, Alibaba Cloud, Tencent Cloud and traditional VM/Container. Super easy integrate with React and Vue. 項(xiàng)目地址https://gitcode.com/gh_mirrors/mi/midway點(diǎn)擊查看免費(fèi)下載在 Node.js 服務(wù)端應(yīng)用中數(shù)據(jù)庫連接、配置預(yù)生成、資源清理這類操作理應(yīng)發(fā)生在應(yīng)用啟動(dòng)與停止的特定階段而不是在請(qǐng)求響應(yīng)中重復(fù)處理。Midway 為此內(nèi)置了一套完整的生命周期機(jī)制你只需在src/configuration.ts中實(shí)現(xiàn)ILifeCycle接口框架就會(huì)在啟動(dòng)、就緒、服務(wù)啟動(dòng)、關(guān)閉等關(guān)鍵節(jié)點(diǎn)自動(dòng)調(diào)用對(duì)應(yīng)方法。讀完本文你將掌握 Midway 項(xiàng)目生命周期與對(duì)象生命周期的全部鉤子函數(shù)、其底層執(zhí)行順序與超時(shí)機(jī)制并能在真實(shí)項(xiàng)目中完成連接建立、對(duì)象擴(kuò)充、健康檢查與優(yōu)雅關(guān)閉的落地。項(xiàng)目生命周期概覽Midway 為開發(fā)人員提供了四個(gè)項(xiàng)目級(jí)生命周期函數(shù)分別對(duì)應(yīng)應(yīng)用運(yùn)行的不同階段onConfigLoad配置文件加載階段可以在這里修改、補(bǔ)充配置onReady依賴注入容器準(zhǔn)備完畢可以在這個(gè)階段做大部分初始化事情onServerReady服務(wù)啟動(dòng)完成此時(shí)可以拿到 server 與端口信息onStop應(yīng)用即將關(guān)閉在這里清理資源onHealthCheck可選補(bǔ)充在健康檢查被調(diào)用時(shí)執(zhí)行用于上報(bào)組件/依賴的健康狀態(tài)。這些鉤子通過項(xiàng)目根目錄下的src/configuration.ts文件實(shí)現(xiàn)ILifeCycle接口即可被框架在啟動(dòng)時(shí)自動(dòng)加載。接口的完整定義如下與倉庫源碼 interface.ts 中ILifeCycle的定義保持一致interface ILifeCycle { /** * 在應(yīng)用配置加載后執(zhí)行 */ onConfigLoad?(container: IMidwayContainer, app: IMidwayApplication): Promisevoid; /** * 在依賴注入容器 ready 的時(shí)候執(zhí)行 */ onReady(container: IMidwayContainer, app: IMidwayApplication): Promisevoid; /** * 在應(yīng)用服務(wù)啟動(dòng)后執(zhí)行 */ onServerReady?(container: IMidwayContainer, app: IMidwayApplication): Promisevoid; /** * 在應(yīng)用停止的時(shí)候執(zhí)行 */ onStop?(container: IMidwayContainer, app: IMidwayApplication): Promisevoid; /** * 在健康檢查時(shí)執(zhí)行 */ onHealthCheck?(container: IMidwayContainer): PromiseHealthResult; }從源碼實(shí)現(xiàn)看每個(gè)鉤子函數(shù)實(shí)際上還會(huì)接收到第三個(gè)參數(shù)options: LifeCycleInvokeOptions其中包含timeout當(dāng)前生命周期超時(shí)配置與abortController中斷信號(hào)這在后文超時(shí)機(jī)制一節(jié)會(huì)詳細(xì)展開。底層執(zhí)行順序生命周期方法并非并行執(zhí)行而是由框架的MidwayLifeCycleService按嚴(yán)格順序調(diào)度。在 lifeCycleService.ts 中可以清晰看到完整執(zhí)行鏈掃描所有Configuration()修飾的類創(chuàng)建實(shí)例并收集為生命周期實(shí)例列表并行綁定四類對(duì)象生命周期鉤子onBeforeObjectCreated/onObjectCreated/onObjectInit/onBeforeObjectDestroy依次執(zhí)行所有配置類的onConfigLoad()返回的數(shù)據(jù)通過configService.addObject()合并進(jìn)配置依次執(zhí)行onReady()調(diào)用frameworkService.runFramework()啟動(dòng)框架此時(shí)監(jiān)聽端口、啟動(dòng) server依次執(zhí)行onServerReady()。而在應(yīng)用停止時(shí)stop 方法會(huì)先將生命周期實(shí)例列表倒序后依次執(zhí)行onStop()再停止框架。也就是說onStop的執(zhí)行順序與啟動(dòng)階段相反后初始化的組件會(huì)先被清理從而保證資源釋放的對(duì)稱性。onConfigLoad啟動(dòng)時(shí)修改配置onConfigLoad一般用于修改項(xiàng)目的配置文件比如根據(jù)運(yùn)行時(shí)環(huán)境預(yù)生成部分配置、注入密鑰等。它的返回值會(huì)被自動(dòng)合并進(jìn)全局配置// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onConfigLoad(): Promisevoid { // 直接返回?cái)?shù)據(jù)會(huì)自動(dòng)合并到配置中 return { test: 1 } } }此時(shí)在其他類中通過Config拿到的配置就包含了這段返回的數(shù)據(jù)例如Config(test)即可獲取到1。這種異步初始化配置的更多玩法可參考 異步初始化配置 章節(jié)。從源碼角度印證MidwayLifeCycleService在調(diào)用onConfigLoad時(shí)設(shè)置了resultHandler將每個(gè)配置類返回的非空數(shù)據(jù)通過configService.addObject(configData)合并到配置服務(wù)中見 lifeCycleService.ts。因此返回值的結(jié)構(gòu)會(huì)作為配置對(duì)象的一部分直接暴露給Config注入。onReady容器就緒后的主要初始化入口onReady是大部分場景下都會(huì)使用到的生命周期。:::info 注意這里的 ready 指的是依賴注入容器 ready并不是應(yīng)用 ready所以你可以對(duì)應(yīng)用做任意擴(kuò)展比如添加中間件、連接數(shù)據(jù)庫等。 :::典型場景在初始化時(shí)提前連接數(shù)據(jù)庫。由于配置類本身也是由容器管理的對(duì)象因此可以在其中通過Inject裝飾器注入數(shù)據(jù)庫連接工具類該實(shí)例包含connect和close兩個(gè)函數(shù)// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { Inject() db: any; async onReady(container: IMidwayContainer): Promisevoid { // 建立數(shù)據(jù)庫連接 await this.db.connect(); } async onStop(): Promisevoid { // 關(guān)閉數(shù)據(jù)庫連接 await this.db.close(); } }這樣我們就能在應(yīng)用啟動(dòng)時(shí)建立數(shù)據(jù)庫連接而不是在請(qǐng)求響應(yīng)時(shí)再去創(chuàng)建同時(shí)在應(yīng)用停止時(shí)也能優(yōu)雅地關(guān)閉數(shù)據(jù)庫連接避免連接泄漏。通過 registerObject 擴(kuò)充注入對(duì)象除了消費(fèi)容器中已有的對(duì)象onReady階段還可以對(duì)默認(rèn)注入的對(duì)象做擴(kuò)充將三方包、外部實(shí)例注冊進(jìn)容器之后在任何類中都可以直接注入使用。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; import * as sequelize from sequelize; Configuration() export class MainConfiguration implements ILifeCycle { async onReady(container: IMidwayContainer): Promisevoid { // 三方包對(duì)象 container.registerObject(sequelize, sequelize); } }在其他的類中可以直接注入使用export class IndexHandler { Inject() sequelize; async handler() { console.log(this.sequelize); } }這里container.registerObject注冊的對(duì)象與Provide()創(chuàng)建的對(duì)象一樣都遵循容器的依賴注入規(guī)則任何通過Inject聲明同名標(biāo)識(shí)符的類都能拿到該實(shí)例。onServerReady獲取 server 與服務(wù)端口當(dāng)需要獲取框架的服務(wù)對(duì)象、端口等信息時(shí)就需要用到onServerReady。因?yàn)榇藭r(shí)框架已完成啟動(dòng)frameworkService.runFramework()已執(zhí)行完畢server 實(shí)例已經(jīng)可用。以midwayjs/koa為例在啟動(dòng)時(shí)獲取它的 Server// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; import * as koa from midwayjs/koa; Configuration({ imports: [koa] }) export class MainConfiguration implements ILifeCycle { async onServerReady(container: IMidwayContainer): Promisevoid { // 獲取到 koa 中暴露的 Framework const framework await container.getAsync(koa.Framework); const server framework.getServer(); // ... } }這里的關(guān)鍵在于container.getAsync(koa.Framework)midwayjs/koa包導(dǎo)出的Framework類已被注冊進(jìn)依賴注入容器異步獲取其單例后即可通過framework.getServer()拿到底層 HTTP Server進(jìn)而讀取監(jiān)聽端口、注冊服務(wù)端事件或做端口相關(guān)操作。倉庫測試夾具 base-app-object-lifecycle/src/configuration.ts 也演示了在onServerReady中通過App()拿到應(yīng)用實(shí)例并設(shè)置屬性的用法。onStop優(yōu)雅清理資源應(yīng)用即將關(guān)閉時(shí)onStop會(huì)被執(zhí)行適合清理資源比如關(guān)閉數(shù)據(jù)庫連接、斷開消息隊(duì)列、釋放定時(shí)器等。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer } from midwayjs/core; import * as koa from midwayjs/koa; Configuration({ imports: [koa] }) export class MainConfiguration implements ILifeCycle { Inject() db: any; async onReady(container: IMidwayContainer): Promisevoid { // 建立數(shù)據(jù)庫連接 await this.db.connect(); } async onStop(): Promisevoid { // 關(guān)閉數(shù)據(jù)庫連接 await this.db.close(); } }onHealthCheck健康檢查上報(bào)當(dāng)內(nèi)置的健康檢查服務(wù)調(diào)用狀態(tài)獲取 API 時(shí)所有組件的onHealthCheck方法都會(huì)被自動(dòng)執(zhí)行。每個(gè)組件可以在該方法中探測自己依賴的狀態(tài)數(shù)據(jù)庫、緩存、外部服務(wù)等并返回統(tǒng)一的HealthResult結(jié)構(gòu)。下面模擬了一個(gè) db 健康檢查的方法// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, HealthResult } from midwayjs/core; Configuration({ namespace: db }) export class MainConfiguration implements ILifeCycle { Inject() db: any; async onReady(container: IMidwayContainer): Promisevoid { await this.db.connect(); } async onHealthCheck(): PromiseHealthResult { try { const result await this.db.isConnect(); if (result) { return { status: true, }; } else { return { status: false, reason: db is disconnect, }; } } catch (err) { return { status: false, reason: err.message, }; } } }上述onHealthCheck中調(diào)用了一個(gè)isConnect的狀態(tài)檢查根據(jù)結(jié)果返回了固定的HealthResult類型格式。HealthResult 與聚合結(jié)果HealthResult的定義位于 interface.ts必須包含status: boolean可選包含reason?: string失敗原因。所有組件的檢查結(jié)果會(huì)由MidwayHealthService.getStatus()聚合成HealthResultsstatus整體狀態(tài)只要存在任一失敗的組件即為falsenamespace第一個(gè)失敗組件的命名空間reason第一個(gè)失敗原因results每個(gè)組件的獨(dú)立檢查結(jié)果數(shù)組。從 healthService.ts 的實(shí)現(xiàn)可以看到兩個(gè)強(qiáng)約束若某個(gè)onHealthCheck的返回值不是包含status字段的對(duì)象該組件會(huì)被記為status: false并提示configuration.onHealthCheck return value must be object and contain status field若方法拋錯(cuò)或超時(shí)則捕獲異常并將reason記為錯(cuò)誤信息。這些行為在倉庫測試 feature.test.ts 中均有對(duì)應(yīng)的斷言驗(yàn)證。健康檢查的注意事項(xiàng)注意外部調(diào)用onHealthCheck可能會(huì)非常頻繁請(qǐng)盡可能保持檢查邏輯的可靠性和效率確保不會(huì)對(duì)檢查依賴有較大的壓力。同時(shí)請(qǐng)自行處理檢查超時(shí)后資源釋放的邏輯避免資源頻繁請(qǐng)求卻未返回結(jié)果導(dǎo)致內(nèi)存泄露的風(fēng)險(xiǎn)。例如在探測遠(yuǎn)端服務(wù)時(shí)應(yīng)給探測請(qǐng)求自身設(shè)置合理的超時(shí)時(shí)間并在 catch 中兜底返回status: false。全局對(duì)象生命周期所謂對(duì)象生命周期指的是每個(gè)對(duì)象在依賴注入容器中創(chuàng)建、銷毀的事件。通過這些生命周期我們可以在對(duì)象創(chuàng)建后、銷毀時(shí)做一些統(tǒng)一操作例如給所有業(yè)務(wù)對(duì)象附加通用屬性、統(tǒng)一替換對(duì)象、執(zhí)行通用的初始化或清理邏輯。export interface IObjectLifeCycle { onBeforeObjectCreated(/**...**/); onObjectCreated(/**...**/); onObjectInit(/**...**/); onBeforeObjectDestroy(/**...**/); }ILifeCycle定義中已經(jīng)包含了這些階段ILifeCycle extends PartialIObjectLifeCycle所以直接在配置類中實(shí)現(xiàn)對(duì)應(yīng)方法即可。:::caution 注意對(duì)象生命周期 API 會(huì)影響整個(gè)依賴注入容器以及業(yè)務(wù)的使用請(qǐng)謹(jǐn)慎操作。 :::完整接口見 interface.ts包含onBeforeBind、onBeforeObjectCreated、onObjectCreated、onObjectInit、onBeforeObjectDestroy五個(gè)階段。需要強(qiáng)調(diào)的是這些鉤子對(duì)容器中每一個(gè)對(duì)象生效屬于全局?jǐn)r截因此使用時(shí)要特別小心避免影響框架內(nèi)部對(duì)象或產(chǎn)生意外的副作用。onBeforeObjectCreated實(shí)例創(chuàng)建前在業(yè)務(wù)對(duì)象實(shí)例創(chuàng)建前執(zhí)行。注意框架內(nèi)部的某些對(duì)象由于已經(jīng)初始化無法被攔截。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectBeforeCreatedOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onBeforeObjectCreated(Clzz: new (...args), options: ObjectBeforeCreatedOptions): Promisevoid { // ... } }這里入?yún)⒂袃蓚€(gè)參數(shù)Clzz當(dāng)前待創(chuàng)建對(duì)象的原型類options一些參數(shù)參數(shù)如下:屬性類型描述options.contextIMidwayContainer依賴注入容器本身options.definitionIObjectDefinition對(duì)象定義options.constructorArgsany[]構(gòu)造器入?yún)nObjectCreated實(shí)例創(chuàng)建后可替換對(duì)象在對(duì)象實(shí)例創(chuàng)建后執(zhí)行這個(gè)階段可以替換創(chuàng)建的對(duì)象也可以給對(duì)象附加屬性。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectCreatedOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onObjectCreated(ins: any, options: ObjectCreatedOptions): Promisevoid { // ... } }這里入?yún)⒂袃蓚€(gè)參數(shù)ins當(dāng)前通過構(gòu)建器創(chuàng)出來的對(duì)象options一些參數(shù)參數(shù)如下:屬性類型描述options.contextIMidwayContainer依賴注入容器本身options.definitionIObjectDefinition對(duì)象定義options.replaceCallback(ins: any) void對(duì)象替換的回調(diào)方法示例動(dòng)態(tài)添加屬性// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectInitOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onObjectCreated(ins: any, options: ObjectInitOptions): Promisevoid { // 每個(gè)創(chuàng)建的對(duì)象都會(huì)添加一個(gè) _name 的屬性 ins._name xxxx; // ... } }示例替換對(duì)象// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectInitOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onObjectCreated(ins: any, options: ObjectInitOptions): Promisevoid { // 之后每個(gè)創(chuàng)建的對(duì)象都會(huì)被替換為 { bbb: aaa } options.replaceCallback({ bbb: aaa }); // ... } }第二個(gè)示例中replaceCallback是對(duì)象替換的關(guān)鍵一旦調(diào)用容器后續(xù)向消費(fèi)者提供的將是替換后的新對(duì)象。這種機(jī)制常被用于 AOP、代理包裝等場景但因?yàn)橛绊懨媸侨值膭?wù)必確認(rèn)替換邏輯對(duì)所有業(yè)務(wù)對(duì)象都安全。onObjectInit異步初始化完成后在對(duì)象實(shí)例創(chuàng)建后執(zhí)行異步初始化方法后執(zhí)行即在對(duì)象執(zhí)行完Init()標(biāo)記的初始化方法之后觸發(fā)。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectInitOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onObjectInit(ins: any, options: ObjectInitOptions): Promisevoid { // ... } }這里入?yún)⒂袃蓚€(gè)參數(shù)ins當(dāng)前通過構(gòu)建器創(chuàng)出來的對(duì)象options一些參數(shù)參數(shù)如下:屬性類型描述options.contextIMidwayContainer依賴注入容器本身options.definitionIObjectDefinition對(duì)象定義:::info 在這個(gè)階段也可以動(dòng)態(tài)給對(duì)象附加屬性、方法等和onObjectCreated的區(qū)別是這個(gè)階段是在初始化方法執(zhí)行之后。 :::onBeforeObjectDestroy對(duì)象銷毀前在對(duì)象實(shí)例銷毀前執(zhí)行適合做對(duì)象級(jí)別的資源清理。// src/configuration.ts import { Configuration, ILifeCycle, IMidwayContainer, ObjectBeforeDestroyOptions } from midwayjs/core; Configuration() export class MainConfiguration implements ILifeCycle { async onBeforeObjectDestroy(ins: any, options: ObjectBeforeDestroyOptions): Promisevoid { // ... } }這里入?yún)⒂袃蓚€(gè)參數(shù)ins當(dāng)前通過構(gòu)建器創(chuàng)出來的對(duì)象options一些參數(shù)參數(shù)如下:屬性類型描述options.contextIMidwayContainer依賴注入容器本身options.definitionIObjectDefinition對(duì)象定義超時(shí)機(jī)制從 v4 開始框架內(nèi)置了超時(shí)機(jī)制防止某些生命周期函數(shù)阻塞應(yīng)用啟動(dòng)。每個(gè)生命周期鉤子都會(huì)在設(shè)定的時(shí)間內(nèi)執(zhí)行超時(shí)后由框架中斷并記錄避免單個(gè)卡死的初始化邏輯拖垮整個(gè)應(yīng)用的啟動(dòng)/停止流程。默認(rèn)超時(shí)時(shí)間不同生命周期方法有不同的默認(rèn)超時(shí)時(shí)間生命周期方法默認(rèn)超時(shí)時(shí)間配置項(xiàng)說明onConfigLoad10 秒core.configLoadTimeout配置加載階段onReady30 秒core.readyTimeout容器準(zhǔn)備階段onServerReady30 秒core.serverReadyTimeout服務(wù)啟動(dòng)階段onStop默認(rèn)無限制core.stopTimeout應(yīng)用停止階段onHealthCheck1 秒core.healthCheckTimeout健康檢查階段這些默認(rèn)值與倉庫 config.default.ts 中的實(shí)際配置一一對(duì)應(yīng)healthCheckTimeout: 1_000、configLoadTimeout: 10_000、readyTimeout: 30_000、serverReadyTimeout: 30_000?？梢钥吹絪topTimeout并未設(shè)置默認(rèn)值因此在未配置時(shí)onStop不設(shè)超時(shí)上限如果希望停止階段也有保護(hù)可以主動(dòng)配置該項(xiàng)。自定義超時(shí)時(shí)間可以通過配置修改每個(gè)生命周期的超時(shí)時(shí)間:::tip 注意這個(gè)配置是全局的。 :::// src/config/config.default.ts export default { core: { // 配置加載超時(shí)毫秒 configLoadTimeout: 15_000, // 15秒 } } as MidwayConfig;單位是毫秒。同理可配置core.readyTimeout、core.serverReadyTimeout、core.healthCheckTimeout與core.stopTimeout。這些值在運(yùn)行時(shí)由MidwayLifeCycleService通過configService.getConfiguration(core.xxxTimeout)讀取見 lifeCycleService.ts并配合createPromiseTimeoutInvokeChain實(shí)現(xiàn)超時(shí)中斷與錯(cuò)誤記錄。在生命周期中處理超時(shí)在生命周期方法中可以通過第三個(gè)入?yún)@取到當(dāng)前的超時(shí)配置以及中斷信號(hào)從而在超時(shí)前主動(dòng)感知并做兜底處理Configuration() export class MainConfiguration implements ILifeCycle { async onReady(container: IMidwayContainer, app: IMidwayApplication, options: { timeout?: number; abortController?: AbortController; }): Promisevoid { // 可以獲取到超時(shí)配置 console.log(當(dāng)前超時(shí)配置:, options.timeout); // 30000 // 可以監(jiān)聽中斷信號(hào) if (options.abortController) { options.abortController.signal.addEventListener(abort, () { console.log(生命周期被中斷); }); } // 執(zhí)行初始化邏輯 await this.initializeServices(); } }options.timeout即當(dāng)前生命周期方法對(duì)應(yīng)的超時(shí)毫秒數(shù)如onReady默認(rèn) 30000options.abortController則攜帶中斷信號(hào)。當(dāng)執(zhí)行超過時(shí)限時(shí)框架會(huì)觸發(fā)abort你可以在監(jiān)聽回調(diào)中做日志記錄、資源釋放等收尾工作。這在初始化依賴外部服務(wù)、網(wǎng)絡(luò)不確定的場景下尤為重要——即使初始化被中斷也能保證已占用的資源不被泄漏。小結(jié)與推薦實(shí)踐結(jié)合倉庫源碼與文檔可以總結(jié)出幾條實(shí)戰(zhàn)建議初始化時(shí)機(jī)選擇修改/補(bǔ)充配置用onConfigLoad依賴注入容器內(nèi)的初始化連數(shù)據(jù)庫、注冊對(duì)象、加中間件用onReady需要拿 server、端口時(shí)用onServerReady關(guān)閉連接、釋放資源用onStop。健康檢查要輕量onHealthCheck會(huì)被健康檢查 API 頻繁調(diào)用且默認(rèn)超時(shí)僅 1 秒務(wù)必保持探測邏輯高效并對(duì)超時(shí)與異常做好兜底返回合法的HealthResult必須含status字段。對(duì)象生命周期慎用onObjectCreated、onObjectInit等鉤子作用于容器內(nèi)所有對(duì)象適合做全局屬性注入、代理替換但要評(píng)估對(duì)業(yè)務(wù)與框架內(nèi)部對(duì)象的影響。善用超時(shí)保護(hù)為長耗時(shí)的初始化配置合理的core.*Timeout并在生命周期內(nèi)監(jiān)聽abortController信號(hào)完成資源釋放避免啟動(dòng)被阻塞或資源泄漏。如需繼續(xù)深入可在倉庫中查看生命周期服務(wù)的完整實(shí)現(xiàn) lifeCycleService.ts、健康檢查服務(wù) healthService.ts、生命周期接口定義 interface.ts 以及對(duì)應(yīng)的測試夾具 base-app-object-lifecycle/src/configuration.ts 與 app-with-health-check/src/configuration.ts。贊分享后端微服務(wù)云原生【免費(fèi)下載鏈接】midway A Node.js Serverless Framework for front-end/full-stack developers. Build the application for next decade. Works on AWS, Alibaba Cloud, Tencent Cloud and traditional VM/Container. Super easy integrate with React and Vue. 項(xiàng)目地址https://gitcode.com/gh_mirrors/mi/midway點(diǎn)擊查看免費(fèi)下載相關(guān)推薦Chainlit 生命周期鉤子應(yīng)用啟動(dòng)與關(guān)閉事件處理Chainlit 生命周期鉤子應(yīng)用啟動(dòng)與關(guān)閉事件處理 你是否在開發(fā) Python LLM 應(yīng)用時(shí)遇到過資源管理難題啟動(dòng)時(shí)需要初始化模型關(guān)閉時(shí)必須釋放連接人工智能大模型AI 應(yīng)用后端前端python-diskcache核心API詳解Cache、FanoutCache和DjangoCache的完整使用教程python diskcache核心API詳解Cache、FanoutCache和DjangoCache的完整使用教程 python diskcache是一個(gè)后端ttf-parser實(shí)戰(zhàn)構(gòu)建自定義字體渲染引擎的10個(gè)步驟ttf parser實(shí)戰(zhàn)構(gòu)建自定義字體渲染引擎的10個(gè)步驟 ttf parser是一個(gè)高級(jí)、安全且零分配的TrueType字體解析器它為開發(fā)者提供了強(qiáng)大的字上一篇AutoTrain Advanced圖像分割評(píng)估指標(biāo)mIoU與Dice系數(shù)詳解下一篇Markdown 新標(biāo)簽頁插件使用指南創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考