深入koa源码(一):架构设计

专注前端与算法的系列干货分享,欢迎关注(¬‿¬):
「微信公众号:心谭博客」| xin-tan.com | GitHub

最近读了 koa 的源码,理清楚了架构设计与用到的第三方库。本系列将分为 3 篇,分别介绍 koa 的架构设计和 3 个核心库的原理,最终会手动实现一个简易的 koa

koa 的实现都在仓库的lib目录下,如下图所示,只有 4 个文件:

image

对于这四个文件,根据用途和封装逻辑,可以分为 3 类:req 和 res,上下文以及 application。

req 和 res

对应的文件是:request.jsresponse.js。分别代表着客户端请求信息和服务端返回信息。

这两个文件在实现逻辑上完全一致。对外暴露都是一个对象,对象上的属性都使用了gettersetter来实现读写控制。

上下文

对应的文件是:context.js。存了运行环境的上下文信息,例如cookies

除此之外,因为requestresponse都属于上下文信息,所以通过delegate.js库来实现了对request.jsresponse.js上所有属性的代理。例如以下代码:

/**
 * Response delegation.
 */
delegate(proto, "response")
  .method("attachment")
  .method("redirect");

/**
 * Request delegation.
 */

delegate(proto, "request")
  .method("acceptsLanguages")
  .method("acceptsEncodings");

使用代理的另外一个好处就是:更方便的访问 req 和 res 上的属性。比如在开发 koa 应用的时候,可以通过ctx.headers来读取客户端请求的头部信息,不需要写成ctx.res.headers了(这样写没错)。

注意:req 和 res 并不是在context.js中被绑定到上下文的,而是在application被绑定到上下文变量ctx中的。原因是因为每个请求的 req/res 都不是相同的。

Application

对应的文件是: application.js。这个文件的逻辑是最重要的,它的作用主要是:

  • 给用户暴露服务启动接口
  • 针对每个请求,生成新的上下文
  • 处理中间件,将其串联

对外暴露接口

使用 koa 时候,我们常通过listen或者callback来启动服务器:

const app = new Koa();
app.listen(3000); // listen启动
http.createServer(app.callback()).listen(3000); // callback启动

这两种启动方法是完全等价的。因为listen方法内部,就调用了callback,并且将它传给http.createServer。接着看一下callback这个方法主要做了什么:

  1. 调用koa-compose将中间件串联起来(下文再讲)。
  2. 生成传给http.createServer()的函数,并且返回。
  • http.createServer传给函数参数的请求信息和返回信息,都被这个函数拿到了。并且传给createContext方法,生成本次请求的上下文。
  • 将生成的上下文传给第 1 步生成的中间件调用链,这就是为什么我们在中间件处理逻辑的时候能够访问ctx

生成新的上下文

这里上下文的方法对应的是createContext方法。这里我觉得更像语法糖,是为了让 koa 使用者使用更方便。比如以下这段代码:

// this.request 是 request.js 暴露出来的对象,将其引用保存在context.request中
// 用户可以直接通过 ctx.属性名 来访问对应属性
const request = (context.request = Object.create(this.request));

// 这个req是本次请求信息,是由 http.createServer 传递给回调函数的
context.req = request.req = response.req = req;

读到这里,虽然可以解释 ctx.headersctx.request.headers 的语法糖这类问题。但是感觉怪怪的。就以这个例子,ctx.headers 访问的是 ctx.reqeust 上的 headers,而不是本次请求信息上的headers。本次请求信息挂在了ctx.req上。

让我们再回到reqeust.js的源码,看到了headers的 getter 实现:

get headers() {
  return this.req.headers;
}

ok,看来这里的this就是指的上下文环境咯。那么肯定是在application.js中某个地方改变了this的指向。果然,在application.js的构造函数中可以看到:

this.request = Object.create(request);

application 实例上的 request 被传递给了 context.request,此时 this 自然指向了 context。

可以看到,koa 为了让开发者使用方便,在上下文上做了很多工作。

中间件机制

中间件的设计是 koa 最重要的部分,实现上用到了koa-compose库来串联中间件,形成“洋葱模型”。关于这个库,放在第二篇关于 koa 核心库的介绍中说明。

application 中处理中间件的函数是usehandleRequest

  • use函数:传入async/await函数,并将其放入 application 实例上的middleware数组中。如果传入是 generator,会调用koa-conver库将其转化为async/await函数。
  • handleRequest(ctx, fnMiddleware)函数:传入的fnMiddleware是已经串联好的中间件,函数所做的工作就是再其后再添加一个返回给客户端的函数和错误处理函数。返回给客户端的函数其实就是respond函数,里面通过调用res.end()来向客户端返回信息,整个流程就走完了。

更多

专注前端与算法的系列干货分享,欢迎关注(¬‿¬)


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

推荐阅读更多精彩内容