AJV严格模式详解：提升JSON Schema验证的严谨性-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00576/article/details/148391421

AJV严格模式详解：提升JSON Schema验证的严谨性

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 Schema Validator）的严格模式是一种增强验证机制，旨在防止用户在使用JSON Schema时出现意外行为或被静默忽略的错误。严格模式不会改变规范定义的验证结果，但会使某些不符合严格要求的模式无效，并根据配置抛出异常或记录警告。

为什么需要严格模式

JSON Schema规范本身较为宽松，允许许多元素被静默忽略或存在歧义。这种设计虽然提高了跨平台兼容性，但也带来了以下问题：

相同模式和数据的验证结果可能不一致
关键字拼写错误会被静默忽略
某些关键字的交互行为可能产生意外结果

严格模式通过引入额外限制，帮助开发者编写更严谨、更可预测的Schema。

严格模式的核心功能

1. 禁止被忽略的关键字

未知关键字处理

默认情况下，AJV在遇到未知关键字时会抛出错误。开发者可以通过以下方式显式允许特定关键字：

// 添加单个允许的关键字
ajv.addKeyword("customKeyword");

// 批量添加允许的关键字
ajv.addVocabulary(["keyword1", "keyword2"]);

特殊关键字的严格检查

additionalItems：当items不存在或不是数组时，默认会抛出错误
if/then/else：缺少必要组合时会抛出错误
contains系列：缺少必要组合时会抛出错误

2. 格式验证

默认情况下，未知格式会抛出异常。可以通过以下方式控制格式验证：

// 完全禁用格式验证
const ajv = new Ajv({validateFormats: false});

// 定义已知格式（true表示忽略该格式）
const ajv = new Ajv({
  formats: {
    customFormat: true
  }
});

3. 防止意外验证行为

属性匹配控制

默认禁止properties和patternProperties中出现匹配同一属性的情况，可通过allowMatchingProperties选项单独控制。

必填属性检查

通过strictRequired选项可以检查required中列出的属性是否在properties中定义。

元组约束

对数组类型Schema进行额外检查，确保元组有明确的长度约束。

4. 严格的类型检查

联合类型限制

默认禁止在type中使用多类型（除包含null的情况），鼓励使用anyOf替代：

// 不推荐
{type: ["string", "number"]}

// 推荐
{
  anyOf: [
    {type: "string"},
    {type: "number"}
  ]
}

类型矛盾检测

检查Schema中是否存在矛盾的类型声明。

类型要求

确保使用properties或required时必须有相应的type: "object"声明。

5. 严格的数字验证

默认情况下，Infinity和NaN无法通过{type: "number"}验证。

严格模式配置选项

AJV提供了灵活的配置方式：

// 完全禁用严格模式
const ajv = new Ajv({strict: false});

// 启用所有严格检查
const ajv = new Ajv({strict: true});

// 仅记录警告
const ajv = new Ajv({strict: "log"});

// 精细控制各项检查
const ajv = new Ajv({
  strictSchema: true,    // 禁止被忽略的关键字
  strictNumbers: true,   // 严格的数字验证
  strictTypes: "log",    // 严格的类型检查
  strictRequired: false, // 不检查required属性
  allowUnionTypes: true  // 允许type中使用联合类型
});