深入理解 Koa 框架中间件原理


Posted in Javascript onOctober 18, 2018

Node 主要用在开发 Web 应用,koa 是目前 node 里最流行的 web 框架。

在 Node 开启一个 http 服务简直易如反掌,官网 demo。

const http = require("http");

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

const hostname = "127.0.0.1";
const port = 3000;
server.listen(port, hostname, () => {
 console.log(`Server running at http://${hostname}:${port}/`);
});
  • 引入 http 模块, http 的 createServer 方法创建了一个 http.Server 的实例。
  • server 监听 3000 端口。
  • 我们传入到 createServer 里的函数实际是监听 request 事件的回调,每当请求进来,监听函数就会执行。
  • request 事件的监听函数,其函数接受两个参数,分别是 req 和 res 。其中 req 是一个可读流, res 是一个可写流。我们通过 req 获取 http 请求的所有信息,同时将数据写入到 res 来对该请求作出响应。

koa 应用

koa 如何创建一个 server, 直接上个官网的例子

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

// x-response-time

app.use(async (ctx, next) => {
 const start = Date.now();
 await next();
 const ms = Date.now() - start;
 ctx.set("X-Response-Time", `${ms}ms`);
});

// logger

app.use(async (ctx, next) => {
 const start = Date.now();
 await next();
 const ms = Date.now() - start;
 console.log(`${ctx.method} ${ctx.url} - ${ms}`);
});

// response

app.use(async ctx => {
 ctx.body = "Hello World";
});

app.listen(3000);

中间件概念在编程中使用广泛, 不管是前端还是后端, 在实际编程中或者框架设计都有使用到这种实用的模型。

基本上,Koa 所有的功能都是通过中间件实现的。

每个中间件默认接受两个参数,第一个参数是 Context 对象,第二个参数是 next 函数。只要调用 next 函数,就可以把执行权转交给下一个中间件。

如果中间件内部没有调用 next 函数,那么执行权就不会传递下去。

多个中间件会形成一个栈结构(middle stack),以“先进后出”(first-in-last-out)的顺序执行。整个过程就像,先是入栈,然后出栈的操作。

上面代码的执行顺序是:

请求 ==> x-response-time 中间件 ==> logger 中间件 ==> response中间件 ==> logger 中间件 ==> response-time 中间件 ==> 响应

理解 Koa 的中间件机制(源码分析)

阅读源码,化繁为简,我们看看 koa 的中间件系统是如何实现的。

class Application extends Emitter {
 constructor() {
  super();
  this.middleware = [];
 },

 use(fn) {
  this.middleware.push(fn);
  return this;
 },

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

  return function(req, res) {
   return fn(ctx);
  };
 },

 listen(...args) {
  const server = http.createServer(this.callback());
  return server.listen(...args);
 }
}

好了,精简结束,一不小心,去枝末节,最后只剩下不到 20 行代码。

这就是框架的核心,简化后的代码非常清晰,有点不可思议,但核心就是这么简单。

我们先分析以上代码做了什么事。

  • 我们定义了一个 middleware 数组来存储中间件。
  • 我们定一个了一个 use 方法来注册一个中间件。其实就是简单的 push 到自身的 mideware 这个数组中。
  • 我们还使用了一个 compose 方法,传入 middleware ,应该是做了一些处理,返回了一个可执行的方法。

你一定对中间的 compose 方法很好奇,初此之外的代码都容易理解,唯独这个 compose 不太知道究竟做了什么。

其实, compose 就是整个中间件框架的核心。

compose 之外,代码已经很清楚的定义了

  • 中间件的存储
  • 中间件的注册

而 compose 方法做了最为重要的一件事

  • 中间件的执行

核心源码 compose

先上码

function compose(middleware) {
 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);
   }
  }
 };
}

我试图去简化一下这个方法,但方法本身已经足够简洁。

代码很简洁。

通过 next()传递 实现中间件调用, 结合 Promise 采用 递归调用 的通知机制。

看图

深入理解 Koa 框架中间件原理

这种形式的控制流让整个 Koa 框架中间件的访问呈现出 自上而下的中间件流 + 自下而上的 response 数据流 的形式。

Koa 本身做的工作仅仅是定制了中间件的编写规范,而不内置任何中间件。一个 web request 会通过 Koa 的中间件栈,来动态完成 response 的处理。

koa 在中间件语法上面采用了 async + await 语法来生成 Promise 形式的程序控制流。

总结

