Koa源码分析(三) -- middleware机制的实现

时间:2021-07-19 14:19:36

Abstract

本系列是关于Koa框架的文章,目前关注版本是Koa v1。主要分为以下几个方面:

  1. Koa源码分析(一) -- generator
  2. Koa源码分析(二) -- co的实现
  3. Koa源码分析(三) -- middleware机制的实现

Koa概括

Koa是基于generator与co之上的新一代中间件框架,它的优势主要集中在以下几个方面

  1. 中间件机制
  2. 封装了request/response, context对象
  3. 使用yield,方便异步编程进行流程控制
  4. 在忽略同步或者异步的情况下,使用try catch可以获取程序运行中的异常(错误处理是服务端程序的核心)

示例代码

var Koa = require('koa');
var app = new Koa();
//添加中间件1
app.use(function *(next){
var start = new Date;
console.log("start=======1111");
yield next;
console.log("end =======1111");
var ms = new Date - start;
console.log('%s %s - %s', this.method, this.url, ms);
});
//添加中间件2
app.use(function *(){
console.log("start=======2222");
this.body = 'Hello World';
console.log("end =======2222");
}); app.listen(3000);
/*
start=======1111
start=======2222
end =======2222
end =======1111
GET / - 10
start=======1111
start=======2222
end =======2222
end =======1111
GET /favicon.ico - 5
*/

从上述代码中,我们添加了两个middleware,其中第一个middleware中有一个输入参数next,并通过yield进行调用。通过分析输出的log信息,不难发现,先运行middelware1中的yield之前的代码,然后进入到middleware2中运行,待middleware2运行结束后又回到middleware1中,并运行yield之后的代码。

由于app.use输入的是generator函数,如果熟悉generator函数的同学,或许会说,这是将middleware2作为middleware1中的next参数,依次调用多个generator函数。对,没错,实际运行就是这样的,但是koa框架是如何组织代码实现这样方面的调用,将地狱式调用的异步编程编程这样清晰的结构?请看下文的源码分析

源码分析

Application初始化

function Application() {
if (!(this instanceof Application)) return new Application;
this.env = process.env.NODE_ENV || 'development';
this.subdomainOffset = 2;
// 用于存放中间件,即generator对象
this.middleware = [];
this.proxy = false;
// 获得封装的上下文对象
this.context = Object.create(context);
// 获取封装的请求对象
this.request = Object.create(request);
// 获取封装的响应对象
this.response = Object.create(response);
}

启动服务

listen() {
debug('listen');
// 调用node原生中的创建服务
// 其中callback()是服务创建的核心,具体见下面分析
const server = http.createServer(this.callback());
// 开启服务的监听
return server.listen.apply(server, arguments);
}

添加中间件

app.use = function(fn){
if (!this.experimental) {
// es7 async functions are not allowed,
// so we have to make sure that `fn` is a generator function
assert(fn && 'GeneratorFunction' == fn.constructor.name, 'app.use() requires a generator function');
}
debug('use %s', fn._name || fn.name || '-');
// 将输入的fn依次push到middleware数组中
this.middleware.push(fn);
// 返回this,以便链式调用
return this;
};

node native 创建服务

app.callback = function(){
if (this.experimental) {
console.error('Experimental ES7 Async Function support is deprecated. Please look into Koa v2 as the middleware signature has changed.')
}
// 将中间件按照加入的顺序,实现yield的链式调用,即组织异步调用结构,详细见下面的compose
// co.wrap方法将generator函数转化为Promise
var fn = this.experimental ? compose_es7(this.middleware) : co.wrap(compose(this.middleware));
var self = this; if (!this.listeners('error').length) this.on('error', this.onerror); // 返回node native的请求处理函数
return function handleRequest(req, res){
res.statusCode = 404;
var ctx = self.createContext(req, res);
onFinished(res, ctx.onerror);
fn.call(ctx).then(function handleResponse() {
respond.call(ctx);
}).catch(ctx.onerror);
}
};

中间件异步构建

// 返回一个启动函数
function compose(middleware){
return function *(next){
if (!next) next = noop();
var i = middleware.length;
// 对中间件队列从后遍历,逐个获取对应的generator对象
while (i--) {
// 将后面的generator对象传递给前面中间件的generatorFunction
next = middleware[i].call(this, next);
}
// 返回一个yield,next指向第一个中间件的generator
return yield *next;
}
}
function *noop(){}

这样,我们就从返回的启动函数(generator函数)的yield处指向第一个中间件,然后从之前while循环构成的从前往后的调用链,依次调用下一个中间件,直至最后一个中间件然后再返回。

这边我们再次回到callback()这个启动函数处,调用co.wrap()实现对generator函数的逐步调用。

