Node.js?網(wǎng)絡(luò)框架koa?compose中間件使用解析

更新時間：2023年05月24日 11:00:35 作者：codeniu

這篇文章主要為大家介紹了Node.js?網(wǎng)絡(luò)框架koa?compose中間件使用解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

前言

學(xué)習(xí)目標(biāo)：

koa-compose
洋蔥模型

源碼地址：koajs/compose

koa-compose

Koa-compose 是一個 Koa 中間件工具，Koa 是一個流行的 Node.js 網(wǎng)絡(luò)框架。Koa-compose 允許你將多個中間件函數(shù)組合成一個單獨的函數(shù)，這樣可以更容易地管理和重用中間件。

在 Koa 中，中間件函數(shù)是按照特定順序調(diào)用的函數(shù)，用于處理傳入的 HTTP 請求并生成響應(yīng)。中間件函數(shù)可以執(zhí)行各種任務(wù)，例如解析請求主體、驗證請求參數(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ā)生錯誤則會拋出一個異常。