理解 Koa 中的 ctx 对象-JavaScript中文网-JavaScript教程资源分享门户

Koa 是一个底层极简高效的 Node.js Web 框架，被广泛应用于前端类的 Web 开发中。在 Koa 应用程序中，ctx 对象是一个很关键的概念。本文将深入介绍 Koa 中 ctx 对象的含义和用法，并通过示例代码来指导读者更好地实践。

什么是 ctx 对象？

ctx 是一个包含了 HTTP 请求和响应的上下文(Context)对象，是 Koa 中最重要的对象之一。在每一个请求过程中，Koa 会创建一个新的 ctx 对象，并将其传递给中间件函数，中间件在处理请求时可以利用 ctx 对象获取请求相关的信息并产生响应。 ctx 对象包含了如下一系列主要属性：

ctx.req：Node.js 中的 http.IncomingMessage，封装了 HTTP 请求相关的信息，例如请求头和请求体，是一个可读流；
ctx.res：Node.js 中的 http.ServerResponse，封装了 HTTP 响应相关的信息，例如响应头和响应体，是一个可写流；
ctx.state：ctx.state 是一个 JavaScript 对象，用于储存那些通过不同的路由之间共享的变量和信息；
ctx.params：由 URL 匹配参数组成（如 /users/:id），参数解析器会将解析结果存入该对象；
ctx.query：由查询字符串组成；
ctx.request.body：POST 请求时 request body 中的参数，需要结合中间件 koa-bodyparser 进行解析；
ctx.cookies：提供了 cookie 的读取和写入功能；
ctx.throw()：抛出错误并中断请求；
ctx.redirect()：重定向到另一个 URL。

如何使用 ctx 对象？

在 Koa 的中间件函数中，我们可以通过 ctx 对象来进行请求的处理和相应的产生。以下是一个简单的中间件代码：

const Koa = require('koa');
const app = new Koa();

app.use(async (ctx) => {
  ctx.body  = 'Hello Koa';
});

该中间件函数接收 ctx 对象作为参数，并将一个字符串 Hello Koa 作为响应体返回。如果想要快速验证或调试 ctx 中的属性，可以在中间件处理函数中使用 console.log(ctx) 打印 ctx 对象。另外，Koa 的中间件可以链式调用，通过 app.use(callback) 方法实现。

可以用 `ctx` 对象做什么？

在实际开发中， ctx 对象可以用来处理类似以下情况的场景：

1. 处理计算

const Koa = require('koa');
const app = new Koa();

app.use(async (ctx) => {
  const sum = ctx.query.x + ctx.query.y;

  ctx.body  = `Sum of ${ctx.query.x} and ${ctx.query.y} is ${sum}`;
});

在该中间件函数中，我们对来自 URL 查询参数的 x 和 y 进行加法计算，并将结果返回作为响应。

2. 读写 cookies

const Koa = require('koa');
const app = new Koa();

app.use(async (ctx) => {
  const loggedIn = ctx.cookies.get('login');

  if (!loggedIn) {
    ctx.cookies.set('login', 'ok', { httpOnly: false });
    ctx.body = `Hello stranger! I've written a cookie for you.`;
  } else {
    ctx.body = `Hello again! You're already my friend.`;
  }
});

该中间件代码中，我们利用 ctx.cookies.get() 函数读取一个名为 login 的 cookie，并在后面的逻辑中根据 cookie 的存在与否返回不同的响应，并通过 ctx.cookies.set() 设置了一个新的名为 login 的 cookie。

3. 读写 HTTP headers

const Koa = require('koa');
const app = new Koa();

app.use(async (ctx) => {
  const ua = ctx.get('User-Agent');
  const isMobile = /Mobile|Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(ua);

  if (isMobile) {
    ctx.set('Content-Type', 'text/html; charset=utf-8');
    ctx.body = '<p>This is a mobile device.</p>';
  } else {
    ctx.body = 'Hello Web!';
  }
});

上面的代码通过 ctx.get() 获取并读取请求头中的 User-Agent 字段信息，再根据 User-Agent 判断当前设备是否为移动端，然后根据判断结果用 ctx.set() 设置响应头，并发回移动端设备的响应或其他设备的响应。

4. 错误处理

const Koa = require('koa');
const app = new Koa();

app.use(async (ctx) => {
  try {
    const n = Number.parseInt(ctx.query.n);

    if (n <= 0) {
      throw new Error('Invalid parameter n');
    } else {
      const factorial = factorial(n);
      ctx.body = `${n}! = ${factorial}`;
    }
  } catch (err) {
    ctx.status = err.code || 500;
    ctx.body = err.message;
  }
});

function factorial(n) {
  if (n === 1) {
    return 1;
  } else {
    return n * factorial(n - 1);
  }
}

该中间件代码演示了如何通过异常和错误处理中间件来抛出和捕获错误。我们尝试解析 query 参数 n 并计算其阶乘，如果 n 不是正整数则抛出一个异常并处理错误响应，否则将解析结果返回。

总结

本文深入介绍了 Koa 中的 ctx 对象，解释了其核心概念和用法，并通过实例代码演示了如何利用 ctx 对象进行开发以解决实际需求。在使用中间件时，要学会尽可能利用已有的模块和插件，扩展和提升自己的开发水平，写出优质易用的代码。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/65a13ba0add4f0e0ff9569a8

理解 Koa 中的 ctx 对象