0

0

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

心靈之曲

心靈之曲

发布时间:2025-12-31 12:47:23

|

585人浏览过

|

来源于php中文网

原创

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

本文介绍一种基于 json schema 思想的模板驱动校验方法,通过递归比对预定义模板与实际 json 数据的结构、类型及必填性,替代冗长的手动字段校验代码,显著提升可维护性与扩展性。

在处理包含 48+ 字段的复杂 JSON 响应时,逐字段 get() + 类型强转 + 空值判断的硬编码校验方式不仅重复度高、易出错(如 == null && .isEmpty() 逻辑错误),还严重违背开闭原则——新增字段需同步修改校验逻辑,维护成本极高。

更优解是采用声明式模板校验(Template-Driven Validation):预先定义一个轻量 JSON 模板,明确每个字段的存在性、数据类型、非空要求及嵌套结构,再通过统一递归校验器自动执行一致性检查。该方案融合了策略模式(校验规则集中封装)与组合模式(递归处理嵌套对象/数组)的思想,无需引入第三方 Schema 库即可快速落地。

LogoAi
LogoAi

利用AI来设计你喜欢的Logo和品牌标志

下载

✅ 核心实现步骤

  1. 定义校验模板(JSON String)
    模板仅描述结构契约,不关心业务值。字符串字段用 "" 占位,数组用 [],数字用 0,对象用 {}:

    {
      "productName": "",
      "offerStartDate": "",
      "offerEndDate": "",
      "offerAttributes": [],
      "offerSpecifications": {
        "price": 0
      }
    }
  2. 统一递归校验器(类型安全 + 必填保障)
    使用 Jackson 的 JsonNode 进行类型感知校验,关键逻辑如下:

    public void validate(JsonNode template, JsonNode data) throws ValidationException {
        Iterator<Map.Entry<String, JsonNode>> fields = template.fields();
        while (fields.hasNext()) {
            Map.Entry<String, JsonNode> field = fields.next();
            String key = field.getKey();
            JsonNode dataValue = data.get(key);
    
            // 【必填性】字段缺失或为 null
            if (dataValue == null || dataValue.isNull()) {
                throw new ValidationException("Missing required field: " + key);
            }
    
            // 【类型一致性】模板类型 vs 实际值类型
            if (field.getValue().getNodeType() != dataValue.getNodeType()) {
                throw new ValidationException(
                    String.format("Type mismatch for '%s': expected %s, got %s",
                        key, field.getValue().getNodeType(), dataValue.getNodeType())
                );
            }
    
            // 【语义校验】按类型差异化处理
            switch (field.getValue().getNodeType()) {
                case STRING:
                    if (dataValue.asText().trim().isEmpty()) {
                        throw new ValidationException("Empty string not allowed for field: " + key);
                    }
                    break;
                case OBJECT:
                    validate(field.getValue(), dataValue); // 递归校验子对象
                    break;
                case ARRAY:
                    if (dataValue.isEmpty()) {
                        throw new ValidationException("Array '" + key + "' must not be empty");
                    }
                    break;
                case NUMBER:
                    // 可扩展:校验数值范围、精度等
                    break;
                case BOOLEAN:
                    // 可扩展:校验布尔值语义(如 status 字段必须为 true)
                    break;
            }
        }
    }
  3. 使用示例(一行调用,全量覆盖)

    ObjectMapper mapper = new ObjectMapper();
    JsonNode template = mapper.readTree(templateJson);
    JsonNode data = mapper.readTree(jsonString);
    validate(template, data); // 自动完成全部 48+ 字段校验

⚠️ 注意事项与增强建议

  • 异常设计:将 Exception 替换为自定义 ValidationException,携带字段路径(如 offerSpecifications.price)和错误码,便于日志追踪与前端友好提示。
  • 可选字段支持:若某些字段为可选,可在模板中用特殊标记(如 "optional_field?": ""),校验器跳过 ? 后缀字段。
  • 性能优化:对高频校验场景,可将 template 预解析为 JsonNode 并缓存,避免重复解析。
  • 进阶演进:当校验规则进一步复杂(如正则校验、日期格式、条件依赖),建议迁移至标准 JSON Schema + json-schema-validator 库,实现行业通用规范。

此方案将校验逻辑从“代码”下沉为“配置”,大幅提升可读性、可测试性与协作效率——产品只需修改 JSON 模板,开发无需触碰校验逻辑,真正实现关注点分离。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

453

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的详细内容,可以访问本专题下面的文章。

331

2023.10.13

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

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

82

2025.09.10

数据类型有哪几种
数据类型有哪几种

数据类型有整型、浮点型、字符型、字符串型、布尔型、数组、结构体和枚举等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

335

2023.10.31

php数据类型
php数据类型

本专题整合了php数据类型相关内容,阅读专题下面的文章了解更多详细内容。

223

2025.10.31

c语言 数据类型
c语言 数据类型

本专题整合了c语言数据类型相关内容,阅读专题下面的文章了解更多详细内容。

138

2026.02.12

string转int
string转int

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

970

2023.08.02

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

23

2026.03.06

热门下载

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

精品课程

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

共101课时 | 10万人学习

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号