0

0

标题:使用 JSON 模板递归校验提升 JSON 字符串验证的可维护性与扩展性

碧海醫心

碧海醫心

发布时间:2025-12-31 14:28:49

|

653人浏览过

|

来源于php中文网

原创

标题:使用 JSON 模板递归校验提升 JSON 字符串验证的可维护性与扩展性

本文介绍一种基于 json 模板 + 递归遍历的轻量级验证方案,替代传统硬编码字段判空逻辑,显著降低 48+ 字段 json 的验证冗余度,提升健壮性、可读性与可维护性。

在处理结构复杂、字段繁多(如 48+ 字段)的 JSON 输入时,逐字段 map.get("xxx") + 手动类型强转 + 空值/空字符串/空集合三重判断的写法不仅高度重复、易出错、难以维护,还严重违反开闭原则——新增字段需同步修改验证逻辑,且无法统一约束嵌套结构(如 offerSpecifications.price 是否存在、是否为数字)。

更优解是采用 「Schema-like 模板驱动验证」:定义一个轻量 JSON 模板(Template),明确每个字段的存在性、类型、非空性(对字符串/数组)及嵌套结构,再通过递归比对模板与实际数据,自动完成全路径校验。

HTTPie AI
HTTPie AI

AI API开发工具

下载

✅ 核心实现思路

  1. 模板定义:用标准 JSON 字符串描述期望结构(字段名、类型占位符、默认值),不依赖外部 Schema 格式(如 JSON Schema),零学习成本;
  2. 递归校验:遍历模板所有键,对每个字段执行:
    • ✅ 存在性检查(data.get(key) != null);
    • ✅ 类型一致性(templateNode.getNodeType() == dataNode.getNodeType());
    • ✅ 值有效性(字符串非空、数组非空、对象递归进入);
  3. 错误语义化:抛出含路径信息的异常(如 "Missing offerSpecifications.price"),便于快速定位。

? 示例代码(精简可复用版)

ObjectMapper mapper = new ObjectMapper();

// 1. 定义结构化模板(仅声明结构,无需真实值)
String templateJson = """
    {
      "productName": "",
      "offerStartDate": "",
      "offerEndDate": "",
      "offerAttributes": [],
      "offerSpecifications": {
        "price": 0.0
      }
    }
    """;

JsonNode template = mapper.readTree(templateJson);
JsonNode data = mapper.readTree(yourJsonString); // 实际输入 JSON

validate(template, data); // 启动校验
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 dataNode = data.get(key);

        // 【必存在】字段缺失
        if (dataNode == null || dataNode.isNull()) {
            throw new ValidationException("Missing required field: " + key);
        }

        // 【类型一致】基本类型/容器类型匹配
        if (!field.getValue().getNodeType().equals(dataNode.getNodeType())) {
            throw new ValidationException(
                String.format("Type mismatch at '%s': expected %s, got %s",
                    key,
                    field.getValue().getNodeType(),
                    dataNode.getNodeType())
            );
        }

        // 【值有效】按类型精细化校验
        switch (field.getValue().getNodeType()) {
            case STRING:
                if (dataNode.asText().trim().isEmpty()) {
                    throw new ValidationException("Empty string not allowed for field: " + key);
                }
                break;
            case ARRAY:
                if (dataNode.isEmpty()) {
                    throw new ValidationException("Array '" + key + "' must not be empty");
                }
                break;
            case OBJECT:
                validate(field.getValue(), dataNode); // 递归校验嵌套对象
                break;
            case NUMBER:
            case BOOLEAN:
                // 数值/布尔类型默认接受(可按需扩展范围校验,如 price > 0)
                break;
            default:
                // 其他类型(null、missing)已在前置检查拦截
        }
    }
}

// 自定义异常,便于上层捕获和日志追踪
public static class ValidationException extends Exception {
    public ValidationException(String message) { super(message); }
}

⚠️ 注意事项与增强建议

  • 模板即文档:将 templateJson 提取为 resources/validation-template.json,成为 API 的契约文档,前后端共用;
  • 支持可选字段:若某字段允许缺失,模板中设为 null,校验时跳过该键(需在 validate() 中增加 if (field.getValue().isNull()) continue;);
  • 深度定制:可在模板中嵌入元数据(如 "price": {"type": "number", "min": 0.01, "required": true}),升级为简易 JSON Schema 解析器;
  • 性能优化:对高频调用场景,预编译 template 为不可变树结构,避免每次解析;
  • 与 Spring 集成:结合 @Valid + 自定义 ConstraintValidator,实现注解式校验。

✅ 总结

相比原始 48× 手动判空代码,模板驱动验证将校验逻辑从“过程式”转向“声明式”
? 减少 90%+ 冗余代码(无重复 get()、instanceof、isEmpty());
? 天然支持任意深度嵌套(递归自动穿透 offerSpecifications.price);
? 错误可追溯、易调试、易协作(模板即接口契约);
? 零第三方依赖(仅需 Jackson),轻量、可控、易于演进。

从此,JSON 验证不再是维护噩梦,而是一份清晰、自解释、可持续生长的结构契约。

相关专题

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

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

98

2025.08.06

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

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

0

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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号