
Ajv 的 `uri` 格式验证遵循 RFC3986 标准,而非简单的 URL 语法检查。本文通过示例代码解释了为何 `https://a.=.c` 这样的字符串在 Ajv 中会被判定为有效的 URI,强调理解底层规范对于正确使用 Ajv 格式验证的重要性。
在使用 Ajv 进行 JSON Schema 验证时,开发者有时会遇到 uri 格式验证行为与预期不符的情况。例如,某些看起来“不规范”的字符串,如 https://a.=.c,在 Ajv 中却能通过 uri 格式验证。这并非 Ajv 的错误,而是源于对 uri 格式定义的理解差异。Ajv 严格遵循 JSON Schema 规范,而 JSON Schema 中定义的 uri 格式,其底层标准是 RFC3986。
1. uri 格式与 RFC3986
JSON Schema 官方文档明确指出,uri 格式的字符串必须符合 RFC3986 规范。RFC3986 定义了统一资源标识符(URI)的通用语法,它比我们日常使用的“URL”概念更为宽泛和底层。许多人习惯性地将 uri 等同于 Web 浏览器中常见的 URL,并期望它能捕获所有“不合法”的字符或结构。然而,RFC3986 允许在 URI 的不同组件(如路径、查询参数)中使用比预期更广泛的字符集,包括一些特殊字符如 = 和 .。
具体来说,在 RFC3986 中,= 字符被定义为“子定界符”(sub-delimiter),可以在 URI 的某些组件(如查询字符串、片段标识符)中使用,而不会导致 URI 结构无效。同样,. 字符在路径段中也是合法的。因此,像 https://a.=.c 这样的字符串,如果 a.=.c 被解析为路径或查询参数的一部分,它是完全符合 RFC3986 规范的 URI 语法。
2. Ajv 的 uri 格式验证实现
Ajv 作为一个高性能的 JSON Schema 验证器,通过 ajv-formats 插件提供了对各种标准格式(包括 uri)的支持。当配置 Ajv 并添加 ajv-formats 后,它会根据底层规范(对于 uri 而言即 RFC3986)来执行格式验证。
以下是一个具体的示例,展示了 Ajv 如何处理 https://a.=.c 字符串:
import Ajv from 'ajv';
import addFormats from 'ajv-formats'; // 注意这里使用ESM导入
// 待验证的数据
const myData = { a: "https://a.=.c" };
// 定义 JSON Schema
const mySchema = {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"a": {
"type": "string",
"format": "uri" // 指定 'uri' 格式
}
}
};
// 初始化 Ajv 实例
// strict: true 开启严格模式,allErrors: true 收集所有错误,verbose: true 包含更多错误信息
const ajv = new Ajv({ strict: true, allErrors: true, verbose: true });
// 添加格式支持
addFormats(ajv); // 将 ajv-formats 提供的所有格式添加到 ajv 实例
// 执行验证
const isValid = ajv.validate(mySchema, myData);
console.log(`验证结果: ${isValid}`);
if (!isValid) {
console.log('验证错误:', ajv.errors);
}运行上述代码,isValid 的结果将是 true。这是因为 https://a.=.c 字符串确实符合 RFC3986 对 URI 的定义。Ajv 忠实地执行了规范,而不是根据某些更严格或自定义的“URL”规则进行判断。
3. 注意事项与总结
- 理解底层规范是关键: 当使用 JSON Schema 的 format 关键字时,务必查阅其对应的底层规范(如 uri 对应 RFC3986,email 对应 RFC5322 等)。这些规范可能比直观理解的要复杂或宽泛。
- Ajv 行为的正确性: Ajv 严格按照 JSON Schema 规范及其引用的 RFC 标准来执行验证,其行为是正确的。
-
需要更严格的验证? 如果您需要对 URI/URL 进行比 RFC3986 更严格的验证(例如,不允许某些特定字符,或要求符合特定的应用场景 URL 规则),您可能需要:
- 自定义格式: 使用 ajv.addFormat() 方法添加您自己的正则表达式或验证函数。
- 正则表达式: 在 Schema 中直接使用 pattern 关键字,配合自定义的正则表达式进行更精细的控制。
总之,Ajv 在 uri 格式验证上的行为是符合预期的,它严格遵循了 RFC3986 规范。开发者在遇到此类问题时,应首先回顾相关的 RFC 标准,以确保对格式定义的理解与验证器的实现保持一致。










