阅读好的框架的源码有很多好处,从大神的视角去理解整个框架的设计思想。大到架构设计,小到可取的命名风格,还有设计模式、实现某类功能使用到的数据结构和算法等等。

使用koa

其实某个框架阅读源码的时候,首先我们要会去用这个框架,因为用了我们才知道,某个API是怎么用,哪里有坑,哪里设计的精妙。

下面我们就简单用一下koa这个框架,如下代码


const Koa = require('koa')
const app = new Koa()
app.use(async (ctx, next) => {ctx.body = 'Hello World'
})
app.listen(4002)

运行结果

瓦特??这个服务会涉及到从请求到响应返回数据,就这几行代码?? 是的,你没有看错,就是单单这几行代码就可以搭建了一个服务器。

下面我们看看一探究竟。

阅读源码

去到node_modules文件夹下找到koa模块,先喵几眼README.md文件,里面介绍了koa的一些安装、用法、插件等等,这里我们跳过,然后转到package.json如下图

看到package.json里面的"main": "lib/application.js"没错,这就是我们的入口,在lib文件夹下面,我们看到里面有application.jscontext.jsrequrest.jsresponse.js。下面经过我修改简化去掉注释application.js就只有68行代码。阅读起来可以说是非常简单了。如下图:

第一步是我们引入各种主要依赖

// 引入有很多 我只挑我阅读主要框架的代码模块const response = require('./response'); // 处理response对象
const compose = require('koa-compose'); // 合并处理中间件函数
const context = require('./context'); // 整合处理context对象
const request = require('./request'); // 整合处理request对象
const http = require('http'); // node的 http原生模块

以上就是我们的主要依赖

Application的对象中,有constructor函数,这个主要是初始化Application对象,生成context对象、request对象、response对象

module.exports = class Application extends Emitter {// 初始化 Applicationconstructor() {super(); // 继承Emitterthis.middleware = []; // 初始化middleware为空数组this.context = Object.create(context); // 生成context对象this.request = Object.create(request); // 生成request对象this.response = Object.create(response); // 生成response对象}
}

阅读源码,我们先不要去扣细节,比如说Object.create(context)生产的对象是什么?this.request对象下面又有什么东西???,我们现在主要知道的是、this.context是能获取或者设置请求和响应的信息的一个对象,。this.request是请求的对象、里面可以设置或者获取请求信息的一个对象、this.response是响应请求对象、里面可以设置或者获取响应参数和值的一个对象。大概先了解就可以了。继续往下看。

在上面运用的时候,用到了app.use(fn)app.listen(4002) 我们看看,源码里面试这样子的


