JSON架构验证中如何获取更详细的错误信息？

2024-03-24 10:50:11

JSON 架构验证中的详细错误处理

简介

在使用 Python 验证输入 JSON 是否符合架构时，获得详细的错误信息对于识别和解决问题至关重要。本文将指导你如何获取更具体的验证器错误消息，从而简化 JSON 架构验证过程。

获取更详细的错误信息

1. 导入正确的验证器

使用适用于你所用架构版本的验证器。对于 Draft-08 架构，请导入 Draft201909Validator：

from jsonschema import Draft201909Validator

2. 使用 explain 参数

在验证函数中，将 explain 参数设置为 True：

errors = validate(instance=document, schema=schema, explain=True)

3. 提取详细错误

验证错误信息包含在 ValidationError 对象中。访问 message、context 和 schema_path 属性获取详细信息：

for error in errors.errors:
    print(f"Error message: {error.message}")
    print(f"Error context: {error.context}")
    print(f"Error schema path: {error.schema_path}")

自定义错误处理器

如果你需要更具体的错误信息，可以使用自定义错误处理器：

def my_error_handler(error):
    # 自定义错误处理逻辑

validator = Draft201909Validator(error_handlers=[my_error_handler])

验证输入 JSON

确保输入 JSON 符合架构的格式和数据类型，以减少验证失败。

示例代码

json_file = 'json_instance.json'
json_schema_file = 'json_schema.json'

with open(json_file) as f:
    document = json.load(f)

with open(json_schema_file) as f:
    schema = json.load(f)

errors = Draft201909Validator(explain=True).validate(document, schema)

for error in errors.errors:
    print(f"Error message: {error.message}")
    print(f"Error context: {error.context}")
    print(f"Error schema path: {error.schema_path}")