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
  • C#自增運算符詳解：++i與i++的區別及應用場景
    概述：在C#中，++i和i++都是自增運算符，其中++i先增加值再返回，而i++先返回值再增加。應用場景根據需求選擇，首碼適合先增後用，尾碼適合先用後增。詳細示例提供清晰的代碼演示這兩者的操作時機和實際應用。 在C#中，++i 和 i++ 都是自增運算符，但它們在操作上有細微的差異，主要體現在操作的 ...
  • Taurus.MVC 性能壓力測試（ap 壓測 和 linux 下wrk 壓測）：.NET 版本
    上次發佈了：Taurus.MVC 性能壓力測試（ap 壓測 和 linux 下wrk 壓測）：.NET Core 版本，今天計劃準備壓測一下 .NET 版本，來測試並記錄一下 Taurus.MVC 框架在 .NET 版本的性能，以便後續持續優化改進。 為了方便對比，本文章的電腦環境和測試思路，儘量和... ...
  • 一文讀懂.NET WebAPI中FromRoute、FromQuery、FromBody的關鍵角色與用法
    .NET WebAPI作為一種構建RESTful服務的強大工具，為開發者提供了便捷的方式來定義、處理HTTP請求並返迴響應。在設計API介面時，正確地接收和解析客戶端發送的數據至關重要。.NET WebAPI提供了一系列特性，如[FromRoute]、[FromQuery]和[FromBody]，用 ...
  • WPF/C#實現圖像濾鏡優化方案：打造炫目視覺體驗！
    原因：我之所以想做這個項目，是因為在之前查找關於C#/WPF相關資料時，我發現講解圖像濾鏡的資源非常稀缺。此外，我註意到許多現有的開源庫主要基於CPU進行圖像渲染。這種方式在處理大量圖像時，會導致CPU的渲染負擔過重。因此，我將在下文中介紹如何通過GPU渲染來有效實現圖像的各種濾鏡效果。 生成的效果 ...
  • Bogus 實戰：使用 Bogus 和 EFCore 生成模擬數據和種子數據【完整教程】
    引言 上一章我們介紹了在xUnit單元測試中用xUnit.DependencyInject來使用依賴註入，上一章我們的Sample.Repository倉儲層有一個批量註入的介面沒有做單元測試，今天用這個示例來演示一下如何用Bogus創建模擬數據 ，和 EFCore 的種子數據生成 Bogus 的優 ...
  • WPF隨筆收錄-實時繪製心率曲線
    一、前言 在自己的項目中，涉及到實時心率曲線的繪製，項目上的曲線繪製，一般很難找到能直接用的第三方庫，而且有些還是定製化的功能，所以還是自己繪製比較方便。很多人一聽到自己畫就害怕，感覺很難，今天就分享一個完整的實時心率數據繪製心率曲線圖的例子；之前的博客也分享給DrawingVisual繪製曲線的方 ...
  • wpf程式修改啟動入口註意事項
    如果你在自定義的 Main 方法中直接使用 App 類並啟動應用程式，但發現 App.xaml 中定義的資源沒有被正確載入，那麼問題可能在於如何正確配置 App.xaml 與你的 App 類的交互。 確保 App.xaml 文件中的 x:Class 屬性正確指向你的 App 類。這樣，當你創建 Ap ...
  • 記一次 .NET某爐膛鍋爐檢測系統 崩潰分析
    一：背景 1. 講故事 上個月有個朋友在微信上找到我，說他們的軟體在客戶那邊隔幾天就要崩潰一次，一直都沒有找到原因，讓我幫忙看下怎麼回事，確實工控類的軟體環境複雜難搞，朋友手上有一個崩潰的dump，剛好丟給我來分析一下。 二：WinDbg分析 1. 程式為什麼會崩潰 windbg 有一個厲害之處在於 ...
  • 一個.NET內置依賴註入的小型強化版
    前言 .NET生態中有許多依賴註入容器。在大多數情況下，微軟提供的內置容器在易用性和性能方面都非常優秀。外加ASP.NET Core預設使用內置容器，使用很方便。 但是筆者在使用中一直有一個頭疼的問題：服務工廠無法提供請求的服務類型相關的信息。這在一般情況下並沒有影響，但是內置容器支持註冊開放泛型服 ...
  • WPF隨筆收錄-DataGrid固定右側列
    一、前言 在項目開發過程中，DataGrid是經常使用到的一個數據展示控制項，而通常表格的最後一列是作為操作列存在，比如會有編輯、刪除等功能按鈕。但WPF的原始DataGrid中，預設只支持固定左側列，這跟大家習慣性操作列放最後不符，今天就來介紹一種簡單的方式實現固定右側列。（這裡的實現方式參考的大佬 ...
所有分類