十分钟带你看完 KOA 源码

前段时间看了 koa 源码,得益于 koa 良好抽象,不仅提供了简洁的 api ,同时也使得源码相当的简洁和优雅。今天花点时间画了一张 koa 源码的结构图来分析其源码,在总结的同时,希望能够帮到相关的同学。

注:源码是基于 2.x 版本,源码结构与 1.x 完全一致,代码更加简洁直观一点。

基础知识

任何用过 node 的人对下面的代码都不会陌生,如下:

const http = require(‘http‘);

const server = http.createServer((req, res) => {
res.statusCode = 200;
res.setHeader(‘Content-Type‘, ‘text/plain‘);
res.end(‘Hello World\n‘);
});

server.listen(3000);

上面的代码很简单,http 的 createServer 方法创建了一个 http.Server 的实例,http.Sever继承于 EventEmitter 类。我们传入的函数,其实是添加到了 server 的 request 事件中,相当于一种快捷方式。所以你也完全可以不传入任何参数,然后手动去监听 request 事件。代码的最后将 server 绑定到 3000 端口,开始监听所有来自 3000 端口的请求。

然后,我们看一下 request 事件的监听函数,其函数接受两个参数,分别是 req 和 res。其中 req 是一个可读流,res 是一个可写流。我们通过 req 获取该请 http 请求的所有信息,同时将数据写入到 res 来对该请求作出响应。

以上就是所有你需要知道的基础知识,是不是很简单?

koa 源码解读

分析源码之前,先直观看一下 koa 如何创建一个 server:

const Koa = require(‘koa‘);
const app = new Koa();

app.use(ctx => {
ctx.body = ‘Hello Koa‘;
});

app.listen(3000);

现在,我们由上面这段简单的代码开始深入到 koa 源码,在分析源码之前,我直接放上文章开头提到的示意图,以便我们结合示意图进行分析。

image
构造函数
首先我们创建了 Koa 的实例 app,其构造函数十分简单,如下:

constructor() {
super();
this.proxy = false;
this.middleware = [];
this.subdomainOffset = 2;
this.env = process.env.NODE_ENV || ‘development‘;
this.context = Object.create(context);
this.request = Object.create(request);
this.response = Object.create(response);
}

结合示意图,这个代码很简单,其中 context 、request 和 response 就是 3 个字面量形式创建的简单对象,上面封装了一些列方法(其实绝大部分是属性的赋值器(setter)和取值器(getter)),暂时不用管它们。就像示意图所示,他们将作为 app 相应属性的原型。

值得一提的是 Application 是继承于 EventEmitter,如下:

