【源码】Koa2源码阅读: 中间件机制

源码阅读

上次一篇说到callback中使用了compose,现在看看里面都做了什么。

  callback() {
    const fn = compose(this.middleware);

    if (!this.listenerCount('error')) this.on('error', this.onerror);

    const handleRequest = (req, res) => {
      const ctx = this.createContext(req, res);
      return this.handleRequest(ctx, fn);
    };

    return handleRequest;
  }

中间件机制(洋葱模型):它实现中间件级联调用是借助 koa-compose
这个库来实现的。源码只有一个函数。

我们先看看没用compose时是怎么执行中间件的:

function add(x, y) {
  return x + y
}
function double(z) {
  return z * 2
}
const res1 = add(1, 2)
const res2 = double(res1)
console.log(res2)

// 或
const res3 = double(add(1,2))
console.log(res3)

double函数要等待add函数的执行结果,可以像上面那样写,但是当中间件一多的时候,代码就不够优雅了。

compose函数的作用就是将这些中间件整合在一起,然后利用闭包返回一个函数,然后我们直接执行返回的函数即可。

const middlewares = [add, double]
let len = middlewares.length

function compose(midds) {
  return (...args) => {
    // 初始值
    let res = midds[0](...args)
    for (let i = 1; i < len; i++) {
      res = midds[i](res)
    }
    return res
  }
}

const fn = compose(middlewares)
const res = fn(1,2)
console.log(res)

当然,上面的代码为了便于理解,都是同步的。下面看看compose的源码是怎么做的:

'use strict'

/**
 * Expose compositor.
 */

module.exports = compose

/**
 * Compose `middleware` returning
 * a fully valid middleware comprised
 * of all those which are passed.
 *
 * @param {Array} middleware
 * @return {Function}
 * @api public
 */

function compose (middleware) {
  if (!Array.isArray(middleware)) throw new TypeError('Middleware stack must be an array!')
  for (const fn of middleware) {
    if (typeof fn !== 'function') throw new TypeError('Middleware must be composed of functions!')
  }

  /**
   * @param {Object} context
   * @return {Promise}
   * @api public
   */

  return function (context, next) {
    // last called middleware #
    let index = -1
    return dispatch(0)

    function dispatch (i) {
      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 {
        return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
      } catch (err) {
        return Promise.reject(err)
      }
    }
  }
}

首先是对传入的middleware的一些检查。
compose返回的函数,就是callback中的fn。fn是个闭包,持有着对middleware的引用。fn中维护的index表示上次执行的中间件,dispatch是执行中间件的函数,dispatch也是个闭包,持有对index的引用。在上面的 dispatch(0) 传入了0,用于获取 middleware[0] 中间件。

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

      try {
        return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
      } catch (err) {
        return Promise.reject(err)
      }

上面的代码执行了中间件函数fn(context, dispatch.bind(null, i + 1)),并传递了 contextdispatch.bind(null, i + 1) 函数。

context 就是 koa 中的上下文对象 ctx。dispatch.bind(null, i + 1) 就是我们的next。值得一提的是 i+1 这个参数,传递这个参数就相当于执行了下一个中间件,从而形成递归调用。

这也就是为什么我们在自己写中间件的时候,要拿到next参数,然后再需要手动执行 next() ,即是执行了dispatch.bind(null, i + 1),只有执行了 next 函数,才能正确得执行下一个中间件。

每个中间件只能执行一次 next,如果在一个中间件内多次执行 next,就会出现问题。

每次执行 dispatch 前,index 必定会小于 i。第一次调用next()后,将i赋值给了index,此时index与i相等。

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

如果再次在这个中间件中调用next,会再次执行 dispatch(i+1)。此时i还是原来的i,而闭包外的index因为第一次的执行,已经是等于i的了。所以将执行:

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

导致报错,现在知道为什么同一个中间件中执行多次next()会报错了吧。


image.png

最后,递归调用完后,就执行next()后面的代码了,一张图很形象的说明:


image.png

至此,这就是我们koa的中间件机制(洋葱模型)。

实现

现在,我们来完善上一篇博客中的coa

application.js的类中直接加入compose函数源码。这时候,将use方法改为:

    use(callback) {
        // this.callback = callback
        this.middlewares.push(callback)
    }

使用use时先将中间件加入数组。
这个 this.middlewaresconstructor 中初始化为一个空数组:

this.middlewares = []

将listen方法改为:

    listen(...args) {
        const server = http.createServer(async (req, res) => {
            let ctx = this.createCtx(req, res)
            
            // await this.callback(ctx)
            const fn = this.compose(this.middlewares)
            await fn(ctx)
            ctx.res.end(ctx.body)
        })
        server.listen(...args)
    }

将中间件数组传入compose 中整合。
这样子,在我们的 server.js 中就可以这样用了:

const Coa = require('./coa2')
const app = new Coa()

app.use(async (ctx, next) => {
    ctx.body = '1'
    await next()
    ctx.body += '[1]'
})

app.use(async (ctx, next) => {
    ctx.body += '2'
    await next()
    ctx.body += '[2]'
})

app.use(async (ctx, next) => {
    ctx.body += '3'
    ctx.body += '[3]'
})


app.listen(8000, () => {
    console.log('coa!')
})

总结

感觉自己实现部分没啥用,把源码多看多练习才好,尤其是这种代码量少的。

参考

https://blog.csdn.net/qq673318522/article/details/79090682

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

推荐阅读更多精彩内容