JSON schema定义校验时如何获取报错所在的行号?
JSON Schema校验能否返回报错对应的行号
核心结论
可以实现,但需要你使用的校验工具支持原始JSON文件的位置映射能力,常规校验库默认不会返回行号信息。
详细说明
- 大多数通用JSON Schema校验库的默认工作逻辑是先把输入的JSON内容(不管是schema本身还是待校验的数据)解析为内存中的对应编程语言对象,解析过程会直接丢弃原始文件的行号、列号这类格式信息,校验报错时只会返回错误对应的JSON路径,比如你举的例子只会提示
#/type 取值不合法,不会带行号。 - 如果需要行号提示,要选用支持「JSON节点位置追踪」的校验工具:这类工具在解析JSON时会同步记录每个键、值对应的原始文件行号、偏移量,校验出错误时会把位置信息和错误内容一起返回。
示例场景对应效果
如果是schema的type属性误写为objects的场景,只要使用支持位置追踪的工具,完全可以返回类似以下的明确报错:
错误:schema路径
#/type的取值"objects"不符合要求,合法取值包括["string", "number", "boolean", "object", "array", "null", "integer"],位于文件第20行第8列
常见实现方案
- Node.js环境可以搭配
json-source-map库解析JSON生成位置映射,再配合AJV等校验库的报错路径匹配实现行号返回 - 命令行校验可以使用带位置输出的
ajv-cli插件实现 - VS Code这类IDE的内置JSON Schema校验默认就会在对应行标红提示,就是基于位置追踪能力实现的
内容的提问来源于stack exchange,提问作者Haseeb Ali
相关产品推荐
相关产品推荐

