koa-express – koa 的中间件系统-JavaScript中文网-JavaScript教程资源分享门户

Koa 是一个 Node.js 的 Web 框架，提供了一套易用的 Web 开发接口。与 Express 相比，它更加轻量、简单和灵活。而 Koa 的中间件系统则是 Koa 做到这一点的关键。

在本文中，我们将探讨 Koa 的中间件系统，包括它的定义、使用方法、常见用例以及实际示例。

什么是中间件？

中间件是一种在 Web 应用程序中用于处理 HTTP 请求和响应的软件组件。通常，中间件是从客户端发出请求时被调用的，然后依次处理请求的不同阶段，最后将响应返回给客户端。

在 Express 中，中间件是绑定请求对象(req)和响应对象(res)之间的一个函数。每当服务器收到一个请求，它就会依次执行所有注册的中间件，直到一个中间件函数将请求和响应转发给下一个中间件或直接返回响应为止。

Koa 的中间件系统与 Express 的本质相同，但语法略有不同。

Koa 的中间件系统

首先，我们来看一下 Koa 中的中间件是如何定义的：

const Koa = require(‘koa’);

const app = new Koa();

app.use(async (ctx, next) => {
  await next();
  ctx.body = ‘Hello, World!’;
});

可以看到，一个 Koa 中间件是一个返回 Promise 的异步函数，其中 ctx 代表请求上下文，next 是一个参数，它调用下一个中间件。

实际上，Koa 中的中间件函数可以有多个参数，如下所示：

app.use(async (ctx, next) => {
  const start = Date.now();
  await next();
  const ms = Date.now() - start;
  ctx.set('X-Response-Time', `${ms}ms`);
});

在这个示例中，中间件函数在请求处理结束后添加了一个 X-Response-Time 头，用于记录请求处理时间。

Koa 的中间件使用方法

有了前面的知识储备，我们可以开始实际使用 Koa 的中间件了。

我们可以使用 app.use() 方法来定义中间件，并将其添加到 Koa 应用程序中。例如，下面的代码定义了一个打印请求地址的中间件：

app.use(async (ctx, next) => {
  console.log(`${ctx.request.method} ${ctx.request.url}`);
  await next();
});

这个中间件将打印所有请求的 HTTP 方法和 URL。

我们还可以使用多个中间件来处理不同的请求。在这种情况下，我们需要按顺序添加它们，以确保它们按顺序执行。

app.use(logger);
app.use(authentication);
app.use(router.routes());

在这个示例中，logger 中间件负责记录请求日志，authentication 中间件负责验证用户身份并设置用户状态，router 则负责路由和响应请求。

Koa 的中间件常见用例

实际上，Koa 的中间件可以实现许多不同的功能，包括但不限于以下几种：

记录请求日志

app.use(async (ctx, next) => {
  const start = Date.now();
  await next();
  const ms = Date.now() - start;
  console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
});

这个中间件将请求的 HTTP 方法、URL 和处理时间记录在控制台上。

认证用户身份

// www.javascriptcn.com code example
app.use(async (ctx, next) => {
  const token = ctx.headers.authorization;
  if (!token) {
    ctx.throw(401, 'Unauthorized');
  }
  const decoded = jwt.decode(token, secret);
  if (!decoded) {
    ctx.throw(401, 'Unauthorized');
  }
  const user = await db.findOne({ _id: decoded.id });
  ctx.state.user = user;
  await next();
});

这个中间件验证请求是否有 JWT 认证标头，如果有则解密标头并存储用户信息。否则，中间件将通过抛出 ERR 实现失败代码。

处理错误

// www.javascriptcn.com code example
app.use(async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    ctx.status = err.status || 500;
    ctx.body = {
      message: err.message
    };
  }
});

这个中间件负责捕获所有错误，并将错误信息在响应中返回。

Koa 的中间件示例代码

以下是一个完整的 Koa 应用程序，它包括一个日志记录器和一个简单的路由器：

// www.javascriptcn.com code example
const Koa = require('koa');
const Router = require('koa-router');

const app = new Koa();
const router = new Router();

// 记录请求日志
app.use(async (ctx, next) => {
  const start = Date.now();
  await next();
  const ms = Date.now() - start;
  console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
});

// 接口
router.get('/hello', (ctx) => {
  ctx.body = 'Hello, World!';
});

app.use(router.routes());
app.use(router.allowedMethods());

app.listen(3000, () => {
  console.log('Server listening on port 3000');
});

这个应用中定义了一个简单的路由，并在控制台上记录了所有请求的 HTTP 方法、URL 和处理时间。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/67c56146cf1e9924e1cda8c4

koa-express – koa 的中间件系统