module.exports = class Application extends Emitter {// 初始化 Applicationconstructor() {...}listen(...args) {const server = http.createServer(this.callback());return server.listen(...args);}use(fn) {this.middleware.push(fn);return this;}

上面的代码很简单 use函数就是把传入的fn 推入到this.middleware的数组中,然后返回this,方便链式调用。

然后在listen里面用node原生的http模块创建一个server,在这里顺便说一下,原生 http创建一个服务是这样子滴

const http = http.createServer((req, res) => {res.writeHead(200, { 'Content-Type': 'text/plain' });res.end('okay');
});
http.listen(8000)

继续看代码 ,在创建服务的时候,参数里面调用了一个this.callback()函数,下面我们看看这个函数究竟是怎么样子的。


module.exports = class Application extends Emitter {// 初始化 Applicationconstructor() {...}listen(...args) {...}use(fn) {...}callback() {const fn = compose(this.middleware); // 集中处理中间件数组const handleRequest = (req, res) => {const ctx = this.createContext(req, res); // 整合req、res、context、request、responsereturn this.handleRequest(ctx, fn); // 返回handleRequest};return handleRequest;}handleRequest(ctx, fnMiddleware) {const handleResponse = () => respond(ctx); // 最终响应函数return fnMiddleware(ctx).then(handleResponse) // 处理完中间件,然后传到下一响应函数}// 创建整合新的 context.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;request.response = response;response.request = request;context.originalUrl = request.originalUrl = req.url;context.cookies = new Cookies(req, res, {keys: this.keys,secure: request.secure});request.ip = request.ips[0] || req.socket.remoteAddress || '';context.accept = request.accept = accepts(req);context.state = {};return context;}
};

上面我们可以看出在callback函数里面有一个const fn = compose(this.middleware); 这个函数就是把this.middleware数组传进去,然后集中处理中间件,然后会返回处理完中间件的fn。

继续下一行

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

继续进入到handleRequest函数里面的const ctx = this.createContext(req, res);这个把原生的http的请求对象req响应对象res作为参数传进去,然后在createContext函数(看上面最大那坨代码)在里面,把this.requestthis.responsethis.context请求对象req响应对象res都整,做各种整合、处理得到新的context对象返回出去。

也就是强大的ctx,得到ctx之后,下一行返回return this.handleRequest(ctx, fn);

this.handleRequest(ctx, fn)代码如下


handleRequest(ctx, fnMiddleware) {const handleResponse = () => respond(ctx);return fnMiddleware(ctx).then(handleResponse).catch(onerror);
}

这个函数 就是处理完中间件处理之后的返回的函数把ctx传下去,最后流通到respond(ctx);这个函数,

那么我们看看这个函数被我简化后是怎么样子的,如下

// 一些容错判断或者提示我全部删了
function respond(ctx) {const res = ctx.res;let body = ctx.body;res.end(body);
}

通过ctx拿到响应对象,和响应值、通过end方法会通知服务器,所有响应头和响应主体都已被发送,即服务器将其视为已完成。看上面原生的http的服务方法。

最后附上一个流程图

这个只是介绍application整个流程,还有很多细节都没有一一介绍到,比如、创建contextrequestresponse对象是怎么样子的呀?中间件是如何集中层层深入处理然后返回的呀?等等这些细节都会在下一篇会讲到(最近公司业务非常忙,不知道到猴年马月)。

写的不好的地方,让大家贱笑了。

然后最后安利一波博客,喜欢的小哥哥小姐姐可以star 哟

websit: https://github.com/naihe138/naice-blog

一步步去阅读koa源码,整体架构分析相关推荐

  1. 学习 redux 源码整体架构,深入理解 redux 及其中间件原理

    如果觉得内容不错,可以设为星标置顶我的公众号 1. 前言 你好,我是若川.这是学习源码整体架构系列第八篇.整体架构这词语好像有点大,姑且就算是源码整体结构吧,主要就是学习是代码整体结构,不深究其他不是 ...

  2. 学习 axios 源码整体架构,打造属于自己的请求库

    前言 这是学习源码整体架构系列第六篇.整体架构这词语好像有点大,姑且就算是源码整体结构吧,主要就是学习是代码整体结构,不深究其他不是主线的具体函数的实现.本篇文章学习的是实际仓库的代码. 学习源码整体 ...

  3. 学习 launch-editor 源码整体架构,探究 vue-devtools「在编辑器中打开组件」功能实现原理...

    1. 前言 你好,我是若川[1],微信搜索「若川视野」关注我,专注前端技术分享,一个愿景是帮助5年内前端开阔视野走向前列的公众号.欢迎加我微信ruochuan12,长期交流学习. 这是学习源码整体架构 ...

  4. 学习underscore源码整体架构,打造属于自己的函数式编程类库

    前言 上一篇文章写了 jQuery整体架构,学习 jQuery 源码整体架构,打造属于自己的 js 类库 虽然看过挺多 underscore.js分析类的文章,但总感觉少点什么.这也许就是纸上得来终觉 ...

  5. 学习 vuex 源码整体架构,打造属于自己的状态管理库

    前言 这是学习源码整体架构第五篇.整体架构这词语好像有点大,姑且就算是源码整体结构吧,主要就是学习是代码整体结构,不深究其他不是主线的具体函数的实现.本篇文章学习的是实际仓库的代码. 其余四篇分别是: ...

  6. 学习 sentry 源码整体架构,打造属于自己的前端异常监控SDK

    前言 这是学习源码整体架构第四篇.整体架构这词语好像有点大,姑且就算是源码整体结构吧,主要就是学习是代码整体结构,不深究其他不是主线的具体函数的实现.文章学习的是打包整合后的代码,不是实际仓库中的拆分 ...

  7. 学习 lodash 源码整体架构,打造属于自己的函数式编程类库

    前言 这是 学习源码整体架构系列第三篇.整体架构这词语好像有点大,姑且就算是源码整体结构吧,主要就是学习是代码整体结构,不深究其他不是主线的具体函数的实现.文章学习的是打包整合后的代码,不是实际仓库中 ...

  8. 学习 jQuery 源码整体架构,打造属于自己的 js 类库

    虽然现在基本不怎么使用 jQuery了,但 jQuery流行 10多年的 JS库,还是有必要学习它的源码的.也可以学着打造属于自己的 js类库,求职面试时可以增色不少. 本文章学习的是 v3.4.1版 ...

  9. vuex 源码整体架构学习

    前言 这是学习源码整体架构第五篇.整体架构这词语好像有点大,姑且就算是源码整体结构吧,主要就是学习是代码整体结构,不深究其他不是主线的具体函数的实现.本篇文章学习的是实际仓库的代码. 其余四篇分别是: ...

最新文章

  1. java kafka api_kafka java API的使用
  2. RabbitMQ支持的消息模型
  3. AAAI 2020 | NAS+目标检测:AI设计的目标检测模型长啥样?
  4. 深入理解 Angular 变化检测(change detection)
  5. SAP Spartacus入口Component - StorefrontComponent
  6. when is OData model initialized - finally found done by Framework
  7. 计算机系统的可靠性可以用什么来表示,系统分析师考试计算机系统的可靠性指标...
  8. python读取excel写入mysql pandas_python pandas 读取文件 写入文件excel
  9. Centos7 安装oracle数据库
  10. t-sql查询where in_产品操作MySQL第7篇 – 运算符 - IN
  11. Visual Studio 窗口的图标、图片资源 $this.Icon 在哪查看
  12. 【GDB源码编译】GDB源码编译
  13. 蒸汽管道图纸符号_供热循环系统“30问”(附管网图常见符号图例)
  14. 阿里云ECS建网站(建站)超详细全套完整图文教程!菜鸟必看!
  15. 洛谷5339 BZOJ5510 TJOI2019 唱、跳、rap和篮球 容斥 dp 组合数
  16. 一键获取网页MP3音乐播放源文件
  17. 2020-10-31
  18. 利用Karabiner和键盘修饰键修改MAC键盘,实现打字时双手不离开字母和数字区
  19. 项目管理中软件项目文档的分类管理
  20. 南开大学的计算机类专业,南开大学计算机专业

热门文章

  1. [经验教程]iPhone苹果手机上怎么使用微信支付123元开通爱奇艺京东plus联名会员?
  2. 网吧加速浏览器解压软件最新免费版
  3. private static PHP,PHP延时静态绑定以及self 和 static 的区别 | 剑花烟雨江南
  4. 使用Windows系统自带的库去掉SDK库对openssl的依赖
  5. 谈一谈交通大脑——智慧城市背后的王牌!
  6. 5 个提供创作灵感的网站(一)
  7. eWorld.ASP.NET.Maker.v2016.0.2.x86-DARKSiDERS
  8. SharePoint 2013 引发类型为“System.ArgumentException”的异常。 参数名: encodedValue
  9. java 后端实现页面跳转
  10. selenium实现企查查自动登录