深入理解 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 window.opener返回父页面的应用
Oct 24 Javascript
Javascript中Eval函数的使用
Mar 23 Javascript
JS实现文字掉落效果的方法
May 06 Javascript
学习Javascript面向对象编程之封装
Feb 23 Javascript
jQuery Checkbox 全选 反选的简单实例
Nov 29 Javascript
Angular.js自定义指令学习笔记实例
Feb 24 Javascript
React中嵌套组件与被嵌套组件的通信过程
Jul 11 Javascript
详解如何在微信小程序中愉快地使用sass
Jul 30 Javascript
Vue函数式组件-你值得拥有
May 09 Javascript
关于layui 弹出层一闪而过就消失的解决方法
Sep 09 Javascript
Array.filter中如何正确使用Async
Nov 04 Javascript
vue-cli3.0修改打包后的文件名和文件地址,打包后本地运行报错解决
Apr 06 Vue.js
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/09/05 PHP
php上传apk后自动提取apk包信息的使用(示例下载)
2013/04/26 PHP
获取用户Ip地址通用方法与常见安全隐患(HTTP_X_FORWARDED_FOR)
2013/06/01 PHP
php+ajax实现图片文件上传功能实例
2014/06/17 PHP
PHP中通过fopen()函数访问远程文件示例
2014/11/18 PHP
浅谈laravel数据库查询返回的数据形式
2019/10/21 PHP
JavaScript中实现块作用域的方法
2010/04/01 Javascript
Uglifyjs(JS代码优化工具)入门 安装使用
2020/04/13 Javascript
不想让浏览器运行javascript脚本的方法
2015/11/20 Javascript
实例讲解jQuery EasyUI tree中state属性慎用
2016/04/01 Javascript
浅析angularJS中的ui-router和ng-grid模块
2016/05/20 Javascript
JS中页面与页面之间超链接跳转中文乱码问题的解决办法
2016/12/15 Javascript
JavaScript中发出HTTP请求最常用的方法
2018/07/12 Javascript
js的各种数据类型判断的介绍
2019/01/19 Javascript
vue+koa2实现session、token登陆状态验证的示例
2019/08/30 Javascript
解决Vue调用springboot接口403跨域问题
2019/09/02 Javascript
node.js中Buffer缓冲器的原理与使用方法分析
2019/11/23 Javascript
解决VUE 在IE下出现ReferenceError: Promise未定义的问题
2020/11/07 Javascript
利用Python演示数型数据结构的教程
2015/04/03 Python
解决Python出现_warn_unsafe_extraction问题的方法
2016/03/24 Python
numpy.ndarray 交换多维数组(矩阵)的行/列方法
2018/08/02 Python
python多线程实现TCP服务端
2019/09/03 Python
python使用itchat模块给心爱的人每天发天气预报
2019/11/25 Python
Python猴子补丁知识点总结
2020/01/05 Python
Pycharm 2020.1 版配置优化的详细教程
2020/08/07 Python
python em算法的实现
2020/10/03 Python
css3实现背景模糊的三种方式(小结)
2020/05/15 HTML / CSS
印度领先的眼镜电子商务网站:Lenskart
2019/12/16 全球购物
乌克兰设计师和品牌的服装:Love&Live
2020/04/14 全球购物
C++:局部变量能否和全局变量重名
2014/03/03 面试题
环境工程大学生个人的自我评价
2013/10/08 职场文书
小学教师岗位职责
2015/04/02 职场文书
大学生军训感言
2015/08/01 职场文书
进阶篇之linux环境下安装MySQL数据库
2022/04/09 MySQL
搭建Yolov5服务器
2022/04/30 Servers
Mysql如何查看是否使用到索引
2022/12/24 MySQL