深入理解 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不支持setTimeout/setInterval函数的第三个以上参数
May 25 Javascript
JQuery入门——用bind方法绑定事件处理函数应用介绍
Feb 05 Javascript
计算新浪Weibo消息长度(还可以输入119字)
Jul 02 Javascript
prototype.js常用函数详解
Jun 18 Javascript
jQuery继承extend用法详解
Oct 10 Javascript
AngularJS指令中的绑定策略实例分析
Dec 14 Javascript
Grunt针对静态文件的压缩,版本控制打包的实例讲解
Sep 29 Javascript
ES6入门教程之let、const的使用方法
Apr 13 Javascript
nuxt踩坑之Vuex状态树的模块方式使用详解
Sep 06 Javascript
layui实现图片虚拟路径上传,预览和删除的例子
Sep 25 Javascript
vue实现树状表格效果
Dec 29 Vue.js
JS+JQuery实现无缝连接轮播图
Dec 30 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
漂亮但不安全的CTB
2006/10/09 PHP
php实现数组筛选奇数和偶数示例
2014/04/11 PHP
Laravel实现批量更新多条数据
2020/04/06 PHP
实现复选框全选/全不选切换
2006/12/23 Javascript
ie与ff下的event事件使用介绍
2013/11/25 Javascript
jquery统计输入文字的个数并对其进行判断
2014/01/07 Javascript
jQuery实现切换页面过渡动画效果
2015/10/29 Javascript
javascript cookie基础应用之记录用户名的方法
2016/09/20 Javascript
prototype与__proto__区别详细介绍
2017/01/09 Javascript
AngularJs导出数据到Excel的示例代码
2017/08/11 Javascript
详解vuex中mapState,mapGetters,mapMutations,mapActions的作用
2018/04/13 Javascript
深入理解Vue router的部分高级用法
2018/08/15 Javascript
小程序组件之仿微信通讯录的实现代码
2018/09/12 Javascript
微信小程序定义和调用全局变量globalData的实现
2019/11/01 Javascript
js 函数性能比较方法
2020/08/24 Javascript
下载给定网页上图片的方法
2014/02/18 Python
Python判断变量是否为Json格式的字符串示例
2017/05/03 Python
利用Python-iGraph如何绘制贴吧/微博的好友关系图详解
2017/11/02 Python
Python父目录、子目录的相互调用方法
2019/02/16 Python
python取余运算符知识点详解
2019/06/27 Python
python pygame实现挡板弹球游戏
2019/11/25 Python
利用python对mysql表做全局模糊搜索并分页实例
2020/07/12 Python
Django实现简单的分页功能
2021/02/22 Python
Falconeri美国官网:由羊绒和羊毛制成的针织服装
2018/04/08 全球购物
理肤泉英国官网:La Roche-Posay英国
2019/01/14 全球购物
俄罗斯便宜的在线服装商店:GroupPrice
2020/04/10 全球购物
会计应聘求职信范文
2013/12/17 职场文书
创业计划书的主要内容有哪些
2014/01/29 职场文书
小学语文业务学习材料
2014/06/02 职场文书
农村党员对照检查材料
2014/09/24 职场文书
2014年小学辅导员工作总结
2014/12/23 职场文书
校园之声广播稿
2015/08/18 职场文书
2016学校元旦晚会经典开场白台词
2015/12/03 职场文书
Mysql基础知识点汇总
2021/05/26 MySQL
Python趣味挑战之教你用pygame画进度条
2021/05/31 Python
Java输出Hello World完美过程解析
2021/06/13 Java/Android