koa 是非常精简的框架, 其中的精粹思想就是洋葱模型(中间件模型), koa 框架的中间件模型非常好用并且简洁, 但是也有自身的缺陷, 一旦中间件数组过于庞大, 性能会有所下降,我们需要结合自身的情况与业务场景作出最合适的选择.

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
[IE&amp;FireFox兼容]JS对select操作
Jan 07 Javascript
动态样式类封装JS代码
Sep 02 Javascript
JavaScript实现两个Table固定表头根据页面大小自行调整
Jan 03 Javascript
兼容最新firefox、chrome和IE的javascript图片预览实现代码
Aug 08 Javascript
javascript实现二级级联菜单的简单制作
Nov 19 Javascript
AngularJS实现单独作用域内的数据操作
Sep 05 Javascript
使用JQuery中的trim()方法去掉前后空格
Sep 16 Javascript
正则 js分转元带千分符号详解
Mar 08 Javascript
Vue cli 引入第三方JS和CSS的常用方法分享
Jan 20 Javascript
详解Angularjs 自定义指令中的数据绑定
Jul 19 Javascript
对angularJs中ng-style动态改变样式的实例讲解
Sep 30 Javascript
基于Web Audio API实现音频可视化效果
Jun 12 Javascript
JS实现十分钟倒计时代码实例
Oct 18 #Javascript
基于Vue实现可以拖拽的树形表格实例详解
Oct 18 #Javascript
JavaScript的词法结构精华篇
Oct 17 #Javascript
Javascript中parseInt的正确使用方式
Oct 17 #Javascript
教你如何编写Vue.js的单元测试的方法
Oct 17 #Javascript
详解vue如何使用rules对表单字段进行校验
Oct 17 #Javascript
Vue绑定内联样式问题
Oct 17 #Javascript
You might like
基于jQuery的星级评分插件
2011/08/12 Javascript
js下获得客户端操作系统的函数代码(1:vista,2:windows7,3:2000,4:xp,5:2003,6:2008)
2011/10/31 Javascript
Javascript动态创建div的方法
2015/02/09 Javascript
JavaScript中用于生成随机数的Math.random()方法
2015/06/15 Javascript
JQuery统计input和textarea文字输入数量(代码分享)
2016/12/29 Javascript
js阻止移动端页面滚动的两种方法
2017/01/25 Javascript
node.js操作mysql简单实例
2017/05/25 Javascript
微信浏览器禁止页面下拉查看网址实例详解
2017/06/28 Javascript
vue中设置height:100%无效的问题及解决方法
2018/07/27 Javascript
jQuery+PHP实现上传裁剪图片
2020/06/29 jQuery
使用JavaScript解析URL的方法示例
2019/03/01 Javascript
express如何解决ajax跨域访问session失效问题详解
2019/06/20 Javascript
关于vue表单提交防双/多击的例子
2019/10/31 Javascript
Vue 通过公共字段,拼接两个对象数组的实例
2019/11/07 Javascript
跟老齐学Python之编写类之一创建实例
2014/10/11 Python
Python自动调用IE打开某个网站的方法
2015/06/03 Python
python实现的简单RPG游戏流程实例
2015/06/28 Python
利用python计算windows全盘文件md5值的脚本
2019/07/27 Python
Python3 虚拟开发环境搭建过程(图文详解)
2020/01/06 Python
PyCharm第一次安装及使用教程
2020/01/08 Python
python数据爬下来保存的位置
2020/02/17 Python
将labelme格式数据转化为标准的coco数据集格式方式
2020/02/17 Python
python对数组进行排序,并输出排序后对应的索引值方式
2020/02/28 Python
解决更改AUTH_USER_MODEL后出现的问题
2020/05/14 Python
利用Python实现Excel的文件间的数据匹配功能
2020/06/16 Python
巴西婴儿用品商店:Bebe Store
2017/11/23 全球购物
Toppik顶丰增发纤维官网:解决头发稀疏
2017/12/30 全球购物
理肤泉加拿大官网:La Roche-Posay加拿大
2018/07/06 全球购物
金融专业个人求职信
2013/09/22 职场文书
幼儿师范毕业生自荐信
2013/11/09 职场文书
酒店销售主管岗位职责
2014/01/04 职场文书
信息科学与技术专业求职信范文
2014/02/20 职场文书
民警个人对照检查剖析材料
2014/09/17 职场文书
社会体育专业大学生职业生涯规划书
2014/09/17 职场文书
旅行社计调工作总结
2015/08/12 职场文书
Python借助with语句实现代码段只执行有限次
2022/03/23 Python