深入淺出Nodejs中間件原理

作者：趣談前端 2021-08-10 14:10:02

中間件是介于應(yīng)用系統(tǒng)和系統(tǒng)軟件之間的一類軟件，它使用系統(tǒng)軟件所提供的基礎(chǔ)服務(wù)（功能），銜接網(wǎng)絡(luò)上應(yīng)用系統(tǒng)的各個(gè)部分或不同的應(yīng)用，能夠達(dá)到資源共享、功能共享的目的。

前言

中間件是介于應(yīng)用系統(tǒng)和系統(tǒng)軟件之間的一類軟件，它使用系統(tǒng)軟件所提供的基礎(chǔ)服務(wù)(功能)，銜接網(wǎng)絡(luò)上應(yīng)用系統(tǒng)的各個(gè)部分或不同的應(yīng)用，能夠達(dá)到資源共享、功能共享的目的。

[[416577]]

在NodeJS中，中間件主要是指封裝http請(qǐng)求細(xì)節(jié)處理的方法。我們都知道在http請(qǐng)求中往往會(huì)涉及很多動(dòng)作, 如下: IP篩選查詢字符串傳遞請(qǐng)求體解析 cookie信息處理權(quán)限校驗(yàn) 日志記錄會(huì)話管理中間件(session) gzip壓縮中間件(如compress) * 錯(cuò)誤處理

當(dāng)然還有很多自定義的處理動(dòng)作. 對(duì)于Web應(yīng)用而言，我們并不希望了解每一個(gè)細(xì)節(jié)性的處理工作，而是希望能夠把主要精力集中在業(yè)務(wù)的開發(fā)上，以達(dá)到提升開發(fā)效率的目的, 所以引入了Node中間件來簡(jiǎn)化和封裝這些基礎(chǔ)邏輯處理細(xì)節(jié).

node中間件本質(zhì)上就是在進(jìn)入具體的業(yè)務(wù)處理之前，先讓特定過濾器處理。如下圖所示:

我們目前看到的主流nodejs框架, 比如connect, koa, express, egg, nest等, 都離不開中間件的設(shè)計(jì)概念, 所以為了能讓大家更深入的窺探nodejs世界, 我們就非常有比較研究中間件的實(shí)現(xiàn)原理.

正文

在了解node中間件的概念之后, 我們就來手動(dòng)實(shí)現(xiàn)一下中間件, 最后我們會(huì)簡(jiǎn)單分析一下koa中中間件的實(shí)現(xiàn)思路. 文章大綱如下: node中間件核心原理實(shí)現(xiàn) koa中間鍵實(shí)現(xiàn)方式 * 利用koa中間件機(jī)制實(shí)現(xiàn)一個(gè)自己的koa中間件

node中間件核心原理實(shí)現(xiàn)

由上文介紹可知中間件是從http請(qǐng)求開始到響應(yīng)結(jié)束過程中的處理邏輯，通常需要對(duì)請(qǐng)求和響應(yīng)進(jìn)行處理. 我們?cè)趯?shí)現(xiàn)node中間件模式時(shí)還需要考慮的一個(gè)問題就是多中間件共存的問題, 我們要思考如何將多個(gè)中間件的執(zhí)行自動(dòng)化, 不然在請(qǐng)求到響應(yīng)的過程中只會(huì)執(zhí)行最開始的中間件, 所以我們基本的中間件形式如下:

const middleware = (req, res, next) => { 
  // 請(qǐng)求處理邏輯 
  next() 
}

接下來我們先寫個(gè)簡(jiǎn)單的案例來看看中間件是如何實(shí)現(xiàn)的.

// 定義幾個(gè)中間間函數(shù) 
const m1 = (req, res, next) => { 
  console.log('m1 run') 
  next() 
} 
 
const m2 = (req, res, next) => { 
  console.log('m2 run') 
  next() 
} 
 
const m3 = (req, res, next) => { 
  console.log('m3 run') 
  next() 
} 
 
// 中間件集合 
const middlewares = [m1, m2, m3] 
 
function useApp (req, res) { 
  const next = () => { 
    // 獲取第一個(gè)中間件 
    const middleware = middlewares.shift() 
    if (middleware) { 
      middleware(req, res, next) 
    } 
  } 
  next() 
} 
 
// 第一次請(qǐng)求流進(jìn)入 
useApp()

由以上代碼我們就不難發(fā)現(xiàn)next的作用了, 也就是實(shí)現(xiàn)自動(dòng)調(diào)用中間件鏈的關(guān)鍵參數(shù). 打印結(jié)果如下:

m1 run 
m2 run 
m3 run

以上即實(shí)現(xiàn)了基本中間件的執(zhí)行模式, 但是我們還需要考慮異步的問題, 如果中間件還依賴第三發(fā)模塊或者api的支持, 比如驗(yàn)證, 識(shí)別等服務(wù), 我們需要在該異步中間件的回調(diào)里執(zhí)行next, 才能保證正常的調(diào)用執(zhí)行順序, 如下代碼所示:

