掌握Koa2路由配置与请求处理

Koa2 是一个轻量级的 Node.js 框架，通过使用现代的异步编程技术（如 async/await）简化了 Web 应用的开发。Koa2 为开发者提供了极大的灵活性，其中最重要的一部分就是路由配置与请求处理。本节将详细介绍 Koa2 的路由配置方法、请求处理的过程，以及如何在 Koa2 中高效处理路由。

1. Koa2 路由概述

1.1 Koa2 路由简介

在 Koa2 中，并没有内置路由模块，而是通过第三方中间件来处理路由。最常用的路由中间件是 koa-router，它为 Koa2 提供了强大的路由功能，包括路径匹配、请求方法处理、参数传递等。

1.2 安装 koa-router

首先，我们需要安装 koa-router 作为路由中间件。

npm install koa-router

安装完成后，可以在 Koa2 应用中引入并使用它。

1.3 路由配置与请求处理流程

在 Koa2 中，路由配置通常包括：

路由的定义：指定 URL 路径与请求方法（GET、POST 等）
请求处理：指定路由匹配后的处理函数，通常是一个异步函数
路由中间件：可以对请求进行预处理，处理请求参数、认证等

2. Koa2 路由配置和请求处理实例

以下是一个基于 Koa2 和 koa-router 的路由配置与请求处理的完整示例。

2.1 基本路由配置

首先创建一个简单的 Koa2 应用，配置路由并处理请求。

// 引入 koa 和 koa-router
const Koa = require('koa');
const Router = require('koa-router');

// 创建 Koa 应用实例
const app = new Koa();

// 创建 Router 实例
const router = new Router();

// 定义一个简单的 GET 路由
router.get('/', (ctx, next) => {
  ctx.body = 'Hello, Koa2!';
});

// 定义一个带有动态参数的路由
router.get('/user/:id', (ctx, next) => {
  const userId = ctx.params.id; // 从 URL 中获取动态参数
  ctx.body = `User ID: ${userId}`;
});

// 将路由添加到 Koa 应用中
app.use(router.routes()).use(router.allowedMethods());

// 启动服务器
app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

详细中文注释：

我们使用 koa-router 创建路由实例，并通过 router.get 配置了一个基础的 GET 请求路由。
第一个路由 "/" 返回一个简单的字符串作为响应。
第二个路由 "/user/:id" 使用动态参数 id，通过 ctx.params.id 获取该参数的值，并返回相应的用户 ID。

2.2 处理 POST 请求

在 Koa2 中，我们也可以处理 POST 请求。以下是处理 POST 请求的路由配置：

// 处理 POST 请求
router.post('/submit', async (ctx, next) => {
  const requestBody = ctx.request.body;  // 获取请求体数据
  ctx.body = {
    message: 'Data received successfully',
    data: requestBody
  };
});

详细中文注释：

使用 router.post 配置一个 POST 路由，处理客户端发来的数据。
ctx.request.body 用于获取客户端提交的 JSON 数据（需要在 Koa 中配置 koa-bodyparser 中间件来解析请求体）。

2.3 路由中间件

Koa2 支持路由中间件，可以在请求到达路由处理函数之前对请求进行处理。例如，我们可以创建一个验证用户身份的中间件。

// 用户身份验证中间件
const authMiddleware = async (ctx, next) => {
  const token = ctx.headers['authorization']; // 获取请求头中的 Authorization 字段
  if (token === 'Bearer my-secret-token') {
    await next(); // 如果验证通过，继续处理请求
  } else {
    ctx.status = 401; // 如果验证失败，返回 401 状态码
    ctx.body = 'Unauthorized';
  }
};

// 保护的路由，只有通过验证的请求才会执行
router.get('/protected', authMiddleware, (ctx, next) => {
  ctx.body = 'This is a protected route';
});

详细中文注释：

authMiddleware 是一个简单的身份验证中间件，检查请求头中的 Authorization 字段是否符合预期的值。
如果验证通过，调用 await next()，让请求继续传递到下一个中间件或路由处理函数；否则返回 401 Unauthorized 错误。

3. 高级路由技巧

3.1 路由参数与查询参数

Koa2 支持处理路径中的动态参数以及查询参数。例如，我们可以通过路由参数捕获用户 ID 和查询参数获取分页信息。

// 路由参数和查询参数示例
router.get('/search/:category', (ctx, next) => {
  const category = ctx.params.category; // 路由参数
  const page = ctx.query.page || 1;     // 查询参数（默认第一页）
  ctx.body = `Searching for category: ${category}, page: ${page}`;
});

详细中文注释：

路由中的动态参数通过 ctx.params 获取（例如 :category）。
查询参数通过 ctx.query 获取（例如 /search/:category?page=2 中的 page 参数）。

3.2 错误处理与异常捕获

在 Koa2 中，通常会使用 try-catch 来捕获路由处理中的异常，并返回友好的错误信息。

router.get('/error', async (ctx, next) => {
  try {
    throw new Error('Something went wrong!');
  } catch (error) {
    ctx.status = 500; // 设置 HTTP 状态码为 500
    ctx.body = { message: error.message }; // 返回错误消息
  }
});

详细中文注释：