class Application extends Emitter { //... }

中间件
接下来使用 use 的方法注册一个中间件,其实就是简单的 push 到自身的 mideware 这个数组中。如下:

use(fn) {
// 省略了一点点校验参数性质的代码
this.middleware.push(fn);
return this;
}

启动应用

核心的代码在 listen 这个方法,但是它做的事件也很简单。我们已经知道,通过向 http.createServer 传递一个函数作为参数的形式来创建其的一个实例,其实 app.listen 里面就做了这个一个事情,源码依旧十分简单:

listen() {
const server = http.createServer(this.callback());
return server.listen.apply(server, arguments);
}

唯一需要我们关注的就是这个 this.callback ,也是理解 koa 应用的核心所在。

this.callback() 执行的结果肯定是一个函数,根据我们基础知识,这个函数无非就是根据 req 获取信息,同时向 res 中写入数据而已。

那么这个函数具体是怎么做的呢?首先,它基于 req 和 res 封装出我们中间件所使用的 ctx 对象,再将 ctx 传递给中间件所组合成的一个嵌套函数。中间件组合的嵌套函数返回的是一个 Promise 的实例,等到这个组合函数执行完( resolve ),通过 ctx 中的信息(例如 ctx.body )想 res 中写入数据,执行过程中出错 (reject),这调用默认的错误处理函数。

原理还是很简单,看一下代码:

callback() {

const fn = compose(this.middleware);

if (!this.listeners(‘error‘).length) this.on(‘error‘, this.onerror);

return (req, res) => {
res.statusCode = 404;
const ctx = this.createContext(req, res);
const onerror = err => ctx.onerror(err);
onFinished(res, onerror);
fn(ctx).then(() => respond(ctx)).catch(onerror);
};

}

就像我们分析的一样,callback 首先会将我们的中间件组合成为一个嵌套函数供返回的函数执行时调用。createContext 根据 req 和 res 封装中间件所需要的 ctx。onFinished 是确保一个流在关闭、完成和报错时都会执行相应的回调函数。onerror 就是我们错误处理函数,最后分析。respond 就是我们根据 ctx 中的数据,然后集中的向 res 中写入数据,响应 http 请求。代码很简单但是有点长,就不贴出来了。

现在核心是 createContext 是如何封装出 ctx 的,直接看源码,因为太简单了:

createContext(req, res) {
const context = Object.create(this.context);
const request = context.request = Object.create(this.request);
const response = context.response = Object.create(this.response);

context.app = request.app = response.app = this;
context.req = request.req = response.req = req;
context.res = request.res = response.res = res;
request.ctx = response.ctx = context;
// 省略一点无关紧要的代码
return context;
}

简单的说就是创建了3个简单的对象,并且将他们的原型指定为我们 app 中对应的对象。然后将原生的 req 和 res 赋值给相应的属性,就完成了。

如我们示意图,整个 Koa 的结构就完整了。

但是,ctx 上不是暴露出来很多属性吗?它们在哪?他们就在我们示意图的最右边,一开始我们略过的 3 个简单对象。通过原型链的形式,我们 ctx.request 所能访问属性和方法绝大部分都在其对应的 request 这个简单的对象上面。request 又是怎么封装的呢?我只需要简单的贴一点源码,大家就秒懂了。

···
module.exports = {
//...
get method() {
return this.req.method;
},

set method(val) {
this.req.method = val;
}
//...
}
···

所以你访问 http://ctx.request.xxx 属性都是定义在右边 resquest 这个简单对象上的属性的赋值器(setter)和取值器(getter)。

response 同理,也就不再赘述。

值得一提的是右边 context 这个对象上面只提供了极少的方法,其他属性都是简单的代理到自身的 request 和 response 这两个对象上。

错误处理

最后简单的分析一下错误处理,由之前 callback 中的源码我们可以看到,app 会默认注册一个错误处理函数。

if (!this.listeners(‘error‘).length) this.on(‘error‘, this.onerror);

但是我们每次 http 请求的错误其实是交个 ctx.onerror 处理的:

const onerror = err => ctx.onerror(err);
onFinished(res, onerror);
fn(ctx).then(() => respond(ctx)).catch(onerror);

onFinished 是确保一个流在关闭、完成和报错时都会执行相应的回调函数。ctx.onerror 这个函数在参数为空或者 null 的时候,直接返回,不会做任何操作。

if (null == err) return;

否则,则会触发 app 产生一个错误事件。

this.app.emit(‘error‘, err, this);

然后如果判断该请求处理依旧没有结束,也就是 app 注册的 onerror 事件没有结束该请求,则会尝试向客户端产生一个 500 的错误。判断方式:

if (this.headerSent || !this.writable) {
err.headerSent = true;
return;
}

总结起来,我们可以在不同的抽象层次上处理错误。比如,我们可以在顶层的中间件将所有中间件产生的错误捕获并处理了,这样错误就不会被上层捕获。我们也可以覆盖 ctx.onerror 的方式来捕获所有的异常,而且可以不触发 app 的 error 事件。最后我们当然也可以直接监听 app 的 error 事件的方式来处理错误。

最后的话
如文章开头所言,koa 恰当的抽象,不仅提供了简洁实用的 api ,同时也使得源码相当的简洁和优雅。虽然文章标题为看完 koa 源码,但实际上并没有对 response 和 request 封装的细枝末节进行详细的阐述,如果你看懂了这边文章,再去看源码应该就得心应手了。

最后如果阐述不清楚,或者不恰到的地方欢迎反馈。

原文地址:https://blog.51cto.com/14516511/2433318

时间: 2024-10-31 04:35:14

十分钟带你看完 KOA 源码的相关文章

一口气看完驴友源码

自学安卓也有一年时间了,很快到了要找工作的时候了,但是自己还只做了一个项目,怎么办?听前辈们说,找别人的源码研究,于是,说干就干,我这次找了网上找的一个驴友的源码,和大家讲解下里面的实现思路,帮助大家更快看完一个源码.为了读者方面,我也把这个源码贴出来,有兴趣的朋友根据步骤一步一步来. 我们把这个软件安装完成后,发现里面的功能分为四个模块:旅游记忆,结伴游,好友/关注者,其他功能.其中,数其他功能里面的子模块数最多,所以我们从最多的讲起. 用户注册:这个功能整体上来说就是在安卓端填写信息提交到服

十分钟带你看懂比特币的运行原理

有一种货币目前价值成百上千美元 ,但不是由金子.铂金或任何贵重金属制造的,这就是比特币,那么比特币的原理是什么呢? 针对不方便打开视频的小伙伴,CDA字幕组也贴心的整理了文字版本,如下: 假设有一种货币目前价值成百上千美元 ,但不是由金子.铂金或任何贵重金属制造的,实际上这不是你能放在手中或存钱罐中的钱币. 这是数字货币,意味着它只以电子的形式存在. 我说的就是比特币,比特币的原理与大多数货币很不一样. 它不依附于国家或政府,因此它没有中央发行机构或监管机构.这意味着没有组织机构决定:什么时候要

30分钟 带你浅入requirejs源码

因为最近项目想现实一个单页功能,用的是react ,然后看了一下react route,挖槽 gzip后16k? 然后我简单写了一个纯单页(不支持多页的单页,所有入口都经过rewrite跑到index.html) 才200多行(后续放github). 然后项目是用webpack打包的, 发现webpack的 require.ensure不支持变量加载的(至少暂时没发现), 就是意味着我有多小页面,就得在main(入口里配多小页面的关系)  这样挫,领导会喷我的. 然后我今天早上起来,想看看req

Chrome自带恐龙小游戏的源码研究(完)

在上一篇<Chrome自带恐龙小游戏的源码研究(七)>中研究了恐龙与障碍物的碰撞检测,这一篇主要研究组成游戏的其它要素. 游戏分数记录 如图所示,分数及最高分记录显示在游戏界面的右上角,每达到100分就会出现闪烁特效,游戏第一次gameover时显示历史最高分.分数记录器由DistanceMeter构造函数实现,以下是它的全部代码: 1 DistanceMeter.dimensions = { 2 WIDTH: 10, //每个字符的宽度 3 HEIGHT: 13, //每个字符的高 4 DE

最新时时彩投注网站完整版源码,集成多彩种带WAP手机版

这是最新仿牛采纽约育乐彩票网站完整版源码,集成多彩种,比较适合时时彩的网站开发和建设,喜欢这方面的网站建设的朋友可以了解一下,带WAP手机端配置环境:  php5.2+Mysql 适用范围: 最新仿牛采纽约育乐彩票网站完整版源码,集成多彩种,漂亮大气UI,WAP手机端,开奖工具.虽然我从来不调试发布涉及到彩票这些的源码,但是这次发现的这个程序确实非常好看: <ignore_js_op> <ignore_js_op> <ignore_js_op> <ignore_j

koa源码阅读[2]-koa-router

koa源码阅读[2]-koa-router 第三篇,有关koa生态中比较重要的一个中间件:koa-router 第一篇:koa源码阅读-0第二篇:koa源码阅读-1-koa与koa-compose koa-router是什么 首先,因为koa是一个管理中间件的平台,而注册一个中间件使用use来执行.无论是什么请求,都会将所有的中间件执行一遍(如果没有中途结束的话)所以,这就会让开发者很困扰,如果我们要做路由该怎么写逻辑? app.use(ctx => { switch (ctx.url) { c

koa源码阅读[3]-koa-send与它的衍生(static)

koa源码阅读的第四篇,涉及到向接口请求方提供文件数据. 第一篇:koa源码阅读-0第二篇:koa源码阅读-1-koa与koa-compose第三篇:koa源码阅读-2-koa-router 处理静态文件是一个繁琐的事情,因为静态文件都是来自于服务器上,肯定不能放开所有权限让接口来读取.各种路径的校验,权限的匹配,都是需要考虑到的地方.而koa-send和koa-static就是帮助我们处理这些繁琐事情的中间件.koa-send是koa-static的基础,可以在NPM的界面上看到,static

koa源码解读

koa是有express原班人马打造的基于node.js的下一代web开发框架.koa 1.0使用generator实现异步,相比于回调简单和优雅和不少.koa团队并没有止步于koa 1.0, 随着node.js开始支持async/await,他们又马不停蹄的发布了koa 2.0,koa2完全使用Promise并配合async/await来实现异步,使得异步操作更臻完美. 一.快速开始 koa使用起来非常简单,安装好node.js后执行以下命令安装koa: npm init npm instal

Chrome自带恐龙小游戏的源码研究(六)

在上一篇<Chrome自带恐龙小游戏的源码研究(五)>中实现了眨眼睛的恐龙,这一篇主要研究恐龙的跳跃. 恐龙的跳跃 游戏通过敲击键盘的Spacebar或者Up来实现恐龙的跳跃.先用一张图来表示整个跳跃的过程: 首先规定向下为正方向,即重力加速度(g)为正,起跳的速度(v)为负,恐龙距离画布上方的距离为yPos: 每一帧动画中,速度都会与重力加速度相加得到新的速度,再用新的速度与yPos相加得到新的yPos,改变恐龙的位置为新的yPos,表现出来为yPos不断减小: 当恐龙升至最高点,此时速度为