0

0

JSON Schema 中实现对象属性“非全空”校验的完整方案

碧海醫心

碧海醫心

发布时间:2026-02-22 19:55:15

|

766人浏览过

|

来源于php中文网

原创

JSON Schema 中实现对象属性“非全空”校验的完整方案

本文详解如何在 json schema 中约束对象(如 employee)的多个可选字段,确保至少有一个字段非 null,防止所有字段同时为空,适用于 java rest api 的请求体校验场景。

本文详解如何在 json schema 中约束对象(如 employee)的多个可选字段,确保至少有一个字段非 null,防止所有字段同时为空,适用于 java rest api 的请求体校验场景。

在构建健壮的 RESTful API 时,后端常需对请求体(payload)进行严格且语义准确的校验。一个典型需求是:某嵌套对象(如 employee)包含若干允许为 null 的字段(如 empName、empAge 等),但业务逻辑要求——这些字段不能全部为 null,即必须至少有一个字段提供有效值(非 null)。标准 JSON Schema 并不直接支持“非全空”(not-all-null)语义,需通过组合关键字巧妙实现。

✅ 正确的 Schema 设计思路

核心在于两点:

大师兄智慧家政
大师兄智慧家政

58到家打造的AI智能营销工具

下载
  1. 显式声明 "null" 类型(注意:必须加引号,"null" 是合法类型名,而 null 字面量在 JSON 中非法);
  2. 使用 anyOf 枚举“至少一个字段存在且非 null”的情形——即每个分支断言某一个字段为非 null 类型(如 "type": "object" 表示该字段存在且为 object,隐含非 null)。

⚠️ 注意:此处假设 empName、empAge 等字段预期值类型为 object(例如复杂子对象)。若实际类型为 string 或 integer,请将 "type": "object" 替换为对应类型(如 "type": "string"),原理相同。

? 完整可运行的 JSON Schema 示例

{
  "type": "object",
  "properties": {
    "employee": {
      "type": "object",
      "default": {},
      "properties": {
        "empName": { "type": ["object", "null"] },
        "empAge": { "type": ["object", "null"] },
        "empAddress": { "type": ["object", "null"] },
        "empContact": { "type": ["object", "null"] }
      },
      "anyOf": [
        { "required": ["empName"], "properties": { "empName": { "type": "object" } } },
        { "required": ["empAge"], "properties": { "empAge": { "type": "object" } } },
        { "required": ["empAddress"], "properties": { "empAddress": { "type": "object" } } },
        { "required": ["empContact"], "properties": { "empContact": { "type": "object" } } }
      ]
    }
  }
}

? 关键说明:

  • 每个 anyOf 分支使用 "required": ["xxx"] + "type": "object" 双重保障:既确保字段存在,又确保其值为非 null 的 object 类型;
  • 若字段缺失(undefined),则不满足 required,该分支失效;若字段存在但为 null,则不满足 "type": "object",同样失效;
  • 只有当至少一个字段存在且为非 null object时,整个 anyOf 才通过。

⚠️ 常见误区与注意事项

  • ❌ 错误写法:"type": ["object", null] —— null 不是合法 JSON 值,会导致 Schema 解析失败;必须写作 "null"(字符串)。
  • ❌ 仅用 anyOf 而不加 required:若字段缺失(而非 null),该分支仍可能被跳过,无法真正约束“至少一个存在”。
  • ✅ 推荐增强健壮性:对 employee 对象本身添加 "minProperties": 1(可选),辅助防止空对象 {},但不能替代 anyOf(因空对象不含任何 key,minProperties 有效;而全 null 对象如 {"empName": null, ...} 含 4 个 key,minProperties 无效)。
  • ✅ Java 集成提示:若使用 json-schema-validator(如 everit-org)或 Spring Boot + @Valid 配合 jakarta.validation,需确保 JSON Schema 引擎支持完整 Draft-07+ 语法(anyOf、required 等均为标准特性)。

✅ 总结

“对象字段非全空”是业务校验中的高频需求,JSON Schema 本身无原生关键字,但通过 anyOf + required + type 的组合模式,可精准、声明式地表达该约束。关键在于理解:校验目标不是“值不为 null”,而是“至少一个字段既存在又非 null”。按本文方案编写 Schema,即可在 API 网关、契约测试或服务端校验层统一拦截非法全 null 输入,显著提升接口可靠性与数据质量。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

143

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

81

2026.01.26

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

137

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

403

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

71

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

132

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

243

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

26

2026.02.11

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

1030

2026.02.13

热门下载

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

精品课程

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

共101课时 | 9.5万人学习

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号