指南

本指南涵盖的 Koa 主题不与 API 直接相关，例如编写中间件的最佳做法和应用程序结构建议。在这些例子中，我们使用 async 函数作为中间件 - 您也可以使用 commonFunction 或 generatorFunction，两者有些许不同。

编写中间件

Koa 中间件是简单的函数，它返回一个带有签名 (ctx, next) 的MiddlewareFunction。当中间件运行时，它必须手动调用 next() 来运行 “下游” 中间件。

例如，如果你想要跟踪通过添加 X-Response-Time 头字段通过 Koa 传播请求需要多长时间，则中间件将如下所示：

  1. async function responseTime(ctx, next) {
  2.   const start = Date.now();
  3.   await next();
  4.   const ms = Date.now() - start;
  5.   ctx.set('X-Response-Time', `${ms}ms`);
  6. }
  8. app.use(responseTime);

如果您是前端开发人员，您可以将 next(); 之前的任意代码视为“捕获”阶段，这个简易的 gif 说明了 async 函数如何使我们能够恰当地利用堆栈流来实现请求和响应流：

koa middleware

  1. 创建一个跟踪响应时间的日期
  2. 等待下一个中间件的控制
  3. 创建另一个日期跟踪持续时间
  4. 等待下一个中间件的控制
  5. 将响应主体设置为“Hello World”
  6. 计算持续时间
  7. 输出日志行
  8. 计算响应时间
  9. 设置 X-Response-Time 头字段
  10. 交给 Koa 处理响应

接下来，我们将介绍创建 Koa 中间件的最佳做法。

中间件最佳实践

本节介绍中间件创作最佳实践，例如中间件接受参数，命名中间件进行调试等等。

中间件参数

当创建公共中间件时，将中间件包装在接受参数的函数中，遵循这个约定是有用的，允许用户扩展功能。即使您的中间件 不 接受任何参数，这仍然是保持统一的好方法。

这里我们设计的 logger 中间件接受一个 format 自定义字符串，并返回中间件本身：

  1. function logger(format) {
  2.   format = format || ':method ":url"';
  4.   return async function (ctx, next) {
  5.     const str = format
  6.       .replace(':method', ctx.method)
  7.       .replace(':url', ctx.url);
  9.     console.log(str);
  11.     await next();
  12.   };
  13. }
  15. app.use(logger());
  16. app.use(logger(':method :url'));

命名中间件

命名中间件是可选的，但是在调试中分配名称很有用。

  1. function logger(format) {
  2.   return async function logger(ctx, next) {
  4.   };
  5. }

将多个中间件与 koa-compose 相结合

有时您想要将多个中间件 “组合” 成一个单一的中间件，便于重用或导出。你可以使用 koa-compose

  1. const compose = require('koa-compose');
  3. async function random(ctx, next) {
  4.   if ('/random' == ctx.path) {
  5.     ctx.body = Math.floor(Math.random() * 10);
  6.   } else {
  7.     await next();
  8.   }
  9. };
  11. async function backwards(ctx, next) {
  12.   if ('/backwards' == ctx.path) {
  13.     ctx.body = 'sdrawkcab';
  14.   } else {
  15.     await next();
  16.   }
  17. }
  19. async function pi(ctx, next) {
  20.   if ('/pi' == ctx.path) {
  21.     ctx.body = String(Math.PI);
  22.   } else {
  23.     await next();
  24.   }
  25. }
  27. const all = compose([random, backwards, pi]);
  29. app.use(all);

响应中间件

中间件决定响应请求，并希望绕过下游中间件可以简单地省略 next()。通常这将在路由中间件中，但这也可以任意执行。例如，以下内容将以 “two” 进行响应，但是所有三个都将被执行，从而使下游的 “three” 中间件有机会操纵响应。

  1. app.use(async function (ctx, next) {
  2.   console.log('>> one');
  3.   await next();
  4.   console.log('<< one');
  5. });
  7. app.use(async function (ctx, next) {
  8.   console.log('>> two');
  9.   ctx.body = 'two';
  10.   await next();
  11.   console.log('<< two');
  12. });
  14. app.use(async function (ctx, next) {
  15.   console.log('>> three');
  16.   await next();
  17.   console.log('<< three');
  18. });

以下配置在第二个中间件中省略了next()，并且仍然会以 “two” 进行响应，然而，第三个（以及任何其他下游中间件）将被忽略：

  1. app.use(async function (ctx, next) {
  2.   console.log('>> one');
  3.   await next();
  4.   console.log('<< one');
  5. });
  7. app.use(async function (ctx, next) {
  8.   console.log('>> two');
  9.   ctx.body = 'two';
  10.   console.log('<< two');
  11. });
  13. app.use(async function (ctx, next) {
  14.   console.log('>> three');
  15.   await next();
  16.   console.log('<< three');
  17. });

当最远的下游中间件执行 next(); 时，它实际上是一个 noop 函数，允许中间件在堆栈中的任意位置正确组合。

异步操作

Async 方法和 promise 来自 Koa 的底层，可以让你编写非阻塞序列代码。例如，这个中间件从 ./docs 读取文件名，然后在将给 body 指定合并结果之前并行读取每个 markdown 文件的内容。

  1. const fs = require('mz/fs');
  3. app.use(async function (ctx, next) {
  4.   const paths = await fs.readdir('docs');
  5.   const files = await Promise.all(paths.map(path => fs.readFile(`docs/${path}`, 'utf8')));
  7.   ctx.type = 'markdown';
  8.   ctx.body = files.join('');
  9. });

调试 Koa

Koa 以及许多构建库，支持来自 debug 的 DEBUG 环境变量，它提供简单的条件记录。

例如，要查看所有 koa 特定的调试信息，只需通过 DEBUG=koa*，并且在启动时，您将看到所使用的中间件的列表。

  1. $ DEBUG=koa* node --harmony examples/simple
  2.   koa:application use responseTime +0ms
  3.   koa:application use logger +4ms
  4.   koa:application use contentLength +0ms
  5.   koa:application use notfound +0ms
  6.   koa:application use response +0ms
  7.   koa:application listen +0ms

由于 JavaScript 在运行时没有定义函数名，你也可以将中间件的名称设置为 ._name。当你无法控制中间件的名称时，这很有用。例如：

  1. const path = require('path');
  2. const serve = require('koa-static');
  4. const publicFiles = serve(path.join(__dirname, 'public'));
  5. publicFiles._name = 'static /public';
  7. app.use(publicFiles);

现在，在调试时不只会看到 “serve”，你也会看到：

  1.   koa:application use static /public +0ms