koa中間執行機制

来源:https://www.cnblogs.com/guolao/archive/2020/02/10/12290246.html
-Advertisement-
Play Games

start 基於 koa 2.11 按以下流程分析： app.use() use 方法定義在 中： this.middleware 這就是一個數組，用來存放所有中間件，然後按順序執行。 app.listen() 這個方法定義在 中： this.callback() this.handleReques ...


start

基於 koa 2.11 按以下流程分析：

const Koa = require('koa');
const app = new Koa();

const one = (ctx, next) => {
  console.log('1-Start');
  next();
  ctx.body = { text: 'one' };
  console.log('1-End');
}
const two = (ctx, next) => {
  console.log('2-Start');
  next();
  ctx.body = { text: 'two' };
  console.log('2-End');
}

const three = (ctx, next) => {
  console.log('3-Start');
  ctx.body = { text: 'three' };
  next();
  console.log('3-End');
}

app.use(one);
app.use(two);
app.use(three);

app.listen(3000);

app.use()

use 方法定義在 koa/lib/application.js 中：

use(fn) {
  // check middleware type, must be a function
  if (typeof fn !== 'function') throw new TypeError('middleware must be a function!');
  // 相容 generator
  if (isGeneratorFunction(fn)) {
    deprecate('Support for generators will be removed in v3. ' +
              'See the documentation for examples of how to convert old middleware ' +
              'https://github.com/koajs/koa/blob/master/docs/migration.md');
    fn = convert(fn);
  }
  debug('use %s', fn._name || fn.name || '-');
  
  // 存儲中間
  this.middleware.push(fn);
  return this;
}

this.middleware

這就是一個數組，用來存放所有中間件，然後按順序執行。

this.middleware = [];

app.listen()

這個方法定義在 koa/lib/application.js 中：

listen(...args) {
  debug('listen');
  
  // 創建 http 服務並監聽
  const server = http.createServer(this.callback());
  return server.listen(...args);
}

this.callback()

callback() {
  // 處理中間件
  const fn = compose(this.middleware);

  if (!this.listenerCount('error')) this.on('error', this.onerror);

  const handleRequest = (req, res) => {
    // 創建 Context
    const ctx = this.createContext(req, res);
    // 執行中間件處理請求和響應
    return this.handleRequest(ctx, fn);
  };

  return handleRequest;
}

this.handleRequest

handleRequest(ctx, fnMiddleware) {
  const res = ctx.res;
  res.statusCode = 404;
  const onerror = err => ctx.onerror(err);
  // 將響應發出的函數
  const handleResponse = () => respond(ctx);
  onFinished(res, onerror);
  // 這裡會將 ctx 傳給中間件進行處理，
  // 當中間件流程走完後，
  // 會執行 then 函數將響應發出
  return fnMiddleware(ctx).then(handleResponse).catch(onerror);
}

respond(ctx)

function respond(ctx) {
  // 省略其他代碼
  // ...
  // 發出響應
  res.end(body);
}

捋一捋流程，由上面的代碼可以知道，存放中間的數組是通過 compose 方法進行處理，然後返回一個fnMiddleware函數，接著將 Context 傳遞給這個函數來進行處理，當fnMiddleware執行完畢後就用respond方法將響應發出。

compose(this.middleware)

compose 函數通過koa-compose引入：

const compose = require('koa-compose');

compose 定義在koajs/compose/index.js下

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!')
  }

  return function (context, next) {
    // 這個 index 是標識上一次執行的中間件是第幾個
    let index = -1
    
    // 執行第一個中間件
    return dispatch(0)
    function dispatch (i) {
      // 檢查中間件是否已經執行過，
      // 舉個例子，當執行第一個中間件時 dispatch(0)，
      // i = 0, index = -1, 說明沒有執行過，
      // 然後 index = i, 而 index 通過閉包保存，
      // 如果執行了多次，就會報錯
      if (i <= index) return Promise.reject(new Error('next() called multiple times'))
      index = i
      
      // 通過傳入的索引從數組中獲取中間件
      let fn = middleware[i]
      
      // 如果當前索引等於中間件數組的長度，
      // 說明已經中間件執行完畢，
      // fn 為 fnMiddleware(ctx) 時沒有傳入的第二個參數，
      // 即 fn = undefined
      if (i === middleware.length) fn = next
      // fn 為 undefined, 返回一個已經 reolved 的 promise
      if (!fn) return Promise.resolve()
      
      try {
        // 執行中間件函數並將 dispatch 作為 next 函數傳入
        return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
      } catch (err) {
        return Promise.reject(err)
      }
    }
  }
}

結束執行流程

現在來捋一下 fnMiddleware的執行流程:

// fnMiddleware 接收兩個參數
function (context, next) {
  // ....
}

// 將 context 傳入，並沒有傳入 next,
// 所以第一次執行時是沒有傳入 next 的
fnMiddleware(ctx).then(handleResponse).catch(onerror);

next == undefined時會結束中間件執行，流程如下：

function dispatch (i) {
  //...
  
  // 通過傳入的索引從數組中獲取中間件，
  // 但是因為已經執行完了所有中間件，
  // 所以當前 i 已經等於數組長度，
  // 即 fn = undefined
  let fn = middleware[i]

  // 如果當前索引等於中間件數組的長度，
  // 說明已經中間件執行完畢，
  // 又因為 fnMiddleware(ctx) 時沒有傳入的第二個參數 next，
  // 所以 fn = undefined
  if (i === middleware.length) fn = next
  
  // fn 為 undefined, 返回一個已經 reolved 的 promise
  // 中間件執行流程結束
  if (!fn) return Promise.resolve()
  
  // ...
}

中間件執行流程

上面先說了結束流程，現在說一下如何順序執行，形成洋蔥模型：

