回形针一样的中间件

中间件的执行顺序

在 Koa 应用中,第一个中间件里的请求是1,响应是 2,第二个中间件里的请求是 3,响应是 4,那么最终输出的结果是 1324。下面将对这个现象进行解析。

1. 从 Generator 说起
先来演示下 Generator 的用法

function *a(){
  console.log('第 1 个中间件的 before')
  yield *b()
  console.log('第 1 个中间件的 after')
}

function *b() {
  console.log('业务逻辑')
}

function *hello(){
   yield *a()
}

const it1 = hello();
console.log(it1.next()) // {value: undefined, done: true  }

代码的执行结果如下

第 1 个中间件的 before
业务逻辑
第 1 个中间件的 after

从结果可以看出,a 这个 Generator 里的内容,yield 之前的语句是先执行的,yield 之后的语句是在 b 执行完成后才执行的。这就是回形针的最早体现。

2. 用 co 简化代码
使用 co 这个 Generator 可以简化 Generator 的执行过程。

const co = require('co')

function *a(){
  console.log('第 1 个中间件的 before')
  yield *b()
  console.log('第 1 个中间件的 after')
}

function *b() {
  console.log('业务逻辑')
}

co(function *(){
  yield *a()
})

这段代码的执行结果和上面的一致。

3. 具体的 1342
下面将以 ‘1342’ 为例,显式下中间件的执行过程:

const co = require('co')

function *a(){
  console.log('第一个中间件的 before 1')
  yield *b()
  console.log('第一个中间件的 after 2')
}

function *b(){
  console.log('  第二个中间件的 before 3')
  yield *c()
  console.log('  第二个中间件的 after 4')
}

function *c(){
  console.log('    这里是业务逻辑')
}

co(function *(){
  yield *a()
})

以下是执行代码的结果:

第一个中间件的 before 1
  第二个中间件的 before 3
    这里是业务逻辑
  第二个中间件的 after 4
第一个中间件的 after 2

中间件的执行顺序是 a->b->c,但是最终的执行顺序是 a1 -> b3 -> c -> b4 -> a2,这其实反映了这节的核心:当两个中间件叠加使用时,假设第一个中间件里的请求是 1,响应是 2,;第二个中间件的请求是 3,响应是 4,那么具体的执行顺序是 1->3->4->2

4. 中间件的写法
首先,先来模拟一下 Koa 的中间件:

var co = require('co')
var compose = require('koa-compose')

function *a(){
  console.log('第一个中间件的 before 1')
  yield *b()
  console.log('第一个中间件的 after 2')
}

function *b(){
  console.log('  第二个中间件的 before 3')
  yield *c()
  console.log('  第二个中间件的 after 4')
}

function *c(){
  console.log('    这里是业务逻辑')
}

var stack = [a,b,c]

co(compose(stack));

koa-compose 是 Koa 中最核心的模块,用于组合对个中间件,最终合并成一个中间件。

探索原理

  1. 探索1
// app.js
var co = require('co')

module.exports = {
  middleware: [],
  use: function(fn){
    this.middleware.push(fn)
    return this;
  },
  callback: function(cb) {
    const fn = this.compose(this.middleware)
    co(fn).then(cb, function(err){
      console.log(err.stack)
    })
  },
  compose: function(middleware){
    return function *(next) {
      if (!next) {
        next = function *(){}
      }
      
      var i = middleware.length;
      while(i--) {
        next = middleware[i].call(this, next)
      }
      
    }
    return yield *next
  }
}

测试代码如下

var app = reqiure('./app')

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

app.use(function *(next) {
  console.log(3)
  yield next
  console.log(4)
})
app.callback()  // 1342

探索 1 的代码只依赖了 co 模块,整体来说非常容易理解。
这里对重点代码进行解读

  • callback
  1. 通过 this.compose 把 this.middleware 转变成一个名为 fn 的 Generator 函数。
  2. 通过 co 执行 fn
  3. co 返回的是 Promise 对象,所以 then 后面接了两个参数,其中 cb 是成功回调,后面的函数用于异常处理。
  • compose

