能否通过Gson从JSON Schema提取属性标签用于TypeAdapter？

AI 小北

2026-8-8

如何从JSON Schema动态提取属性名用于Gson TypeAdapter，避免硬编码？

问题背景

我希望Gson TypeAdapter无需硬编码JSON对象的属性标签，而是从JSON Schema中动态获取这些字符串。例如现有如下JSON Schema：

{
  "$id": "/schemas/address",
  "type": "object",
  "properties": {
    "street_address": { "type": "string" },
    "city": { "type": "string" },
    "state": { "type": "string" }
  }
}

想要从中提取street_address、city、state这些属性名，赋值给TypeAdapter或Factory中的变量，替代硬编码的写法：

// 不想要的硬编码方式
String streetName = "street_address";

转而实现类似这样的动态获取：

// 期望的动态获取方式
String streetName = getSchemaProperty("/schemas/address").getProperty(0);

这样当Schema更新属性标签时，无需修改Adapter中的字符串。我可以自行编写解析Schema的代码，但想了解是否已有现成实现（比如通过注解等方式）？

解决方案

目前没有官方或主流的Gson扩展直接支持从JSON Schema动态提取属性名到TypeAdapter，但可以通过以下几种成熟方案实现需求：

1. 使用JSON Schema解析库封装工具类

借助成熟的JSON Schema解析库（如Jackson的JSON Schema模块、org.json-schema-validator），封装一个工具类来加载并解析Schema，提取属性名。

示例实现（基于Jackson）：

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class SchemaPropertyHelper {
    // 缓存已加载的Schema，避免重复IO操作
    private static final Map<String, JsonNode> SCHEMA_CACHE = new HashMap<>();
    private static final ObjectMapper MAPPER = new ObjectMapper();

    // 加载指定ID的Schema
    private static JsonNode loadSchema(String schemaId) throws IOException {
        if (SCHEMA_CACHE.containsKey(schemaId)) {
            return SCHEMA_CACHE.get(schemaId);
        }
        // 假设Schema文件放在resources/schemas目录下
        InputStream schemaStream = SchemaPropertyHelper.class.getResourceAsStream("/schemas" + schemaId);
        JsonNode schema = MAPPER.readTree(schemaStream);
        SCHEMA_CACHE.put(schemaId, schema);
        return schema;
    }

    // 根据索引获取Schema中的属性名
    public static String getPropertyByIndex(String schemaId, int index) throws IOException {
        JsonNode schema = loadSchema(schemaId);
        JsonNode propertiesNode = schema.get("properties");
        if (propertiesNode == null || !propertiesNode.isObject()) {
            throw new IllegalArgumentException("目标Schema无有效属性定义");
        }
        List<String> propertyNames = new ArrayList<>(propertiesNode.fieldNames());
        if (index < 0 || index >= propertyNames.size()) {
            throw new IndexOutOfBoundsException("属性索引超出范围");
        }
        return propertyNames.get(index);
    }

    // 根据属性逻辑名获取Schema中的实际键名（更推荐，比索引更稳定）
    public static String getPropertyByName(String schemaId, String logicalName) throws IOException {
        JsonNode schema = loadSchema(schemaId);
        JsonNode propertiesNode = schema.get("properties");
        if (propertiesNode != null && propertiesNode.has(logicalName)) {
            return logicalName;
        }
        throw new IllegalArgumentException("Schema中不存在指定属性");
    }
}

在TypeAdapter中调用：

// 按索引获取
String streetName = SchemaPropertyHelper.getPropertyByIndex("/address", 0);
// 更推荐：按逻辑名获取（避免Schema属性顺序变化导致错误）
String cityName = SchemaPropertyHelper.getPropertyByName("/address", "city");

2. 编译时注解处理器生成常量类

如果希望在编译期就完成Schema属性的绑定，避免运行时IO和解析开销，可以自定义注解+注解处理器，在编译时解析Schema并生成包含属性名常量的类。

步骤示例：

定义注解：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface SchemaBound {
    String schemaId();
}

编写注解处理器：在编译时读取指定的Schema文件，提取属性名，生成类似AddressSchemaConstants的类，包含STREET_ADDRESS = "street_address"等常量。

在TypeAdapter中直接使用生成的常量：

String streetName = AddressSchemaConstants.STREET_ADDRESS;

这种方式的优势是编译期就能检测Schema的变化，若Schema属性名修改，生成的常量也会同步更新，无需手动修改Adapter代码。

3. 基于jsonschema2pojo扩展

如果项目中已经使用jsonschema2pojo生成POJO类，可以参考它的Schema解析逻辑，扩展出提取属性名的工具。该库本身已经实现了成熟的Schema解析功能，只需复用其核心逻辑即可。

内容的提问来源于stack exchange，提问作者Shane Gillis