Koa源码分析(三) -- middleware机制的实现的更多相关文章

  1. Koa源码分析(二) -- co的实现

    Abstract 本系列是关于Koa框架的文章,目前关注版本是Koa v1.主要分为以下几个方面: Koa源码分析(一) -- generator Koa源码分析(二) -- co的实现 Koa源码分 ...

  2. Koa源码分析(一) -- generator

    Abstract 本系列是关于Koa框架的文章,目前关注版本是Koa v1.主要分为以下几个方面: 1. Koa源码分析(一) -- generator 2. Koa源码分析(二) -- co的实现 ...

  3. 使用react全家桶制作博客后台管理系统 网站PWA升级 移动端常见问题处理 循序渐进学.Net Core Web Api开发系列【4】:前端访问WebApi [Abp 源码分析]四、模块配置 [Abp 源码分析]三、依赖注入

    使用react全家桶制作博客后台管理系统   前面的话 笔者在做一个完整的博客上线项目,包括前台.后台.后端接口和服务器配置.本文将详细介绍使用react全家桶制作的博客后台管理系统 概述 该项目是基 ...

  4. kernel 3.10内核源码分析--hung task机制

    kernel 3.10内核源码分析--hung task机制 一.相关知识: 长期以来,处于D状态(TASK_UNINTERRUPTIBLE状态)的进程 都是让人比较烦恼的问题,处于D状态的进程不能接 ...

  5. tomcat源码分析(三)一次http请求的旅行-从Socket说起

    p { margin-bottom: 0.25cm; line-height: 120% } tomcat源码分析(三)一次http请求的旅行 在http请求旅行之前,我们先来准备下我们所需要的工具. ...

  6. 【Zookeeper】源码分析之Watcher机制(三)之Zookeeper

    一.前言 前面已经分析了Watcher机制中的大多数类,本篇对于ZKWatchManager的外部类Zookeeper进行分析. 二.Zookeeper源码分析 2.1 类的内部类 Zookeeper ...

  7. ABP源码分析三:ABP Module

    Abp是一种基于模块化设计的思想构建的.开发人员可以将自定义的功能以模块(module)的形式集成到ABP中.具体的功能都可以设计成一个单独的Module.Abp底层框架提供便捷的方法集成每个Modu ...

  8. 【Zookeeper】源码分析之Watcher机制(一)

    一.前言 前面已经分析了Zookeeper持久话相关的类,下面接着分析Zookeeper中的Watcher机制所涉及到的类. 二.总体框图 对于Watcher机制而言,主要涉及的类主要如下. 说明: ...

  9. 【Zookeeper】源码分析之Watcher机制(二)

    一.前言 前面已经分析了Watcher机制中的第一部分,即在org.apache.zookeeper下的相关类,接着来分析org.apache.zookeeper.server下的WatchManag ...

随机推荐

  1. 【BZOJ】【1011】【HNOI2008】遥远的行星

    神奇的思路题QAQ 玛雅看到这题我就醉了,什么玩意……5%的误差?果断膜拜@ydc神犇的题解: 就是因为不清楚如何应用那个答案误差不超过5%啦. 从没见过这么诡异的题一下就懵了,问到了方法之后都还半信 ...

  2. 机器学习系列(17)_Yelper推荐系统

     1. 我们为什么需要推荐系统?“推荐”可是个当红话题.Netflix愿意用百万美金召求最佳的电影推荐算法,Facebook也为了登陆时的推荐服务开发了上百个项目,遑论现在市场上各式各样的应用都需要个 ...

  3. 上传jar包到Apache Archiva本地仓库

    1.登录archiva,点击左侧的upload Artifact 2 jar 包名称 为:java-client-4.1.2.jar 网上的pom配置为: <!-- https://mvnrep ...

  4. 三分钟教你学Git&lpar;十六&rpar; - 统计

    有时候想统计仓库的情况,比方代码量.贡献者之类的. 1 统计某人的commit数量 git log --author="$(git config --get user.name)" ...

  5. screen printing

    https://www.youtube.com/watch?v=kWKOgHaze0s sample website provide http://midwestsign.com/index.asp ...

  6. Django之Session

    Django  -- Seeion介绍 问:       Django的session是什么? 答:       Django 完全支持匿名 Session的. Session 框架允许每一个用户保存 ...

  7. js数组操作-添加,删除

    js 数组操作常用方法. push():在数组后面加入元素,并返回数组的长度 unshift():在数组前面加入元素,并返回数组的长度 pop()删除最后一个元素 shift()删除第一个元素 var ...

  8. QT生成随机数

    QT生成随机数和C语言差距不大,C语言用srand()和rand(),QT是用Qsrand()和qrand(): QT生成随机数的格式是: qsrand(QTime(0,0,0).secsTo(QTi ...

  9. React文档(二十二)context

    React中,通过React组件可以很容易地追踪数据流.当你关注一个组件,你可以发现哪一个props被传递了,这样使得你的应用很容被推断. 在一些情况下,你想要传递数据通过组件树而不需要去手动在每一层 ...

  10. Python数据信号处理库RadioDSP&colon; 引入ThinkDSP实现思想

    RadioDSP是针对无线通信领域的数字信号处理库,它采用了ThinkDSP的思想,对于无线通信中的IQ信号可以绘制频谱图和时域图.目前项目还在起始阶段,详细的代码可以参考链接: https://gi ...