便捷开发，探秘 Koa 参数校验中间件

2023-10-16 22:39:02

简介

在 Web 开发中，API 参数校验是一个非常重要的环节。通过参数校验，可以确保 API 请求的参数符合预期的格式和类型，从而避免出现因参数错误而导致的程序崩溃或逻辑错误。在 Koa 框架中，有很多第三方库可以帮助我们实现参数校验，其中最常用的就是 koa-joi-router。

koa-joi-router 是一个基于 Joi 的 Koa 参数校验中间件。Joi 是一个强大的 JavaScript 数据验证框架，可以帮助我们轻松地定义和验证 JSON 数据。

使用 Koa 参数校验中间件

使用 koa-joi-router 非常简单。首先，我们需要安装它：

npm install koa-joi-router

安装完成后，我们就可以在 Koa 应用中使用它了。以下是一个简单的示例：

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

const app = new Koa();

// 定义路由
const router = new Router();

// 定义参数校验规则
const schema = Joi.object({
  name: Joi.string().required(),
  age: Joi.number().integer().min(18).max(100).required(),
});

// 使用 koa-joi-router
router.use(koaJoiRouter(schema));

// 定义路由处理函数
router.post('/user', async (ctx) => {
  // 此时，ctx.request.body 已经过校验
  const { name, age } = ctx.request.body;

  // 业务逻辑

  ctx.body = {
    success: true,
    data: {
      name,
      age,
    },
  };
});

// 添加路由
app.use(router.routes());
app.use(router.allowedMethods());

// 启动服务器
app.listen(3000);

在上面的示例中，我们使用 koa-joi-router 定义了一个参数校验中间件。这个中间件会自动对请求参数进行校验。如果参数校验通过，则继续执行路由处理函数。如果参数校验不通过，则返回一个错误响应。

使用中间件生成函数编写 Koa 参数校验中间件

除了使用第三方库之外，我们也可以使用中间件生成函数来编写自己的 Koa 参数校验中间件。以下是一个简单的示例：

const Koa = require('koa');
const Joi = require('joi');

const app = new Koa();

// 定义中间件生成函数
const createValidationMiddleware = (schema) => {
  return async (ctx, next) => {
    // 校验请求参数
    const result = Joi.validate(ctx.request.body, schema);

    // 如果校验通过，则继续执行下一个中间件
    if (!result.error) {
      await next();
      return;
    }

    // 否则，返回一个错误响应
    ctx.status = 400;
    ctx.body = {
      success: false,
      error: result.error.details[0].message,
    };
  };
};

// 定义参数校验规则
const schema = Joi.object({
  name: Joi.string().required(),
  age: Joi.number().integer().min(18).max(100).required(),
});

// 使用中间件生成函数
const validationMiddleware = createValidationMiddleware(schema);

// 添加中间件
app.use(validationMiddleware);

// 定义路由处理函数
app.post('/user', async (ctx) => {
  // 此时，ctx.request.body 已经过校验

  // 业务逻辑

  ctx.body = {
    success: true,
    data: {
      name: ctx.request.body.name,
      age: ctx.request.body.age,
    },
  };
});

// 启动服务器
app.listen(3000);