Fastify 如何使用 JSON Schema 验证请求参数-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，我们经常需要处理用户发来的请求参数。为了保证数据的正确性和安全性，我们需要对请求参数进行验证。而 Fastify 是一个高效的 Node.js Web 框架，提供了强大的 JSON Schema 验证功能，可以帮助我们简化验证逻辑，提高开发效率。

JSON Schema 是什么？

JSON Schema 是一种用于描述 JSON 数据结构的语言。它可以用来验证 JSON 数据是否符合预期的结构和约束条件。JSON Schema 非常灵活，可以定义数据类型、数据格式、数据范围、必填字段等多种验证规则。

以下是一个简单的 JSON Schema 示例：

// javascriptcn.com 代码示例
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "age": {
      "type": "integer",
      "minimum": 0,
      "maximum": 120
    }
  },
  "required": ["name"]
}

这个 JSON Schema 定义了一个对象，包含两个属性：name 和 age。其中 name 是必填字段，类型为字符串；age 是可选字段，类型为整数，取值范围在 0 到 120 之间。

Fastify 如何使用 JSON Schema 验证请求参数？

Fastify 内置了 fast-json-stringify 和 ajv 两个库，可以帮助我们快速实现 JSON Schema 验证逻辑。

安装依赖

首先，我们需要安装以下依赖：

npm install fastify fast-json-stringify ajv

定义 JSON Schema

接下来，我们需要定义请求参数的 JSON Schema。以一个简单的登录接口为例，请求参数包含用户名和密码两个字段。我们可以定义一个如下的 JSON Schema：

// javascriptcn.com 代码示例
{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "minLength": 6,
      "maxLength": 20
    },
    "password": {
      "type": "string",
      "minLength": 6,
      "maxLength": 20
    }
  },
  "required": ["username", "password"]
}

这个 JSON Schema 定义了一个对象，包含两个必填属性：username 和 password。它们的类型都是字符串，长度在 6 到 20 之间。

创建路由

接下来，我们需要创建一个路由，并在路由中使用 JSON Schema 验证请求参数。以下是一个示例代码：

// javascriptcn.com 代码示例
const fastify = require('fastify')();
const { stringify } = require('fast-json-stringify');
const Ajv = require('ajv');
const ajv = new Ajv();

// 定义 JSON Schema
const loginSchema = {
  type: 'object',
  properties: {
    username: {
      type: 'string',
      minLength: 6,
      maxLength: 20
    },
    password: {
      type: 'string',
      minLength: 6,
      maxLength: 20
    }
  },
  required: ['username', 'password']
};

// 创建路由
fastify.post('/login', {
  schema: {
    body: loginSchema
  }
}, async (req, res) => {
  const { username, password } = req.body;
  // 处理登录逻辑
  // ...
  res.send({ success: true });
});

// 启动服务器
fastify.listen(3000, (err) => {
  if (err) {
    console.error(err);
    process.exit(1);
  }
  console.log('Server started at port 3000');
});

在这个示例代码中，我们首先定义了一个 loginSchema，它表示登录请求参数的 JSON Schema。然后，我们在创建路由时，使用了 schema 配置项，将 loginSchema 作为请求体的验证规则。当请求到达路由时，Fastify 会自动将请求体和 loginSchema 进行比较，如果不符合规则，会返回 400 错误。

自定义错误信息

在实际开发中，我们可能需要自定义验证失败时的错误信息。Fastify 提供了自定义错误信息的方式，我们可以通过修改 JSON Schema 中的 $comment 字段，来定义错误信息。以下是一个示例代码：

// javascriptcn.com 代码示例
{
  "type": "object",
  "properties": {
    "username": {
      "type": "string",
      "minLength": 6,
      "maxLength": 20,
      "$comment": "用户名长度必须在 6 到 20 个字符之间"
    },
    "password": {
      "type": "string",
      "minLength": 6,
      "maxLength": 20,
      "$comment": "密码长度必须在 6 到 20 个字符之间"
    }
  },
  "required": ["username", "password"]
}

在这个示例代码中，我们通过 $comment 字段，为每个属性定义了验证失败时的错误信息。当请求参数不符合规则时，Fastify 会自动将 $comment 字段的内容作为错误信息返回给客户端。

总结

在本文中，我们介绍了 Fastify 如何使用 JSON Schema 验证请求参数。通过使用 JSON Schema，我们可以快速定义请求参数的验证规则，减少代码量，提高开发效率。同时，Fastify 提供了丰富的自定义选项，可以满足不同场景下的需求。

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