0

0

JSON Schema 验证失效的常见原因与正确写法详解

聖光之護

聖光之護

发布时间:2026-03-03 10:30:02

|

882人浏览过

|

来源于php中文网

原创

JSON Schema 验证失效的常见原因与正确写法详解

本文解析为何 json schema 验证未按预期报错,并指出核心问题:属性定义缺失 properties 容器、类型关键字误用 str 而非 string,进而给出符合规范的完整修正 schema 与验证示例。

本文解析为何 json schema 验证未按预期报错,并指出核心问题:属性定义缺失 properties 容器、类型关键字误用 str 而非 string,进而给出符合规范的完整修正 schema 与验证示例。

在使用 jsonschema 库进行数据校验时,若验证始终“静默通过”,即使输入明显违反约束(例如将数组赋值给声明为字符串的字段),往往并非库本身失效,而是 Schema 结构存在语义错误——最典型的问题是将对象的子字段直接平铺在 schema 根层级,而未包裹于 properties 键下

JSON Schema 规范严格区分顶层关键字与子结构关键字。例如,type、required、properties 是顶层对象的有效关键字;但 retMsg 或 result 这类自定义字段名,必须作为 properties 对象的键值对出现,否则会被完全忽略。同样,"type": "str" 是非法的:JSON Schema 标准中字符串类型必须写作 "string"(而非 Python 中的 str)。

以下是原始错误 schema 的关键问题分析:

  • ❌ retMsg 和 result 直接作为根级键存在 → 不被识别为待校验属性
  • ❌ "type": "str" → 应为 "type": "string"
  • ❌ 缺少根级 properties 容器 → 所有字段定义失效

✅ 正确写法必须将所有字段定义收归 properties 下,并使用标准类型名:

MyMap AI
MyMap AI

使用AI将想法转化为图表

下载
from jsonschema import validate, ValidationError

schema = {
    "$schema": "https://json-schema.org/draft-04/schema#",
    "type": "object",
    "required": ["retMsg", "result"],
    "properties": {  # ← 必须存在!所有字段定义在此内部
        "retMsg": {
            "type": "string",
            "const": "OK"
        },
        "result": {
            "type": "object",
            "required": ["orderId", "orderLinkId"],
            "properties": {  # ← 嵌套对象也需 properties
                "orderId": {"type": "string"},
                "orderLinkId": {"type": "string"}
            }
        }
    }
}

raw_data = {
    "retMsg": "OK",
    "result": {
        "orderId": [],  # ← 违反 string 类型,应触发报错
        "orderLinkId": "abcde"
    }
}

try:
    validate(instance=raw_data, schema=schema)
    print("Validation passed — unexpected!")
except ValidationError as e:
    print(f"Validation failed as expected:\n{e.message}")
    print(f"Failed at: {e.json_path}")

运行上述代码将准确抛出异常:

Validation failed as expected:
[] is not of type 'string'
Failed at: $.result.orderId

? 关键注意事项

  • properties 是 JSON Schema 中定义对象字段的唯一合法容器,不可省略或替换;
  • 所有类型名(如 string、integer、boolean、array、object)均为小写字符串,与编程语言无关;
  • required 数组仅声明字段存在性,其对应字段的类型/格式等约束仍需在 properties 内完整定义;
  • 推荐使用 jsonschema.validators.Draft7Validator 或更高版本(如 Draft202012Validator),并配合 validator.iter_errors() 进行多错误收集,提升调试效率。

遵循以上规范,即可确保 JSON Schema 验证行为可预测、可调试,并真正发挥数据契约(Data Contract)的保障作用。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

452

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

326

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

910

2023.08.02

java中boolean的用法
java中boolean的用法

在Java中,boolean是一种基本数据类型,它只有两个可能的值:true和false。boolean类型经常用于条件测试,比如进行比较或者检查某个条件是否满足。想了解更多java中boolean的相关内容,可以阅读本专题下面的文章。

366

2023.11.13

java boolean类型
java boolean类型

本专题整合了java中boolean类型相关教程,阅读专题下面的文章了解更多详细内容。

42

2025.11.30

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

678

2023.08.03

C++高性能网络编程与Reactor模型实践
C++高性能网络编程与Reactor模型实践

本专题围绕 C++ 在高性能网络服务开发中的应用展开,深入讲解 Socket 编程、多路复用机制、Reactor 模型设计原理以及线程池协作策略。内容涵盖 epoll 实现机制、内存管理优化、连接管理策略与高并发场景下的性能调优方法。通过构建高并发网络服务器实战案例,帮助开发者掌握 C++ 在底层系统与网络通信领域的核心技术。

0

2026.03.03

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 9.8万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号