Node.js?網(wǎng)絡(luò)框架koa?compose中間件使用解析
前言
學(xué)習(xí)目標(biāo):
- koa-compose
- 洋蔥模型
源碼地址:koajs/compose
koa-compose
Koa-compose 是一個 Koa 中間件工具,Koa 是一個流行的 Node.js 網(wǎng)絡(luò)框架。Koa-compose 允許你將多個中間件函數(shù)組合成一個單獨(dú)的函數(shù),這樣可以更容易地管理和重用中間件。
在 Koa 中,中間件函數(shù)是按照特定順序調(diào)用的函數(shù),用于處理傳入的 HTTP 請求并生成響應(yīng)。中間件函數(shù)可以執(zhí)行各種任務(wù),例如解析請求主體、驗(yàn)證請求參數(shù)或與數(shù)據(jù)庫交互。
中間件的簡單示例:
// sendHandle.js const sendHandle = () => { // 處理請求成功方法 const render = ctx => { return (data, msg = '請求成功') => { ctx.set('Content-Type', 'application/json'); ctx.body = { code: '000001', data, msg } } } // 處理請求失敗方法 const renderError = ctx => { return (code, msg = '請求失敗') => { ctx.set('Content-Type', 'application/json'); ctx.body = { code, data: null, msg } } } return async (ctx, next) => { ctx.send = render(ctx); ctx.sendError = renderError(ctx); await next(); } } module.exports = sendHandle;
然后在app.js 中引用,如圖
上面中間件的作用是處理請求的結(jié)果。
詳細(xì)代碼可以參考,codeniu/niu-box ,這是一個 koa 小項目。
洋蔥模型
洋蔥模型是一種用于解釋中間件的架構(gòu)模型。它描述了中間件的工作方式,以及中間件如何在處理請求和生成響應(yīng)時與其他中間件協(xié)同工作。
在洋蔥模型中,中間件被描述為一個可以包裝在外層的函數(shù)。每個中間件函數(shù)都可以在接收到請求時執(zhí)行一些操作,然后將請求傳遞給內(nèi)層的中間件函數(shù)。當(dāng)內(nèi)層的中間件函數(shù)完成工作并返回響應(yīng)時,外層的中間件函數(shù)可以再次執(zhí)行一些操作,然后將響應(yīng)返回給客戶端。
源碼解析
'use strict' /** * Expose compositor. */ module.exports = compose /** * Compose `middleware` returning * a fully valid middleware comprised * of all those which are passed. * * @param {Array} middleware * @return {Function} * @api public */ function compose (middleware) { if (!Array.isArray(middleware)) throw new TypeError('Middleware stack must be an array!') for (const fn of middleware) { if (typeof fn !== 'function') throw new TypeError('Middleware must be composed of functions!') } /** * @param {Object} context * @return {Promise} * @api public */ return function (context, next) { // last called middleware # let index = -1 return dispatch(0) function dispatch (i) { if (i <= index) return Promise.reject(new Error('next() called multiple times')) index = i let fn = middleware[i] if (i === middleware.length) fn = next if (!fn) return Promise.resolve() try { return Promise.resolve(fn(context, dispatch.bind(null, i + 1))) } catch (err) { return Promise.reject(err) } } } }
compose()
函數(shù)的參數(shù)是一個中間件數(shù)組,它包含了要組合的中間件函數(shù)。首先,代碼會檢查中間件數(shù)組是否是一個數(shù)組,并檢查數(shù)組中的每個元素是否都是函數(shù)。如果中間件數(shù)組不合法,就會拋出一個錯誤。
然后,compose()
函數(shù)會返回一個新的函數(shù),該函數(shù)接受兩個參數(shù):context
和 next
。context
對象包含了請求的上下文信息,例如請求路徑、請求參數(shù)等。next
函數(shù)是一個回調(diào)函數(shù),用于在當(dāng)前中間件函數(shù)完成工作后調(diào)用下一個中間件函數(shù)。
變量 index
,用于記錄最后一個被調(diào)用的中間件函數(shù)的編號。
在每次調(diào)用中間件函數(shù)之前,都會檢查當(dāng)前中間件函數(shù)的編號是否小于等于 index
變量。如果是,就意味著 next()
函數(shù)被調(diào)用了多次,會返回一個錯誤。然后會更新 index
變量,并獲取下一個中間件函數(shù)。
如果當(dāng)前中間件函數(shù)是最后一個中間件函數(shù),就會將 next
函數(shù)賦值給當(dāng)前中間件函數(shù)。如果沒有更多的中間件函數(shù),就會返回一個已完成的 Promise 對象。
最后,調(diào)用當(dāng)前中間件函數(shù),并返回一個 Promise 對象。如果在調(diào)用過程中發(fā)生錯誤則會拋出一個異常。
總結(jié)
koa-compose 使用遞歸和Promise來實(shí)現(xiàn)多個中間件的鏈?zhǔn)秸{(diào)用,Promise 很好的簡化了異步流程,并且能夠讓你使用 try-catch
語句捕獲異步錯誤。
以上就是Node.js 網(wǎng)絡(luò)框架koa compose中間件使用解析的詳細(xì)內(nèi)容,更多關(guān)于Node.js框架koa compose中間件的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Windows中安裝nvm進(jìn)行Node版本控制與詳細(xì)使用教程
nvm和npm都是node.js版本管理工具,但是為了解決node各種不同之間版本存在不兼容的問題,因此可以通過nvm安裝和切換不同版本的node,感興趣的可以了解一下2023-09-09Nodejs中使用phantom將html轉(zhuǎn)為pdf或圖片格式的方法
這篇文章主要介紹了Nodejs中使用phantom將html轉(zhuǎn)為pdf或圖片格式的方法,需要的朋友可以參考下2017-09-09nodejs實(shí)現(xiàn)發(fā)出蜂鳴聲音(系統(tǒng)報警聲)的方法
這篇文章主要介紹了nodejs實(shí)現(xiàn)發(fā)出蜂鳴聲音(系統(tǒng)報警聲)的方法,結(jié)合實(shí)例形式分析了nodejs發(fā)出蜂鳴聲的原理及具體應(yīng)用方法,需要的朋友可以參考下2017-01-01關(guān)于npm install過程失敗的幾種處理方式
這篇文章主要介紹了關(guān)于npm install過程失敗的幾種處理方式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-06-06Express實(shí)現(xiàn)定時發(fā)送郵件的示例代碼
在開發(fā)中我們有時候需要每隔?一段時間發(fā)送一次電子郵件,或者在某個特定的時間進(jìn)行發(fā)送郵件,無需手動去操作,基于這樣的情況下我們需要用到了定時任務(wù)。本文就來用Express實(shí)現(xiàn)定時發(fā)送郵件吧2023-04-04