AJV 数据验证入门指南：从安装到实战应用

最新推荐文章于 2025-06-03 09:00:37 发布

原创最新推荐文章于 2025-06-03 09:00:37 发布 · 373 阅读

CC 4.0 BY-SA版权

AJV 数据验证入门指南：从安装到实战应用

ajv The fastest JSON schema Validator. Supports JSON Schema draft-04/06/07/2019-09/2020-12 and JSON Type Definition (RFC8927) 项目地址: https://gitcode.com/gh_mirrors/aj/ajv

什么是 AJV

AJV（Another JSON Validator）是目前 JavaScript 生态中最流行的 JSON 模式验证器之一。它以高性能著称，通过将 JSON Schema 编译为原生 JavaScript 验证函数，实现了极快的验证速度。AJV 支持最新的 JSON Schema 标准，同时也提供了对 JSON Type Definition (JTD) 的支持。

安装 AJV

基础安装

使用 npm 可以轻松安装最新版本的 AJV：

npm install ajv

特定版本安装

如果需要支持较旧的 JSON Schema draft-04 标准，可以安装 AJV v6：

npm install ajv@6

基础数据验证

AJV 的核心功能是通过模式（Schema）来验证数据结构。它支持两种主要的模式语言：

JSON Schema - 功能更丰富，支持更复杂的验证场景
JSON Type Definition (JTD) - 更简洁，性能更优

JSON Schema 示例

const Ajv = require("ajv")
const ajv = new Ajv() // 可传入配置选项，如 {allErrors: true}

// 定义模式：必须包含foo属性(整数)，可选bar属性(字符串)，不允许其他属性
const schema = {
  type: "object",
  properties: {
    foo: {type: "integer"},
    bar: {type: "string"}
  },
  required: ["foo"],
  additionalProperties: false
}

// 编译验证函数
const validate = ajv.compile(schema)

// 测试数据
const data = {
  foo: 1,
  bar: "abc"
}

// 执行验证
const valid = validate(data)
if (!valid) console.log(validate.errors)

JTD 示例

const Ajv = require("ajv/dist/jtd")
const ajv = new Ajv()

const schema = {
  properties: {
    foo: {type: "int32"}
  },
  optionalProperties: {
    bar: {type: "string"}
  }
}

const validate = ajv.compile(schema)

// 验证逻辑与JSON Schema相同

性能优化建议

复用编译结果：AJV 会自动缓存编译后的验证函数，使用相同的模式对象不会重复编译
预编译模式：对于高频使用的模式，提前编译并保存引用
避免重复验证：验证函数的 errors 属性会被覆盖，如需多次使用应保存副本

JSON 解析与序列化（JTD专属）

AJV 的 JTD 实现提供了高效的 JSON 解析和序列化功能，性能远超原生 JSON.parse 和 JSON.stringify。

序列化示例

const Ajv = require("ajv/dist/jtd")
const ajv = new Ajv()

const schema = {
  properties: {
    foo: {type: "int32"}
  },
  optionalProperties: {
    bar: {type: "string"}
  }
}

// 编译序列化函数
const serialize = ajv.compileSerializer(schema)

const data = {foo: 1, bar: "abc"}
console.log(serialize(data)) // 高性能序列化

解析示例

// 编译解析函数
const parse = ajv.compileParser(schema)

function parseAndLog(json) {
  const data = parse(json)
  if (data === undefined) {
    console.log("解析错误:", parse.message)
    console.log("错误位置:", parse.position)
  } else {
    console.log("解析成功:", data)
  }
}

parseAndLog('{"foo": 1, "bar": "abc"}') // 成功
parseAndLog('{"unknown": "abc"}')       // 失败