node.js Koa 框架 的中间件用法

Posted 2021-04-10 悦码

Koa 的中间件通过一种更加传统（您也许会很熟悉）的方式进行级联，摒弃了以往 node 频繁的回调函数造成的复杂代码逻辑。 我们通过 generators 来实现“真正”的中间件。 Connect 简单地将控制权交给一系列函数来处理，直到函数返回。 与之不同，当执行到 yield next 语句时，Koa 暂停了该中间件，继续执行下一个符合请求的中间件('downstrem')，然后控制权再逐级返回给上层中间件('upstream')。

Logger 功能

Koa 的最大特色，也是最重要的一个设计，就是中间件（middleware）。为了理解中间件，我们先看一下 Logger （打印日志）功能的实现。

最简单的写法就是在main函数里面增加一行。

看下面的 test.js。

const main = ctx => {

  console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);

  ctx.response.body = 'Hello World';

};

运行上面的 test.js。访问 http://127.0.0.1:3000 ，命令行就会输出日志。

1502144902843 GET /

中间件的概念

上一个例子里面的 Logger 功能，可以拆分成一个独立函数。看下面的 logger.js 。

const logger = (ctx, next) => {

  console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);

  next();

}

app.use(logger);

像上面代码中的logger函数就叫做"中间件"（middleware），因为它处在 HTTP Request 和 HTTP Response 中间，用来实现某种中间功能。app.use()用来加载中间件。

基本上，Koa 所有的功能都是通过中间件实现的，前面例子里面的main也是中间件。每个中间件默认接受两个参数，第一个参数是 Context 对象，第二个参数是next函数。只要调用next函数，就可以把执行权转交给下一个中间件。

运行上面的demo，并访问查看效果。命令行窗口会显示与上一个例子相同的日志输出。

中间件栈

多个中间件会形成一个栈结构（middle stack），以"先进后出"（first-in-last-out）的顺序执行。

最外层的中间件首先执行。

调用next函数，把执行权交给下一个中间件。

最内层的中间件最后执行。

执行结束后，把执行权交回上一层的中间件。

最外层的中间件收回执行权之后，执行next函数后面的代码。

请看下面的demo。

const one = (ctx, next) => {

  console.log('>> one');

  next();

  console.log('<< one');

}

const two = (ctx, next) => {

  console.log('>> two');

  next();

  console.log('<< two');

}

const three = (ctx, next) => {

  console.log('>> three');

  next();

  console.log('<< three');

}

app.use(one);

app.use(two);

app.use(three);

运行上面这个 demo。我们发现命令行窗口中输出的内容和"先进后出"（first-in-last-out）的执行顺序一致。

如果中间件内部没有调用next函数，那么执行权就不会传递下去。

异步中间件

迄今为止，所有例子的中间件都是同步的，不包含异步操作。如果有异步操作（比如读取数据库），中间件就必须写成 async 函数。

看下面的 async.js 文件中的代码；

const fs = require('fs.promised');

const Koa = require('koa');

const app = new Koa();

const main = async function (ctx, next) {

  ctx.response.type = 'html';

  ctx.response.body = await fs.readFile('./demos/template.html', 'utf8');

};

app.use(main);

app.listen(3000);

上面代码中，fs.readFile是一个异步操作，必须写成await fs.readFile()，然后中间件必须写成 async 函数。

demo 的运行效果，大家自己执行一下。

中间件的合成

koa-compose模块可以将多个中件合成为一个。

看下面的 compose.js 文件中的代码。

const compose = require('koa-compose');

const logger = (ctx, next) => {

  console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);

  next();

}

const main = ctx => {

  ctx.response.body = 'Hello World';

};

const middlewares = compose([logger, main]);

app.use(middlewares);

demo 效果我就不在说了。