ajv 在进行 uri 格式校验时，严格遵循 rfc3986 规范，这可能导致其对某些看似不规范的 uri 字符串（如包含 `.` 和 `=` 的路径）判断为有效，与部分在线工具的校验结果不同。本文将深入探讨 ajv 的 uri 校验机制，并通过示例代码解析其行为，帮助开发者理解并正确使用 ajv 进行 uri 格式验证。
Ajv URI 格式校验的核心原则
许多开发者在使用 Ajv 结合 ajv-formats 进行 JSON Schema 校验时，可能会对 URI 格式的校验结果产生疑问。特别是当一个 URI 字符串在某些在线校验工具中被标记为无效，但在 Ajv 中却被判断为有效时，这种困惑尤为常见。其核心原因在于 Ajv 对 format: “uri” 的实现严格遵循了 RFC3986 这一 URI 规范。
RFC3986 定义了 URI 的通用语法，它允许 URI 的路径部分包含比我们日常认知中更广泛的字符。例如，字符 . (点) 和 = (等号) 在 RFC3986 中被归类为“子定界符”（sub-delims），是允许出现在 URI 路径段中的字符。因此，一个包含这些字符的 URI 字符串，只要符合 RFC3986 的结构要求，就会被 Ajv 视为有效。
示例解析
让我们通过一个具体的例子来理解 Ajv 的这一行为。考虑以下 JSON Schema 和待校验的数据：
import Ajv from 'ajv';import addFormats from 'ajv-formats'; // 注意：在CommonJS环境中使用 require，在ESM环境中使用 importconst myData = { a: "https://a.=.c" };const mySchema = { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "a": { "type": "string", "format": "uri" } }};const ajv = new Ajv({ strict: true, allErrors: true, verbose: true });// 注册 ajv-formats 插件以启用格式校验addFormats(ajv);const isValid = ajv.validate(mySchema, myData);console.log(`校验结果: ${isValid}`);if (!isValid) { console.log('校验错误:', ajv.errors);}
运行上述代码，你会发现 isValid 的值为 true。这与一些在线 JSON Schema 校验器（例如 jsonschemavalidator.net）可能报告的错误形成了对比。在线工具可能采用了更严格或基于特定场景的 URI 验证规则，而 Ajv 坚持的是 RFC3986 的通用定义。
具体到 https://a.=.c 这个 URI 字符串：
https 是合法的 scheme。a 是合法的主机名。. 和 = 在 RFC3986 中是允许出现在路径段中的“子定界符”。c 也是合法的路径字符。
因此，从 RFC3986 的角度来看，https://a.=.c 是一个格式正确的 URI。
注意事项与替代方案
ajv-formats 的重要性： Ajv 本身不包含所有格式的校验逻辑。为了启用 format 关键字的校验，必须安装并注册 ajv-formats 插件。如果忘记注册，format 关键字将被忽略，导致所有字符串都被视为有效。
理解标准： 在使用 format 关键字时，务必查阅 JSON Schema 官方文档以及相关 RFC 规范，以理解其背后遵循的具体标准。这有助于避免对校验结果产生误解。
更严格的 URI 校验： 如果你的应用场景需要比 RFC3986 更严格的 URI 校验规则（例如，不允许路径中出现某些特殊字符，或者要求特定的域名结构），你可以考虑以下两种方案：
自定义格式（Custom Formats）： Ajv 允许你定义自己的自定义格式。你可以编写一个函数，使用正则表达式或其他库（如 validator.js）来实现更严格的 URI 校验逻辑，然后将其注册为 Ajv 的自定义格式。
ajv.addFormat('strict-uri', { type: 'string', validate: (uri) => { // 使用更严格的正则表达式或第三方库进行校验 // 例如，一个更严格的正则，可能不完全符合所有RFC，但满足特定需求 const strictUriRegex = /^(https?|ftp)://[^s/$.?#].[^s]*$/i; return strictUriRegex.test(uri); }});// 在 schema 中使用 "format": "strict-uri"
pattern 关键字： 对于简单的、基于正则表达式的额外限制，可以直接在 JSON Schema 中使用 pattern 关键字。
{ "type": "string", "format": "uri", "pattern": "^https?://[a-zA-Z0-9.-]+$" // 示例：一个更严格的模式，要求只有字母、数字、点、横线}
请注意，pattern 关键字会与 format 关键字协同工作，提供双重校验。
总结
Ajv 对 format: “uri” 的处理是基于其对 RFC3986 规范的严格遵循。理解这一基础是正确使用 Ajv 进行 URI 校验的关键。当遇到与预期不符的校验结果时，首先应回顾相关的 RFC 规范，而非简单地认为 Ajv 存在“缺陷”。如果默认的 RFC3986 校验不足以满足业务需求，开发者应主动利用 Ajv 提供的自定义格式或 pattern 关键字，以实现更精细、更严格的验证逻辑。
以上就是深入理解 Ajv 的 URI 格式校验：基于 RFC3986 的行为解析的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1531138.html
微信扫一扫 
支付宝扫一扫 