const m2 = (req, res, next) => { 
  fetch('/xxxxx').then(res => { 
    next() 
  }) 
}

還有一種中間件場(chǎng)景, 比如說日志中間件, 請(qǐng)求監(jiān)控中間件, 它們會(huì)在業(yè)務(wù)處理前和處理后都會(huì)執(zhí)行相關(guān)邏輯, 這個(gè)時(shí)候就要求我們需要能對(duì)next函數(shù)進(jìn)行二次處理, 我們可以將next的返回值包裝成promise, 使得其在業(yè)務(wù)處理完成之后通過then回調(diào)來繼續(xù)處理中間件邏輯. 如下所示:

function useApp (req, res) { 
  const next = () => { 
    const middleware = middlewares.shift() 
    if (middleware) { 
      // 將返回值包裝為Promise對(duì)象 
      return Promise.resolve(middleware(req, res, next)) 
    }else { 
      return Promise.resolve("end") 
    } 
  } 
  next() 
}

此時(shí)我們就能使用如下方式調(diào)用了:

const m1 = (req, res, next) => { 
  console.log('m1 start') 
  return next().then(() => { 
    console.log('m1 end') 
  }) 
}

以上我們就實(shí)現(xiàn)了一個(gè)基本可以的中間件設(shè)計(jì)模式, 當(dāng)然我們也可以用async和await實(shí)現(xiàn), 寫法會(huì)更優(yōu)雅和簡(jiǎn)單. 筆者這里上一份簡(jiǎn)單的例子:

const m1 = async (req, res, next) => { 
    // something... 
    let result = await next(); 
  } 
 
  const m2 = async (req, res, next) => { 
    // something... 
    let result = await next(); 
  } 
  const m3 = async (req, res, next) => { 
    // something... 
    let result = await next(); 
    return result; 
  } 
 
const middlewares = [m1, m2, m3]; 
 
function useApp (req, res) { 
    const next = () => { 
      const middleware = middlewares.shift() 
      if (middleware) { 
        return Promise.resolve(middleware(req, res, next)) 
      }else { 
        return Promise.resolve("end") 
      } 
    } 
    next() 
  } 
// 啟動(dòng)中間件 
useApp()

在koa2框架中, 中間件的實(shí)現(xiàn)方式也是將next()方法返回值封裝為Promise對(duì)象，實(shí)現(xiàn)了其提出的洋蔥圈模型，如下圖所示:

web前端開發(fā)項(xiàng)目課程免費(fèi)領(lǐng)取，助力成長(zhǎng)大廠開發(fā)工程師

已失效

koa中間件實(shí)現(xiàn)方式

koa2框架的中間件實(shí)現(xiàn)原理很優(yōu)雅，筆者覺得很必要研究一下, 這里展示一下其核心思路:

function compose (middleware) { 
  // 提前判斷中間件類型,防止后續(xù)錯(cuò)誤 
  if (!Array.isArray(middleware)) throw new TypeError('Middleware stack must be an array!') 
  for (const fn of middleware) { 
    // 中間件必須為函數(shù)類型 
    if (typeof fn !== 'function') throw new TypeError('Middleware must be composed of functions!') 
  } 
  return function (context, next) { 
    // 采用閉包將索引緩存,來實(shí)現(xiàn)調(diào)用計(jì)數(shù) 
    let index = -1 
    return dispatch(0) 
    function dispatch (i) { 
      // 防止next()方法重復(fù)調(diào)用 
      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 { 
        // 包裝next()返回值為Promise對(duì)象 
        return Promise.resolve(fn(context, dispatch.bind(null, i + 1))); 
      } catch (err) { 
        // 異常處理 
        return Promise.reject(err) 
      } 
    } 
  } 
}

利用koa中間件機(jī)制實(shí)現(xiàn)一個(gè)自己的koa中間件

學(xué)習(xí)了中間件的設(shè)計(jì)機(jī)制和原理, 我們是不是想馬上寫一個(gè)中間件呢? 筆者這里給大家舉一個(gè)例子. 在H5-Dooring項(xiàng)目的服務(wù)端代碼中, 我們需要對(duì)用戶登錄權(quán)限進(jìn)行分發(fā), 此時(shí)我們提供統(tǒng)一個(gè)中間件來處理, 如下代碼所示:

// 模擬數(shù)據(jù)庫操作 
const token = db.user(); 
 
// router或者koa的中間件一定要用await處理next，否則將不能正常響應(yīng)數(shù)據(jù) 
export default async (ctx, next) => { 
  const t = ctx.request.header.authorization 
  let uid = ctx.request.header['x-requested-with'] 
  let uidArr = uid.split(',') 
  if(uidArr.length > 1) { 
      uid = uidArr.pop().trim() 
  } 
    if(token[uid] && token[uid][1] === t) { 
        await next() 
    }else { 
        ctx.status = 403; 
        ctx.body = { 
            state: 403, 
            msg: '你沒有權(quán)限操作' 
        } 
    }   
}