深入理解 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 相关文章推荐
使用js画图之正弦曲线
Jan 12 Javascript
js流动式效果显示当前系统时间
May 16 Javascript
微信小程序 后台https域名绑定和免费的https证书申请详解
Nov 10 Javascript
微信小程序购物商城系统开发系列-目录结构介绍
Nov 21 Javascript
深入理解AngularJS中的ng-bind-html指令
Mar 27 Javascript
简单谈谈关于Angular Cli打包的事
Sep 05 Javascript
vue2.0 资源文件assets和static的区别详解
Apr 08 Javascript
解决VUE中document.body.scrollTop为0的问题
Sep 15 Javascript
vue图片上传本地预览组件使用详解
Feb 20 Javascript
详解微信小程序之一键复制到剪切板
Apr 24 Javascript
iview form清除校验状态的实现
Sep 19 Javascript
详解Java中String JSONObject JSONArray List转换
Nov 13 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中判断文件存在使用is_file还是file_exists?
2015/04/03 PHP
在Z-Blog中运行代码[html][/html](纯JS版)
2007/03/25 Javascript
什么是JavaScript
2009/08/13 Javascript
Javascript 垃圾收集机制介绍理解
2013/05/14 Javascript
常用的JS验证和函数汇总
2014/12/23 Javascript
jQuery实现平滑滚动页面到指定锚点链接的方法
2015/07/15 Javascript
jqueryMobile使用示例分享
2016/01/12 Javascript
jquery ajax双击div可直接修改div中的内容
2016/03/04 Javascript
微信小程序 Tab页切换更新数据
2017/01/05 Javascript
基于vue.js轮播组件vue-awesome-swiper实现轮播图
2017/03/17 Javascript
jQuery Dom元素操作技巧
2018/02/04 jQuery
webpack4之如何编写loader的方法步骤
2019/06/06 Javascript
详解Vue中的基本语法和常用指令
2019/07/23 Javascript
JS随机密码生成算法
2019/09/23 Javascript
python获取一组数据里最大值max函数用法实例
2015/05/26 Python
Python爬虫抓取手机APP的传输数据
2016/01/22 Python
python妙用之编码的转换详解
2017/04/21 Python
Tensorflow之构建自己的图片数据集TFrecords的方法
2018/02/07 Python
python批量导入数据进Elasticsearch的实例
2018/05/30 Python
在pycharm上mongodb配置及可视化设置方法
2018/11/30 Python
python 变量初始化空列表的例子
2019/11/28 Python
如何在python开发工具PyCharm中搭建QtPy环境(教程详解)
2020/02/04 Python
tensorflow 分类损失函数使用小记
2020/02/18 Python
澳大利亚在线购买儿童玩具:Toy Universe
2017/12/28 全球购物
美国渔具店:FishUSA
2019/08/07 全球购物
澳洲的UGG雪地靴超级市场:Uggs.com.au
2020/04/06 全球购物
2014社区三八妇女节活动方案
2014/03/30 职场文书
我爱我家教学反思
2014/05/01 职场文书
大学生社会实践方案
2014/05/11 职场文书
预备党员介绍人意见
2015/06/01 职场文书
公司管理制度范本
2015/08/03 职场文书
《圆明园的毁灭》教学反思
2016/02/16 职场文书
Nginx快速入门教程
2021/03/31 Servers
Python深度学习之实现卷积神经网络
2021/06/05 Python
JavaScript如何优化逻辑判断代码详解
2021/06/08 Javascript
使用 MybatisPlus 连接 SqlServer 数据库解决 OFFSET 分页问题
2022/04/22 SQL Server