Koa中间件(middleware)实现探索

说起Node,最常用的估计就是express和koa,两者都用到了中间件(middleware)这一概念,主要用于对请求的统一处理。

koa的请求处理是典型的洋葱模型,下面是官方的配图,而这一模型的组成部分就是middleware


接下来我们来看一下koa的源码,了解中间件的实现方式。

首先我们找到了koa的仓库Koa,好吧,我知道你们都会这一步。

package.json中找到模块的入口文件application.js,稍微浏览一下(不得不说,tj大神的代码写的真的漂亮)就可以找到Koa处理请求的代码

app.callback = function(){
  if (this.experimental) {
    console.error('Experimental ES7 Async Function support is deprecated. Please look into Koa v2 as the middleware signature has changed.')
  }
  var fn = this.experimental
    ? compose_es7(this.middleware)
    : co.wrap(compose(this.middleware));
  var self = this;
  if (!this.listeners('error').length) this.on('error', this.onerror);

  return function handleRequest(req, res){
    res.statusCode = 404;
    var ctx = self.createContext(req, res);
    onFinished(res, ctx.onerror);
    fn.call(ctx).then(function handleResponse() {
      respond.call(ctx);
    }).catch(ctx.onerror);
  }
};

看完这个函数,我们了解到真正处理请求内容的函数是fn,而这个函数的定义就是下面这段函数

var fn = this.experimental
    ? compose_es7(this.middleware)
    : co.wrap(compose(this.middleware));

好吧,准确来说就是

co.wrap(compose(this.middleware));

其实我们只需要知道这段函数做了什么,就知道中间件是如何运行的了。

同时,我们在appliction.js文件找到了app.use函数

app.use = function(fn){
  ...
  
  this.middleware.push(fn);
  return this;
};

从这段代码,我们可以知道this.middleware就是一个generator函数的数组。

接下来我们需要知道compose函数做了什么,我们找到compose函数,其实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(){}

这里compose函数返回了一个Generator,所以上面的代码可以变成下面的样子(当然还有middleware的变量再闭包中)

co.wrap(function *(next){
    if (!next) next = noop();

    var i = middleware.length;

    while (i--) {
      next = middleware[i].call(this, next);
    }

    return yield *next;
  })

接下来我们看一下co.wrap

co.wrap = function (fn) {
  createPromise.__generatorFunction__ = fn;
  return createPromise;
  function createPromise() {
    return co.call(this, fn.apply(this, arguments));
  }
};

所以代码可以变为下面的样子

function createPromise() {
    var fn = function *(next){
        if (!next) next = noop();
    
        var i = middleware.length;
    
        while (i--) {
          next = middleware[i].call(this, next);
        }
    
        return yield *next;
      } 
    return co.call(this, fn.apply(this, arguments));
  }

接下来,我们仔细看一下这段代码

if (!next) next = noop();
    
var i = middleware.length;
    
while (i--) {
    next = middleware[i].call(this, next);
}

这段代码遍历了我们的中间件数组,最终生成了一个类似下面的代码

next = (function*(){
    // middleware1
    ...
    
    yield (function*(){
        // middleware2
        ...
        
        yield (function*(){
            // middleware3
            ...
            
            yield (function *(){
                // noop
                // NO next yield !
            })()
            
            // ...middleware3
        })
        
        // ...middleware2
    })
    // ...middleware1
})()

其实看到这里就已经可以看到洋葱模型的样子了。

而最后就是这个next的运行,其实这个next就是一个Generator函数生成的迭代器(iterator)对象,然后由co来运行,类似下面

co(function*(){
    ...

    yield *next
})

co可以对generator的进行自执行。到这基本就完成可中间件的实现。

眼尖的读者可以看到这里最后用到了yield *而非yield,可以有关于co的执行,其实就是为了减少co的一次运行,其实每次都应该用yield *next,可能是tj大神怕大家忘记加了,就索性在demo里面就建议大家直接yield next就好了。具体的可以看我对于co源码实现的分析,我这里就提一下yield *可以自动执行后面的表达式的迭代器属性,而yield只会直接返回后面的表达式,所以一个yield *可以使co直接拿到后面迭代器中的每一步,而yield只可以拿到迭代器,然后递归调用co来执行迭代器。

最后欢迎大家吐槽,谢谢。

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

推荐阅读更多精彩内容