基于Kotlin与Jackson实现JSON中$ref引用解析的方案咨询

你的需求完全可行，而且不用自己手动基于Jackson遍历处理——这类带$ref的JSON引用解析、验证及整合场景，属于JSON Schema生态的标准需求，已有成熟工具库可以直接复用，能省掉大量手动处理的坑（比如循环引用、URI解析、外部文件加载等）。

核心实现思路 #

放弃手动遍历Jackson的JsonNode，改用专门的JSON Schema处理库，这类库原生支持：

• 递归解析本地/外部文件的$ref引用
• 验证引用指向的定义是否有效
• 保留原$ref引用，同时将所有外部/分散的定义整合到主文件的$defs字段中
• 自动调整$ref的路径为指向$defs的内部锚点（比如将$ref: "references.json#/User"改为$ref: "#/$defs/User"）

推荐工具库（Java环境） #

以你正在用的Java技术栈为例，推荐使用com.networknt:json-schema-validator：

1. 依赖引入（Maven）：

<dependency>
    <groupId>com.networknt</groupId>
    <artifactId>json-schema-validator</artifactId>
    <version>1.0.80</version> <!-- 替换为最新稳定版 -->
</dependency>

2. 核心代码逻辑：

import com.networknt.schema.JsonSchema;
import com.networknt.schema.JsonSchemaFactory;
import com.networknt.schema.SchemaValidatorsConfig;
import com.networknt.schema.output.DefaultMetaSchema;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.File;
import java.io.FileWriter;

public class JsonRefProcessor {
    public static void main(String[] args) throws Exception {
        ObjectMapper mapper = new ObjectMapper();
        // 加载主JSON文件
        JsonNode mainSchema = mapper.readTree(new File("main_request_original.json"));
        
        // 配置Schema工厂，启用引用解析与整合
        SchemaValidatorsConfig config = new SchemaValidatorsConfig();
        config.setMetaSchema(DefaultMetaSchema.getV202012()); // 根据你的JSON Schema版本选择对应元Schema
        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(config);
        
        // 解析并验证引用，同时整合所有定义到$defs
        JsonSchema schema = factory.getSchema(mainSchema);
        JsonNode processedSchema = schema.asJsonNode();
        
        // 输出到_validated.json
        try (FileWriter writer = new FileWriter("main_request_original_validated.json")) {
            mapper.writerWithDefaultPrettyPrinter().writeValue(writer, processedSchema);
        }
    }
}

这个库会自动完成：

• 递归加载外部文件（如references.json）
• 验证每个$ref指向的定义是否存在
• 将所有引用的定义合并到主文件的$defs中
• 保留原$ref引用并调整路径为内部锚点

手动实现的坑（不推荐） #

如果坚持自己用Jackson手动处理，需要逐一解决以下问题：

• 递归遍历所有JsonNode，识别$ref字段
• 解析$ref的URI，区分本地文件、外部URL、内部锚点
• 加载外部文件并递归处理其中的$ref
• 收集所有引用的定义并去重，避免重复写入$defs
• 处理循环引用（比如A引用B，B引用A），防止无限递归
• 验证每个$ref对应的定义是否存在，抛出明确的错误信息
  手动实现不仅耗时，还容易遗漏边界场景，远不如现成库可靠。

内容的提问来源于stack exchange，提问作者Kelson Hartle