function dispatch (i) {
  // ...省略其他代碼
  
    try {
    // 分步驟說明
    // 首先通過 bind 將 dispatch 構建為 next 函數
    const next = dispatch.bind(null, i + 1);
    // 將 ctx, next 傳入執行當前中間件，
    // 當在中間件中調用 next() 時,
    // 本質上是調用 diapatch(i + 1),
    // 也就是從數組中獲取下一個中間件進行執行，
    // 在這時，會中斷當前中間件的執行流程轉去執行下一個中間件，
    // 只有當下一個中間件執行完畢，才會恢復當前中間件的執行
    const result = fn(context, next);
    // 中間件執行完畢，返回已經 resolve 的 promise，
    // 那麼上一個中間件接著執行剩下的流程，
    // 這樣就形成了洋蔥模型
    return Promise.resolve(result);
  } catch (err) {
    return Promise.reject(err)
  }
}

開頭的例子執行結果如下：

const one = (ctx, next) => {
  console.log('1-Start');
  next();
  ctx.body = { text: 'one' };
  console.log('1-End');
}
const two = (ctx, next) => {
  console.log('2-Start');
  next();
  ctx.body = { text: 'two' };
  console.log('2-End');
}

const three = (ctx, next) => {
  console.log('3-Start');
  ctx.body = { text: 'three' };
  next();
  console.log('3-End');
}

// 1-Start
// 2-Start
// 3-Start
// 3-End
// 2-End
// 1-End
// 而 ctx.body 最終為 { text: 'one' }

next()

沒有調用 next()

// 沒有調用 next() 函數
app.use((ctx, next) => {
  console.log('Start');
  ctx.body = { text: 'test' };
  console.log('End');
});

因為 next 函數本質上就是通過dispatch(i + 1)來調用下一個中間件，如果沒有調用 next 函數，就無法執行下一個中間件，那麼就代表當前中間件流程執行結束。

多次調用 next()

app.use((ctx, next) => {
  console.log('Start');
  ctx.body = { text: 'test' };
  // 多次調用 next 函數
  next(); // 本質上是 dispatch(i + 1)
  next(); // 本質上是 dispatch(i + 1)
  console.log('End');
});

這裡假設 next 為 dispatch(3)，那麼 index 就為 2，第一次執行 next 函數時，會發生如下邏輯：

// index == 2
// i == 3
// 不會報錯
if (i <= index) return Promise.reject(new Error('next() called multiple times'))
// 賦值後 index 為 3 了 
index = i

假設第三個中間件是最後一個中間件，那麼執行完第一次 next 函數會立即執行第二個 next 函數，依然執行這個邏輯，但是 index 已經為 3 了，所以會導致報錯：

// index == 3
// i == 3
// 報錯
if (i <= index) return Promise.reject(new Error('next() called multiple times'))
index = i

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 【React Native】某個頁面禁用物理返回鍵
    1、引入組件 import { BackHandler, } from 'react-native'; 2、添加監聽 componentDidMount(): void { BackHandler.addEventListener('hardwareBackPress', this.onBackBu ...
  • JavaScript面向對象編程
    在前端開發中，JavaScript並沒有想象中那麼簡單，不只是簡單的UI輸入驗證，還有面向對象。對於剛剛JavaScript入門的你來說，可能會稍稍驚訝：哇，雖然前端開發好找對象，但是JavaScript真的可以向對象編程麽！！！是的，你沒有看錯，本文將通過一些小例子，逐步講解JavaScript的... ...
  • JS數據類型和堆棧+變數比較和值的複製+參數傳遞和類型檢測
    變數命名 變數名：字母 數字 下劃線 美元符$ jquery: $ $.each() $ jQuery underscore( js的一個函數庫) : _ _.each() 關鍵字 : if for 保留字 : class 推薦有意義的命名： buttonCancel button_cancel b ...
  • vue父子組件雙向數據綁定
    在有些情況下，我們可能需要對一個 prop 進行“雙向綁定”。不幸的是，真正的雙向綁定會帶來維護上的問題，因為子組件可以修改父組件，且在父組件和子組件都沒有明顯的改動來源。 所以就推薦以update:myPropName 的模式觸發事件取而代之。舉個例子，在一個包含 title prop 的假設的組 ...
  • 兩種存儲思路
    存儲一張圖片，常見兩種思路： 1. 存儲 寬高、每個像素的 RGBA 值——點陣圖 1. 存儲 寬高、每個幾何圖形——矢量圖 一張圖片，如果幾何圖形關係明確，用矢量圖來存儲，不但空間占用少，而且信息比點陣圖全。因為點陣圖沒有表達出幾何圖形的關係，在縮放時點陣圖只好失真。 同理，存儲一系列數據時： 1. 如果 ...
  • Vue 實現動態路由及登錄&404頁面跳轉控制&頁面刷新空白解決方案
    Vue實現動態路由及登錄&404頁面跳轉控制&頁面刷新空白解決方案 by:授客 QQ：1033553122 開發環境 Win 10 Vue 2.9.6 node-v10.15.3-x64.msi 下載地址： https://nodejs.org/en/ 代碼片段(router/index.js) 說 ...
  • 宣傳頁項目開發（三）
    網頁交互效果的實現 滾動條高度的獲取以及設置：document.body.scrollTop || document.documentElement.scrollTop .split() 把字元串分割成數組 .join() 把數組轉為字元串 .replace( /\s+/g, " ") 正則全局替換 ...
  • 宣傳頁項目開發（二）
    之前已經完成了靜態頁面的開發，接下來是網頁動態效果製作 css實現動畫的兩種方式： 1、transition: all 1s; 2、animation: move 1s infinite ease-in-out .5s; @keyframes move{ 0%{ transform: rotate( ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類