0

0

JSON 字符串结构化验证的优雅实现方案

聖光之護

聖光之護

发布时间:2025-12-30 23:55:02

|

102人浏览过

|

来源于php中文网

原创

JSON 字符串结构化验证的优雅实现方案

本文介绍一种基于 json 模板递归校验的轻量级验证方法,通过预定义结构模板自动检测字段缺失、类型不匹配及空值问题,显著替代 48+ 字段的手动 if-check,提升可维护性与扩展性。

在处理复杂、嵌套层级深且字段繁多(如 48+ 字段)的 JSON 响应时,传统逐字段 map.get() + null/isEmpty() 手动校验不仅代码冗长、易出错,还严重违反 DRY 原则,难以维护和测试。更关键的是,它无法天然保障结构一致性(如 offerSpecifications 必须是对象、offerAttributes 必须是非空数组),也无法清晰表达业务约束(如“所有字符串字段不能为空”、“price 必须为数字”)。

推荐采用 Schema-Driven 验证模式:以精简、声明式的 JSON 模板(Template Schema)作为校验契约,结合 Jackson 的 JsonNode 实现递归结构比对。该方案兼具简洁性、可读性与可扩展性,无需引入额外框架(如 JSON Schema Validator),也避免了 Builder 模式在此场景下的过度设计(Builder 更适用于对象构建而非结构断言)。

✅ 核心实现逻辑

首先定义一个最小完备的 JSON 模板,仅描述必需字段名、类型占位与基础约束(如字符串用 ""、数组用 []、数字用 0、对象用 {}):

Bertha.ai
Bertha.ai

一款专为WordPress打造的AI内容和图像创建工具

下载
ObjectMapper mapper = new ObjectMapper();
JsonNode template = mapper.readTree(
    "{" +
    "  \"productName\": \"\"," +
    "  \"offerStartDate\": \"\"," +
    "  \"offerEndDate\": \"\"," +
    "  \"offerAttributes\": []," +
    "  \"offerSpecifications\": {" +
    "    \"price\": 0" +
    "  }" +
    "}");
⚠️ 注意:模板中 "" 表示该字段必须存在且为非空字符串;[] 表示必须为非空数组;{} 表示必须为非空对象;0 或 false 表示必须为对应类型(不校验具体值,仅保类型安全)。

接着,使用递归校验方法 validate(JsonNode template, JsonNode data) 自动遍历模板节点,对实际数据执行三重检查:

  1. 存在性检查:data.get(key) == null → 报“Missing xxx”
  2. 类型一致性检查:template.nodeType() != data.nodeType() → 报“Mismatch data type”
  3. 语义约束检查
    • STRING:asText().isEmpty() → 视为空值错误
    • ARRAY:isEmpty() → 报“Array xxx must not be empty”
    • OBJECT:递归进入子结构校验
public void validate(JsonNode template, JsonNode data) throws ValidationException {
    Iterator> fields = template.fields();
    while (fields.hasNext()) {
        Map.Entry field = fields.next();
        String key = field.getKey();
        JsonNode dataValue = data.get(key);

        // 1. 字段必须存在且非 null
        if (dataValue == null || dataValue.isNull()) {
            throw new ValidationException("Missing required field: " + key);
        }

        // 2. 类型必须匹配
        if (!field.getValue().getNodeType().equals(dataValue.getNodeType())) {
            throw new ValidationException(
                String.format("Type mismatch for '%s': expected %s, got %s",
                    key, field.getValue().getNodeType(), dataValue.getNodeType())
            );
        }

        // 3. 按类型执行语义校验
        switch (field.getValue().getNodeType()) {
            case STRING:
                if (dataValue.asText().trim().isEmpty()) {
                    throw new ValidationException("Empty string not allowed for field: " + key);
                }
                break;
            case ARRAY:
                if (dataValue.isEmpty()) {
                    throw new ValidationException("Array '" + key + "' must not be empty");
                }
                break;
            case OBJECT:
                validate(field.getValue(), dataValue); // 递归校验子对象
                break;
            // NUMBER / BOOLEAN / NULL 等可根据业务补充(如 price > 0)
        }
    }
}

✅ 进阶建议

  • 异常封装:将 Exception 替换为自定义 ValidationException,支持批量收集错误(如 List errors),便于前端展示完整校验报告。
  • 增强约束:在模板中嵌入注释或扩展字段(如 "price": {"type": "number", "min": 0}),配合自定义解析器支持范围、正则等业务规则。
  • 复用与解耦:将模板提取为 resources/validation-schema.json,运行时加载,实现配置与逻辑分离。
  • 性能优化:对高频调用场景,可缓存 template 的 JsonNode 实例,避免重复解析。

该方案将原本 48×5 行的手动校验压缩为 1 个模板 + 1 个通用方法,新增字段只需更新模板,零代码修改,真正实现高内聚、低耦合、易演进的验证体系。

相关专题

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

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

402

2023.08.07

json是什么
json是什么

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

528

2023.08.23

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

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

306

2023.10.13

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

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

74

2025.09.10

string转int
string转int

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

312

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

229

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

433

2024.03.01

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

711

2023.08.22

桌面文件位置介绍
桌面文件位置介绍

本专题整合了桌面文件相关教程,阅读专题下面的文章了解更多内容。

0

2025.12.30

热门下载

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

精品课程

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

共101课时 | 8.1万人学习

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

共39课时 | 3.1万人学习

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

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