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