首先,在app.js中new Koa()
,生成Koa
实例,所以在koa
包中会有个构造函数,负责生成实例:
module.exports = class Application extends Emitter {
constructor(options) {
super();
options = options || {};
...
this.middleware = []; // 中间件数组
this.context = Object.create(context); // 创建上下文对象context,以及请求和响应对象
this.request = Object.create(request);
this.response = Object.create(response);
...
}
}
app.js
中,最后的代码总是会创建一个服务,用listen
监听一个网络端口;
在构造函数中会发现createServer
的参数是callback
这个函数的返回值:
listen(...args) {
debug('listen');
// 参数为一个函数,createServer会传入req和res
const server = http.createServer(this.callback());
return server.listen(...args);
}
callback
也在Koa
构造函数中:
callback() {
const fn = compose(this.middleware);
if (!this.listenerCount('error')) this.on('error', this.onerror);
const handleRequest = (req, res) => {
// 接收http.createServer传入的req和res,通过createContext生成ctx上下文对象
const ctx = this.createContext(req, res);
return this.handleRequest(ctx, fn);
};
return handleRequest;
}
handleRequest
函数:
handleRequest(ctx, fnMiddleware) {
const res = ctx.res;
res.statusCode = 404;
const onerror = err => ctx.onerror(err);
const handleResponse = () => respond(ctx);
onFinished(res, onerror);
// fnMiddleware为callback中经过compose处理的中间件方法fn
return fnMiddleware(ctx).then(handleResponse).catch(onerror);
}
核心方法还是在compose
函数中(dispatch
的中文意思是调度,说明该方法主要功能是调度各个中间件的执行):
function compose (middleware) {
// middleware为koa构造函数中经过处理的中间件数组
if (!Array.isArray(middleware)) throw new TypeError('Middleware stack must be an array!')
for (const fn of middleware) {
if (typeof fn !== 'function') throw new TypeError('Middleware must be composed of functions!')
}
/**
* @param {Object} context
* @return {Promise}
* @api public
*/
// ↓ 运行时才会执行,可以看到匿名函数中的dispatch是递归执行的
// 通过断点调试可以看到此时next是undefined,因为handleRequest函数中只传入了一个ctx
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 {
// fn为中间件并在Promise.resolve中开始执行
// 中间件中的next为dispatch方法
// 使用bind预设dispatch的参数i,其中i处于闭包中,该变量保持引用
// compose的返回值是一个Promise,所以当前中间件的结果依赖上一个中间件的异步结果的话
// 可以使用await next()等待上个中间件异步返回
return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
} catch (err) {
return Promise.reject(err)
}
}
}
}