后端接口开发之路由

2023-10-06 20:56:22

前言

在 Koa 应用中，通常会使用 koa-router 模块，提供对路由的支持。那为什么需要路由呢？做前后端分离开发的朋友都遇到过，对接接口的时候后台都会提供一个地址，请求这个地址，传相应参数就能实现相应地数据处理。你可以把这个接口理解为路由的地址。

我们开发项目不可能都把路由写成同一个文件，随着项目越来越复杂，路由文件肯定也会越来越长，而且不利于维护。把不同模块的路由文件拆开，一目了然，方便维护。而且在开发过程中，由于依赖倒置原则的存在，导致我们很多时候是从中间件和控制器开始往下面写代码的，如果需要从中间件里面写路由地址的话，开发起来不太方便，但借助koa-router，你只需要在最开头写一个router实例，然后在相应的中间件或者控制器里面用router去匹配即可。

koa-router 的使用

Koa-router 的使用非常简单，下面是一个基本的例子：

const Koa = require('koa');
const Router = require('koa-router');

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

router.get('/user', async (ctx) => {
  ctx.body = 'Hello, World!';
});

app.use(router.routes());

app.listen(3000);

在这个例子中，我们使用 Router 类创建了一个新的路由实例，并使用 get() 方法添加了一个新的路由。该路由匹配 HTTP GET 请求，路径为 /user。当收到一个匹配该路由的请求时，async 函数将被调用。在这个函数中，我们可以使用 ctx.body 来设置响应的主体。

然后，我们使用 app.use() 方法将路由器添加到 Koa 应用程序中。这将告诉 Koa 应用程序使用该路由器来处理请求。

最后，我们使用 app.listen() 方法启动 Koa 应用程序，使其开始监听端口 3000 上的请求。

路由参数

Koa-router 支持路由参数。路由参数是路由的一部分，可以匹配 URL 中的特定值。例如，我们可以使用以下路由来匹配 /user/123 路径的请求：

router.get('/user/:id', async (ctx) => {
  const id = ctx.params.id;

  ctx.body = `Hello, ${id}!`;
});

在这个例子中，:id 是一个路由参数。当收到一个匹配该路由的请求时，id 将被设置为请求 URL 中的值。

中间件

Koa-router 还支持中间件。中间件是在路由处理函数之前或之后执行的函数。我们可以使用中间件来执行一些额外的任务，例如身份验证、日志记录或错误处理。

以下是一个使用中间件的示例：

router.use(async (ctx, next) => {
  console.log('Request received: ', ctx.method, ctx.url);
  await next();
  console.log('Response sent: ', ctx.status, ctx.body);
});

router.get('/user', async (ctx) => {
  ctx.body = 'Hello, World!';
});

在这个例子中，我们使用中间件来记录所有请求和响应的信息。