compose 的功能是将 compose([f1,f2...,fn]) 转化为 fn(...f2(f1(next()))), 最终返回一个 Generator 函数。

compose 返回的是 Generator ,因此它就需要一个 Generator 执行器,也就是上文出现的 co,来搭配使用。compose 其实就是 koa-compose 的核心功能,由此课件 koa-compose 的重要程度。

tip: co函数的作用是:将Generator函数转成一个promise对象。然后自动执行该函数的代码

  1. 探索 2
// app.js
var co = require('co')
var convert = require('koa-convert')

module.exports = {
  middleware: [],
  use: function(fn) {
    this.middleware.push(fn)
    return this
  },
  callback: function(){
    const fn = convert.compose(this.middleware)
    const ctx = {}
    fn(ctx).then(() => {})
  }
}

tip: koa-convert最主要的作用是:将koa1包中使用的Generator函数转换成Koa2中的async函数。更准确的说是将Generator函数转换成使用co包装成的Promise对象。然后执行对应的代码。当然该包中也提供了back方法,也可以把koa2中的async函数转换成koa1包中的Generator函数。

测试代码如下:

var app = require('./app')

app.use((ctx, next) => {
  console.log(1)
  return next().then(() => {
     console.log(2)
  })
})

app.use(function *(ctx, next) => {
  console.log(3)
  yield next
  console.log(4)
})

app.callback() // 1342

回溯机制

在 Express 里,中间件请求进行处理,但无法对响应进行处理。
但是对于 Koa 而言,中间件能对请求做出处理,也能对响应作出处理。

1. 回形针的实现: compose
下面是具体代码:

compose: function(middleware) {
  return function(content, next) {
     let index = -1;
     return dispatch(0)
     function dispatch(i) {
      if(i<= index) {
        return Promise.reject(new Error('next() called multiple tiems'))
      }
      index = i
      const fn = middleware[i] || next
      if (!fn) {
        return Promise.resolve()
      }
      try {
        return Promise.resolve(fn(content, function next() {
          return dispatch(i +1)
        }))
      } catch(err) {
        return Promise.reject(err)
      }
    }
  }
}

可以看到,最终返回的结果是 Promise,这样子可以很好的配合 async 和 await。

3. 从 Koa v1 到 Koa2 v2

Koa v1 的中间件机制其实就是将 compose([f1,f2....,fn]) 转换为 fn(....f2(f1(next))), 最终返回值是一个生成器函数。而 Koa v2 将其转化为 fn(...fn-1(fn(noop())))); 最终返回的是 function (content, next){}。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,509评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,806评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,875评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,441评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,488评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,365评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,190评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,062评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,500评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,706评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,834评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,559评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,167评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,779评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,912评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,958评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,779评论 2 354

推荐阅读更多精彩内容

  • 前言 原文地址 最近几天花了比较长的时间在koa(1)的源码分析上面,初次看的时候,�被中间件执行那段整的晕乎乎的...
    谦龙阅读 1,511评论 0 9
  • 本节将结合例子和源码对koa2的中间件机制做一介绍。 什么是中间件? 中间件的本质就是一种在特定场景下使用的函数,...
    空无一码阅读 1,446评论 0 2
  • 我们知道,Koa 中间件是以级联代码(Cascading) 的方式来执行的。类似于回形针的方式,可参照下面这张图:...
    中间件阅读 1,556评论 0 4
  • Koa源码解析 整体架构 核心文件只有4个,在lib文件夹下: application.js koa框架的入口...
    Ethan_lcm阅读 2,433评论 0 1
  • 看到标题,也许您会觉得奇怪,redux跟Koa以及Express并不是同一类别的框架,干嘛要拿来做类比。尽管,例如...
    Perkin_阅读 1,723评论 0 4