深入理解 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 解疑
Nov 11 Javascript
iframe调用父页面函数示例详解
Jul 17 Javascript
JavaScript中的标签语句用法分析
Feb 10 Javascript
基于jquery实现三级下拉菜单
May 10 Javascript
用jQuery向div中添加Html文本内容的简单实现
Jul 13 Javascript
Javascript 实现计算器时间功能详解及实例(二)
Jan 08 Javascript
微信小程序 详解下拉加载与上拉刷新实现方法
Jan 13 Javascript
详解vue-cli快速构建项目以及引入bootstrap、jq
May 26 Javascript
BootStrap中Table隐藏后显示问题的实现代码
Aug 31 Javascript
利用纯js + transition动画实现移动端web轮播图详解
Sep 10 Javascript
图文讲解vue的v-if使用方法
Feb 11 Javascript
vue 详情跳转至列表页实现列表页缓存
Mar 27 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
收音机术语解释
2021/03/01 无线电
PHP正则表达式之定界符和原子介绍
2012/10/05 PHP
使用淘宝IP库获取用户ip地理位置
2013/10/27 PHP
PHP调用VC编写的COM组件实例
2014/03/29 PHP
ThinkPHP框架安全实现分析
2016/03/14 PHP
php实现根据身份证获取精准年龄
2020/02/26 PHP
php解析非标准json、非规范json的方式实例
2020/12/10 PHP
Javascript中设置默认参数值示例
2014/09/11 Javascript
jQuery Ajax使用FormData上传文件和其他数据后端web.py获取
2017/06/11 jQuery
vuex学习之Actions的用法详解
2017/08/29 Javascript
Vue render深入开发讲解
2018/04/13 Javascript
基于ts的动态接口数据配置的详解
2019/12/18 Javascript
JavaScript 空间坐标的使用
2020/08/19 Javascript
[11:57]《一刀刀一天》第十七期:TI中国军团加油!
2014/05/26 DOTA
Python中使用tarfile压缩、解压tar归档文件示例
2015/04/05 Python
python列表操作之extend和append的区别实例分析
2015/07/28 Python
用TensorFlow实现lasso回归和岭回归算法的示例
2018/05/02 Python
python调用Matplotlib绘制分布点并且添加标签
2018/05/31 Python
关于python2 csv写入空白行的问题
2018/06/22 Python
Python面向对象程序设计构造函数和析构函数用法分析
2019/04/12 Python
Pytorch抽取网络层的Feature Map(Vgg)实例
2019/08/20 Python
Python绘图实现显示中文
2019/12/04 Python
Python3常见函数range()用法详解
2019/12/30 Python
ansible-playbook实现自动部署KVM及安装python3的详细教程
2020/05/11 Python
Python 存取npy格式数据实例
2020/07/01 Python
详解Html5微信支付爬坑之路
2018/07/24 HTML / CSS
推荐WEB开发者最佳HTML5和CSS3代码生成器
2015/11/24 HTML / CSS
基于HTML5+tracking.js实现刷脸支付功能
2020/04/16 HTML / CSS
家用个人磨皮机:Trophy Skin
2017/03/30 全球购物
New Balance法国官方网站:购买鞋子和服装
2019/09/01 全球购物
关于颐和园的导游词
2015/01/30 职场文书
2015毕业生简历自我评价
2015/03/02 职场文书
2015年项目经理工作总结
2015/04/30 职场文书
2015年学校禁毒工作总结
2015/05/27 职场文书
思想品德课教学反思
2016/02/24 职场文书
Python Socket编程详解
2021/04/25 Python