深入理解 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 相关文章推荐
Jquery弹出窗口插件 LeanModal的使用方法
Mar 10 Javascript
iframe父页面获取子页面参数的方法
Feb 21 Javascript
javascript实现十六进制颜色值(HEX)和RGB格式相互转换
Jun 20 Javascript
jQuery验证插件validation使用指南
Apr 21 Javascript
DIV随滚动条滚动而滚动的实现代码【推荐】
Apr 12 Javascript
Javascript 调用 ActionScript 的简单方法
Sep 22 Javascript
原生JS实现幻灯片
Feb 22 Javascript
vue-cli项目如何使用vue-resource获取本地的json数据(模拟服务端返回数据)
Aug 04 Javascript
基于vue2.x的电商图片放大镜插件的使用
Jan 22 Javascript
在node中使用jwt签发与验证token的方法
Apr 03 Javascript
bootstrap table插件动态加载表头
Jul 19 Javascript
jQuery实现简单聊天室
Feb 08 jQuery
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 判断常量,变量和函数是否存在
2009/04/26 PHP
phpcms模块开发之swfupload的使用介绍
2013/04/28 PHP
通过Email发送PHP错误的方法
2015/07/20 PHP
PHP5.3新特性小结
2016/02/14 PHP
JQUERY 浏览器判断实现函数
2009/08/20 Javascript
两个listbox实现选项的添加删除和搜索
2013/03/01 Javascript
JS实现金额转换(将输入的阿拉伯数字)转换成中文的实现代码
2013/09/30 Javascript
JS方法调用括号的问题探讨
2014/01/24 Javascript
微信小程序  简单实例(阅读器)的实例开发
2016/09/29 Javascript
js对字符串进行编码的方法总结(推荐)
2016/11/10 Javascript
BootStrap 实现各种样式的进度条效果
2016/12/07 Javascript
BootStrap Validator 根据条件在JS中添加或移除校验操作
2017/10/12 Javascript
bootstrap select下拉搜索插件使用方法详解
2017/11/23 Javascript
使用 Node.js 开发资讯爬虫流程
2018/01/07 Javascript
Bootstrap-table自定义可编辑每页显示记录数
2018/09/07 Javascript
详解Node.js amqplib 连接 Rabbit MQ最佳实践
2019/01/24 Javascript
Python 代码性能优化技巧分享
2012/08/07 Python
python冒泡排序算法的实现代码
2013/11/21 Python
Python ORM框架SQLAlchemy学习笔记之数据添加和事务回滚介绍
2014/06/10 Python
使用Python的Flask框架实现视频的流媒体传输
2015/03/31 Python
仅用50行Python代码实现一个简单的代理服务器
2015/04/08 Python
Python在图片中添加文字的两种方法
2017/04/29 Python
解决已经安装requests,却依然提示No module named requests问题
2018/05/18 Python
python 在屏幕上逐字显示一行字的实例
2018/12/24 Python
用Python批量把文件复制到另一个文件夹的实现方法
2019/08/16 Python
python PIL/cv2/base64相互转换实例
2020/01/09 Python
css3媒体查询中device-width和width的区别详解
2020/03/27 HTML / CSS
html Table 表头固定的实现
2019/01/22 HTML / CSS
花园仓库建筑:Garden Buildings Direct
2018/02/16 全球购物
班组长的岗位职责
2013/12/09 职场文书
老人节标语大全
2014/10/08 职场文书
2014年大学教师工作总结
2014/12/02 职场文书
2015年审计人员工作总结
2015/05/26 职场文书
《伯牙绝弦》教学反思
2016/02/16 职场文书
深度学习tensorflow基础mnist
2021/04/14 Python
SQL bool盲注和时间盲注详解
2022/07/23 SQL Server