深入理解 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 相关文章推荐
JavaScript 快捷键设置实现代码
Mar 13 Javascript
jQuery 选择表格(table)里的行和列及改变简单样式
Dec 15 Javascript
Javascript获取当前日期的农历日期代码
Oct 08 Javascript
jquery选择器需要注意的问题
Nov 26 Javascript
Bootstrap滚动监听(Scrollspy)插件详解
Apr 26 Javascript
深入浅出 jQuery中的事件机制
Aug 23 Javascript
BootStrapTable服务器分页实例解析
Dec 20 Javascript
JavaScript 数据类型详解
Mar 13 Javascript
Bootstrap 网格系统布局详解
Mar 19 Javascript
vue 组件销毁并重置的实现
Jan 13 Javascript
JSON stringify方法原理及实例解析
Oct 23 Javascript
antd的select下拉框因为数据量太大造成卡顿的解决方式
Oct 31 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
利用PHP制作简单的内容采集器的代码
2007/11/28 PHP
PHP实现获取图片颜色值的方法
2014/07/11 PHP
兼容ie、firefox的图片自动缩放的css跟js代码分享
2012/01/21 Javascript
js操作label给label赋值及取label的值示例
2013/11/07 Javascript
javascript 获取iframe里页面中元素值的方法
2014/02/17 Javascript
JavaScript中Function()函数的使用教程
2015/06/04 Javascript
浅谈JavaScript中null和undefined
2015/07/09 Javascript
Angular2安装angular-cli
2017/05/21 Javascript
jquery实现放大镜简洁代码(推荐)
2017/06/08 jQuery
关于Vue的路由权限管理的示例代码
2018/03/06 Javascript
React.js绑定this的5种方法(小结)
2018/06/05 Javascript
微信小程序scroll-view实现字幕滚动
2018/07/14 Javascript
Node.js中的不安全跳转如何防御详解
2018/10/21 Javascript
基于vue框架手写一个notify插件实现通知功能的方法
2019/03/31 Javascript
javascript将16进制的字符串转换为10进制整数hex
2020/03/05 Javascript
openlayers4实现点动态扩散
2020/08/17 Javascript
JavaScript函数柯里化实现原理及过程
2020/12/02 Javascript
python模块之sys模块和序列化模块(实例讲解)
2017/09/13 Python
Python中pandas dataframe删除一行或一列:drop函数详解
2018/07/03 Python
在python中获取div的文本内容并和想定结果进行对比详解
2019/01/02 Python
python添加模块搜索路径和包的导入方法
2019/01/19 Python
pyqt5 获取显示器的分辨率的方法
2019/06/18 Python
python中的decimal类型转换实例详解
2019/06/26 Python
python代码 FTP备份交换机配置脚本实例解析
2019/08/01 Python
python pycharm的安装及其使用
2019/10/11 Python
Python上下文管理器用法及实例解析
2019/11/11 Python
Python实现对adb命令封装
2020/03/06 Python
pandas apply多线程实现代码
2020/08/17 Python
Tiqets英国:智能手机上的文化和娱乐门票
2019/07/10 全球购物
最新的小工具和卓越的产品设计:Oh That Tech!
2019/08/07 全球购物
播音主持女孩的自我评价分享
2013/11/20 职场文书
竞聘副主任科员演讲稿
2014/01/11 职场文书
大学旷课检讨书
2014/01/28 职场文书
新闻发布会主持词
2014/03/28 职场文书
委托书怎么写
2014/07/31 职场文书
2015年见习期个人工作总结
2015/05/28 职场文书