解析node中koa中間件機制問題

本篇文章主要主要介紹了node中koa中間件機制詳解，詳細的介紹了koa和兼容問題，具有一定的參考價值，有興趣的可以了解一下

koa

koa是由express原班人馬打造的一個更小、更富有表現力、更健壯的web框架。

在我眼中，koa的確是比express輕量的多，koa給我的感覺更像是一個中間件框架，koa只是一個基礎的架子，需要用到的相應的功能時，用相應的中間件來實現就好，諸如路由系統等。一個更好的點在於，express是基於回調來處理，至於回呼到底有多麼的不好，大家可以自行搜尋來看。 koa1基於的co庫，所以koa1利用Generator來代替回調，而koa2由於node對async/await的支持，所以koa2利用的是async/await。關於async以及co庫等，大家可以參考我之前寫過的一篇文章（理解async）。 koa可以說是一個各種中間件的架子，下面就來看一下koa對於中間件部分的實現：

#koa1的中間件

koa1主要利用的是Generator來實現，一般來說，koa1的一個中間件大概是長這個樣子的：

app.use(function *(next){
  console.log(1);
  yield next;
  console.log(5);
});
app.use(function *(next){
  console.log(2);
  yield next;
  console.log(4);
});
app.use(function *(){
  console.log(3);
});

這樣的輸出會是1, 2, 3, 4 , 5，koa的中間件的實現主要依靠的是koa-compose：

#

function compose(middleware){
 return function *(next){
  if (!next) next = noop();

  var i = middleware.length;
  // 组合中间件
  while (i--) {
   next = middleware[i].call(this, next);
  }

  return yield *next;
 }
}
function *noop(){}

源碼非常的簡單，實現的功能就是將所有的中間件串聯起來，首先將倒數第一個中間件傳入一個noop作為其next，再將這個整理後的倒數第一個中間作為next傳入倒數第二個中間件，最終得到的next就是整理後的第一個中間件。說起來比較複雜，畫圖來看：

實現的效果如同上圖，與redux需要實現的目標類似，只要遇到了yield next就去執行下一個中間件，利用co庫很容易將這個流程串聯起來，下面來簡單模擬下，中間件完整的實現：

const middlewares = [];

const getTestMiddWare = (loggerA, loggerB) => {
  return function *(next) {
    console.log(loggerA);
    yield next;
    console.log(loggerB);
  }
};
const mid1 = getTestMiddWare(1, 4),
  mid2 = getTestMiddWare(2, 3);

const getData = new Promise((resolve, reject) => {
  setTimeout(() => resolve('数据已经取出'), 1000);
});

function *response(next) {
  // 模拟异步读取数据库数据
  const data = yield getData;
  console.log(data);
}

middlewares.push(mid1, mid2, response);
// 简单模拟co库
function co(gen) {
  const ctx = this,
    args = Array.prototype.slice.call(arguments, 1);
  return new Promise((reslove, reject) => {
    if (typeof gen === 'function') gen = gen.apply(ctx, args);
    if (!gen || typeof gen.next !== 'function') return resolve(gen);

    const baseHandle = handle => res => {
      let ret;
      try {
        ret = gen[handle](res);
      } catch(e) {
        reject(e);
      }
      next(ret);
    };
    const onFulfilled = baseHandle('next'),
      onRejected = baseHandle('throw');
      
    onFulfilled();
    function next(ret) {
      if (ret.done) return reslove(ret.value);
      // 将yield的返回值转换为Proimse
      let value = null;
      if (typeof ret.value.then !== 'function') {
        value = co(ret.value);
      } else {
        value = ret.value;
      }
      if (value) return value.then(onFulfilled, onRejected);
      return onRejected(new TypeError('yield type error'));
    }
  });
}
// 调用方式
const gen = compose(middlewares);
co(gen);

koa2的中間件

隨著node對於async/await的支持，似乎不需要再藉助於co這種工具庫了，直接利用原生的就好，於是koa也做出了改變，來看目前的koa -compose：

function compose (middleware) {
 // 参数检验
 return function (context, next) {
  // last called middleware #
  let index = -1
  return dispatch(0)
  function dispatch (i) {
   if (i <= index) return Promise.reject(new Error(&#39;next() called multiple times&#39;))
   index = i
   let fn = middleware[i]
   // 最后一个中间件的调用
   if (i === middleware.length) fn = next
   if (!fn) return Promise.resolve()
   // 用Promise包裹中间件，方便await调用
   try {
    return Promise.resolve(fn(context, function next () {
     return dispatch(i + 1)
    }))
   } catch (err) {
    return Promise.reject(err)
   }
  }
 }
}

koa-compose利用了Promise，koa2的中間件的參數也有一個變為了兩個，而且執行下一個的中間件利用的是await next()，要達到與上面的範例程式碼相同的效果，需要更改中間件的寫法：

#

const middlewares = [];
const getTestMiddWare = (loggerA, loggerB) => async (ctx, next) => {
  console.log(loggerA);
  await next();
  console.log(loggerB);
};

const mid1 = getTestMiddWare(1, 4),
  mid2 = getTestMiddWare(2, 3);
const response = async () => {
  // 模拟异步读取数据库数据
  const data = await getData();
  console.log(data);
};
const getData = () => new Promise((resolve, reject) => {
  setTimeout(() => resolve('数据已经取出'), 1000);
});
middlewares.push(mid1, mid2);

// 调用方式
compose(middlewares)(null, response);

如何做到相容

可以看到的是，koa1與koa2對於中間件的實現還是有著很多的不同的，將koa1的中間件直接拿到koa2下面來使用肯定是會出現錯誤的，如何兼容這兩個版本也成了一個問題，koa團隊寫了一個套件來是koa1的中間件可以用於koa2中，叫做koa-convert，先來看看這個套件怎麼使用：

function *mid3(next) {
  console.log(2, 'koa1的中间件');
  yield next;
  console.log(3, 'koa1的中间件');
}
convert.compose(mid3)

來看下這個套件實現的想法：

// 将参数转为数组，对每一个koa1的中间件执行convert操作
convert.compose = function (arr) {
 if (!Array.isArray(arr)) {
  arr = Array.from(arguments)
 }
 return compose(arr.map(convert))
}
// 关键在于convert的实现
const convert = mw => (ctx, next) => {
  // 借助co库，返回一个Promise，同时执行yield
  return co.call(ctx, mw.call(ctx, createGenerator(next)));
};

function * createGenerator (next) {
 /*
   next为koa-compomse中：
   function next () {
     return dispatch(i + 1)
   }
 */
 return yield next()
 // 执行完koa1的中间件，又回到了利用await执行koa2中间件的正轨
}

個人感覺koa-convert的想法就是對Generator封裝一層Promise，使上一個中間件可以利用await next()的方式調用，對於Generator的執行，利用co庫，從而達到了相容的目的。

以上是解析node中koa中間件機制問題的詳細內容。更多資訊請關注PHP中文網其他相關文章！