
本文介绍一种基于 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、对象用 {}):
ObjectMapper mapper = new ObjectMapper();
JsonNode template = mapper.readTree(
"{" +
" \"productName\": \"\"," +
" \"offerStartDate\": \"\"," +
" \"offerEndDate\": \"\"," +
" \"offerAttributes\": []," +
" \"offerSpecifications\": {" +
" \"price\": 0" +
" }" +
"}");⚠️ 注意:模板中 "" 表示该字段必须存在且为非空字符串;[] 表示必须为非空数组;{} 表示必须为非空对象;0 或 false 表示必须为对应类型(不校验具体值,仅保类型安全)。
接着,使用递归校验方法 validate(JsonNode template, JsonNode data) 自动遍历模板节点,对实际数据执行三重检查:
- 存在性检查:data.get(key) == null → 报“Missing xxx”
- 类型一致性检查:template.nodeType() != data.nodeType() → 报“Mismatch data type”
-
语义约束检查:
- 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 个通用方法,新增字段只需更新模板,零代码修改,真正实现高内聚、低耦合、易演进的验证体系。










