JSON 数据验证之 Ajv 指南

前端

2024-01-01 03:47:44

如何运用 Ajv 验证 JSON 数据结构

引言

在当今数据驱动的世界中，确保数据的完整性和结构至关重要。 JSON 作为一种轻量级且通用的数据格式，被广泛用于各种应用中。为了验证 JSON 数据是否符合预期的结构和规则，我们可以借助强大的 JSON Schema 验证器 Ajv。

了解 Ajv 的工作原理

Ajv 是一个 JavaScript 库，用于验证 JSON 数据结构。它遵循 JSON Schema 草案，并提供了丰富的功能来定义复杂的数据规则和约束。

Ajv 的工作流程分为以下三个步骤：

Schema 定义： 首先，我们需要定义一个 JSON Schema，该 Schema 详细了预期数据的结构和规则。
Schema 编译： 然后，我们将 Schema 编译为 JavaScript 回调函数。此过程优化了 Schema 的验证性能。
数据验证： 最后，我们可以使用编译后的回调函数来验证 JSON 数据是否符合 Schema 的约束。

使用 Ajv 验证 JSON 数据结构

让我们通过一个示例来了解如何使用 Ajv 验证 JSON 数据结构：

Schema 定义：

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "age": {
      "type": "number",
      "minimum": 18
    },
    "email": {
      "type": "string",
      "format": "email"
    }
  },
  "required": ["name", "age", "email"]
}

此 Schema 定义了一个对象，其中包含三个属性："name"（字符串，最小长度为 1）、"age"（数字，最小值为 18）和 "email"（符合电子邮件格式的字符串）。

Schema 编译：

const Ajv = require("ajv");
const ajv = new Ajv();
const schema = require("./schema.json");
const validate = ajv.compile(schema);

数据验证：

const data = {
  name: "John Doe",
  age: 30,
  email: "john.doe@example.com"
};

const valid = validate(data);
if (valid) {
  // 数据符合 Schema
} else {
  // 数据不符合 Schema，获取验证错误
  const errors = validate.errors;
}