深入理解 Koa2 中间件机制

我们知道,Koa 中间件是以级联代码(Cascading) 的方式来执行的。类似于回形针的方式,可参照下面这张图:

今天这篇文章就来分析 Koa 的中间件是如何实现级联执行的。 在 koa 中,要应用一个中间件,我们使用 app.use():

先来看看use() 是什么,它的源码如下: use(fn) {

    if (typeof fn !== 'function') throw new TypeError('middleware must be a function!');

    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;

  }

这个函数的作用在于将调用use(fn)方法中的参数(不管是普通的函数或者是中间件)都添加到this.middlware这个数组中。

在Koa2中,还对Generator语法的中间件做了兼容,使用isGeneratorFunction(fn)这个方法来判断是否为Generator语法,并通过convert(fn)这个方法进行了转换,转换成async/await语法。然后把所有的中间件都添加到了this.middleware,最后通过callback()这个方法执行。callback() 源码如下:

源码中,通过compose()这个方法,就能将我们传入的中间件数组转换并级联执行,最后callback()返回this.handleRequest()的执行结果。返回的是什么内容我们暂且不关心,我们先来看看compose()这个方法做了什么事情,能使得传入的中间件能够级联执行,并返回Promise。

compose()是 koa2 实现中间件级联调用的一个库,叫做koa-compose。源码很简单,只有一个函数,如下:

可以看到compose()返回一个匿名函数的结果,该匿名函数自执行了dispatch()这个函数,并传入了0作为参数。

来看看dispatch(i)这个函数都做了什么事?i作为该函数的参数,用于获取到当前下标的中间件。在上面的dispatch(0)传入了0,用于获取middleware[0]中间件。

首先显示判断i<==index,如果true的话,则说明next()方法调用多次。为什么可以这么判断呢?等我们解释了所有的逻辑后再来回答这个问题。

接下来将当前的i赋值给index,记录当前执行中间件的下标,并对fn进行赋值,获得中间件

获得中间件后,怎么使用?

上面的代码执行了中间件fn(context, next),并传递了context和next函数两个参数。context就是koa中的上下文对象context。至于next函数则是返回一个dispatch(i+1)的执行结果。值得一提的是i+1这个参数,传递这个参数就相当于执行了下一个中间件,从而形成递归调用。这也就是为什么我们在自己写中间件的时候,需要手动执行

await next()

只有执行了next函数,才能正确得执行下一个中间件。

因此每个中间件只能执行一次next,如果在一个中间件内多次执行next,就会出现问题。回到前面说的那个问题,为什么说通过i<=index就可以判断next执行多次?

因为正常情况下index必定会小于等于i。如果在一个中间件中调用多次next,会导致多次执行dispatch(i+1)。从代码上来看,每个中间件都有属于自己的一个闭包作用域,同一个中间件的i是不变的,而index是在闭包作用域外面的。

当第一个中间件即dispatch(0)的next()调用时,此时应该是执行dispatch(1),在执行到下面这个判断的时候,

if (i <= index) return Promise.reject(new Error('next() called multiple times'))

此时的index的值是0,而i的值是1,不满足i<=index这个条件,继续执行下面的index=i的赋值,此时index的值为1。但是如果第一个中间件内部又多执行了一次next()的话,此时又会执行dispatch(2)。上面说到,同一个中间件内的i的值是不变的,所以此时i的值依然是1,所以导致了i <= index的情况。

可能会有人有疑问?既然async本身返回的就是Promise,为什么还要在使用Promise.resolve()包一层呢。这是为了兼容普通函数,使得普通函数也能正常使用。

再回到中间件的执行机制,来看看具体是怎么回事。我们知道async的执行机制是:只有当所有的await异步都执行完之后才能返回一个Promise。所以当我们用async的语法写中间件的时候,执行流程大致如下:

先执行第一个中间件(因为compose会默认执行dispatch(0)),该中间件返回Promise,然后被Koa监听,执行对应的逻辑(成功或失败)

在执行第一个中间件的逻辑时,遇到await next()时,会继续执行dispatch(i+1),也就是执行dispatch(1),会手动触发执行第二个中间件。这时候,第一个中间件await next()后面的代码就会被 pending,等待await next()返回Promise,才会继续执行第一个中间件await next()后面的代码。

同样的在执行第二个中间件的时候,遇到await next()的时候,会手动执行第三个中间件,await next()后面的代码依然被 pending,等待await下一个中间件的Promise.resolve。只有在接收到第三个中间件的resolve后才会执行后面的代码,然后第二个中间会返回Promise,被第一个中间件的await捕获,这时候才会执行第一个中间件的后续代码,然后再返回Promise

以此类推,如果有多个中间件的时候,会依照上面的逻辑不断执行,先执行第一个中间件,在await next()出 pending,继续执行第二个中间件,继续在await next()出 pending,继续执行第三个中间,直到最后一个中间件执行完,然后返回 Promise,然后倒数第二个中间件才执行后续的代码并返回Promise,然后是倒数第三个中间件,接着一直以这种方式执行直到第一个中间件执行完,并返回Promise,从而实现文章开头那张图的执行顺序。

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

推荐阅读更多精彩内容