AJV — JSON 验证的强大工具

摘要

AJV（Another JSON Schema Validator）是现代 Web 开发中确保客户端和服务器之间 JSON 数据有效性与完整性的关键工具。它在 Express.js 等后端开发框架中，以及 Playwright 和 Cypress 等 API 和端到端测试工具中发挥着重要作用。AJV 支持包括嵌套对象和数组在内的复杂数据结构，并提供详细的错误报告与自定义验证功能。其与正则表达式的集成允许精确的字符串验证，提升了应用程序的整体安全性和可靠性。通过使用 AJV，开发者能够确保数据符合预定义规则，从而防止错误，维护数据完整性，提升应用安全性。

观点

本文强调了 JSON 验证在 Web 应用中对于保持数据完整性、增强安全性和防止错误的重要性。
AJV 因将 Schema 编译为 JavaScript 函数以加速验证而备受赞誉。
AJV 的详细错误报告功能在调试过程中尤其有用。
可通过 AJV 创建自定义验证逻辑是开发者的一大优势。
AJV 对正则表达式的支持被视为强大的功能，可用于强制执行字符串的特定模式。
AJV 在处理嵌套对象和数组等复杂数据结构方面表现出的灵活性受到肯定。
推荐在测试框架（如 Playwright 和 Cypress）中集成 AJV，以确保 API 响应符合预期的 Schema。
本文总结道，将 AJV 集成到开发和测试工作流程中，可以构建更安全、可靠且更少错误的应用程序。

AJV — JSON 验证的强大工具 —（AJV 系列 1）

在现代 Web 开发中，JSON（JavaScript Object Notation）是客户端与服务器之间进行数据交换的首选格式。然而，验证数据结构至关重要，以防止错误，确保数据完整性，并提高安全性。AJV 是一个强大的工具，帮助开发者使用 JSON Schema 定义和强制执行数据结构。本篇文章将探讨 AJV 的关键特性，阐明其重要性，并展示其在 Express.js、Playwright 和 Cypress 等各种场景中的用法，同时包含高级示例，如嵌套对象、数组以及用于字符串验证的正则表达式。

为什么 JSON 验证很重要？

验证是任何 Web 应用的重要环节：

数据完整性：确保传入数据与预期结构匹配。
安全性：防止恶意数据（如注入攻击）进入系统。
错误预防：早期捕获无效数据，降低错误和应用失败的可能性。

AJV 的关键特性

性能：AJV 将 Schema 编译为 JavaScript 函数，从而加速验证。
详细的错误报告：在验证失败时提供详细的错误信息，方便调试。
自定义验证：允许开发者创建自定义验证逻辑。
正则表达式支持：支持通过正则表达式强制字符串特定模式。
支持复杂数据结构：能够验证嵌套对象、数组及其他高级数据结构。

在 Express.js 中使用 AJV 进行后端开发

AJV 可以集成到 Express.js 中，用于验证 API 请求中的 JSON 数据有效性，从而确保发送到服务器的数据是结构化且符合规则的。

Express.js 中使用 AJV 进行基本数据验证

const express = require('express');
const Ajv = require('ajv');
const app = express();
const ajv = new Ajv();

app.use(express.json());

const userSchema = {
  type: "object",
  properties: {
    name: { type: "string", minLength: 3 },
    age: { type: "number", minimum: 18 }
  },
  required: ["name", "age"],
  additionalProperties: false
};

const validateUser = ajv.compile(userSchema);

app.post('/register', (req, res) => {
  const valid = validateUser(req.body);
  if (!valid) {
    return res.status(400).json({ error_message: validateUser.errors });
  }
  res.status(200).send('User registered successfully');
});

app.listen(3000, () => {
  console.log('Server running on port 3000');
});

此示例确保：

name 是一个长度至少为 3 的字符串。
age 是一个至少为 18 的数字。

验证嵌套对象和数组

AJV 能处理嵌套对象和数组，为验证包含地址信息的用户档案或具有多个属性的产品列表等复杂数据结构提供了灵活性。

Express.js 中验证嵌套对象和数组

假设需要验证用户档案，包括姓名、年龄，以及包含街道、城市和邮政编码的地址（一个嵌套对象）和兴趣爱好列表。

const userSchema = {
  type: "object",
  properties: {
    name: { type: "string", minLength: 3 },
    age: { type: "number", minimum: 18 },
    address: {
      type: "object",
      properties: {
        street: { type: "string" },
        city: { type: "string" },
        postalCode: { type: "string", pattern: "^[0-9]{5}$" }
      },
      required: ["street", "city", "postalCode"],
      additionalProperties: false
    },
    hobbies: {
      type: "array",
      items: { type: "string", minLength: 3 },
      minItems: 1,
      uniqueItems: true
    }
  },
  required: ["name", "age", "address", "hobbies"],
  additionalProperties: false
};

此示例：

嵌套对象：验证地址包含 street、city 和符合 5 位数字模式的 postalCode。
数组：验证 hobbies 为字符串数组，每项至少 3 个字符，且无重复值。

在 Playwright 中使用 AJV 进行 API 测试

AJV 在 Playwright 测试中同样有用，能验证 API 响应的数据结构是否符合预期的 Schema。

test('Validate API response', async ({ request }) => {
  const response = await request.get('/api/users/1');
  expect(response.status()).toBe(200);

  const data = await response.json();
  const valid = validateUserProfile(data);

  if (!valid) {
    console.error(validateUserProfile.errors);
  }

  expect(valid).toBe(true);
});

在 Cypress 中使用 AJV 进行端到端测试

Cypress 中也可借助 AJV 验证 API 响应或表单提交的数据结构。

describe('Validate API response', () => {
  it('should validate the user profile API response', () => {
    cy.request('/api/users/1').then((response) => {
      expect(response.status).to.eq(200);

      const valid = validateUserProfile(response.body);

      if (!valid) {
        console.error(validateUserProfile.errors);
      }

      expect(valid).to.be.true;
    });
  });
});

使用正则表达式进行字符串验证

正则表达式为复杂字符串验证规则提供了强大支持。例如：

确保字符串不以空格开始或结束。
字符串至少 3 个字符长。

const userSchema = {
  type: "object",
  properties: {
    name: {
      type: "string",
      pattern: "^(?! )[\\S ]{3,}(?<! )$"
    }
  },
  required: ["name"],
  additionalProperties: false
};

此模式确保字符串：

无首尾空格。
至少 3 个非空白字符。

总结

AJV 是验证 JSON 数据的关键工具，可确保应用处理的数据结构化、安全且符合预定义规则。无论是在 Express.js 构建后端、使用 Playwright 进行 API 测试，还是用 Cypress 编写端到端测试，AJV 都能够验证简单或复杂的数据结构（如嵌套对象和数组）。此外，通过正则表达式，可以实现更详细的字符串验证。

将 AJV 集成到开发和测试流程中，可以及早捕获无效数据，减少错误，提升应用程序的安全性和可靠性。