Java生成JSON Schema方法详解

本文将介绍如何使用 Java 动态地将 JSON 数据转换为 JSON Schema。由于仅凭单个 JSON 样本难以准确推断其结构，我们将探讨一种简单的方法，即通过将数据包装在 `{"const": ... }` 中来生成一个仅验证该特定 JSON 实例的 Schema。 此外，我们还会讨论在拥有大量 JSON 样本的情况下，生成更通用的 JSON Schema 的可能性，并强调人工定义 Schema 的重要性。

生成 JSON Schema 的方法

直接从单个 JSON 样本生成通用的 JSON Schema 是一个具有挑战性的任务。因为程序无法仅凭一个实例判断哪些属性是固定的，哪些属性是可变的。 为了解决这个问题，我们可以采用一种简单的方法，将 JSON 数据包装在 {"const": ... } 中。 这种方法会生成一个 JSON Schema，它只验证与原始 JSON 实例完全匹配的数据。

示例代码

以下是一个使用 Java 和 Jackson 库将 JSON 数据转换为 JSON Schema 的示例代码：

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;

public class JsonSchemaGenerator {

    public static void main(String[] args) throws Exception {
        String jsonString = "{\"id\":1,\"name\":\"abc\",\"tech\":\"java\"}";

        ObjectMapper mapper = new ObjectMapper();
        JsonNode jsonNode = mapper.readTree(jsonString);

        // Create the JSON Schema
        ObjectNode schema = mapper.createObjectNode();
        schema.put("$schema", "http://json-schema.org/draft-04/schema#");
        schema.put("type", "object");

        ObjectNode properties = mapper.createObjectNode();
        ObjectNode idNode = mapper.createObjectNode();
        idNode.put("type", "integer");
        properties.set("id", idNode);

        ObjectNode nameNode = mapper.createObjectNode();
        nameNode.put("type", "string");
        properties.set("name", nameNode);

        ObjectNode techNode = mapper.createObjectNode();
        techNode.put("type", "string");
        properties.set("tech", techNode);

        schema.set("properties", properties);
        schema.putArray("required").add("id").add("name").add("tech");


        // Print the JSON Schema
        System.out.println(mapper.writerWithDefaultPrettyPrinter().writeValueAsString(schema));
    }
}

这个例子使用 Jackson 库解析 JSON 字符串，并构建一个表示 JSON Schema 的 ObjectNode。 我们定义了 $schema， type， properties (以及每个属性的类型)，和 required 字段。

使用 const 关键字

如果你想创建一个只验证特定 JSON 实例的 schema，你可以使用 const 关键字：

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;

public class JsonSchemaGenerator {

    public static void main(String[] args) throws Exception {
        String jsonString = "{\"id\":1,\"name\":\"abc\",\"tech\":\"java\"}";

        ObjectMapper mapper = new ObjectMapper();
        JsonNode jsonNode = mapper.readTree(jsonString);

        // Create the JSON Schema
        ObjectNode schema = mapper.createObjectNode();
        schema.put("$schema", "http://json-schema.org/draft-04/schema#");
        schema.set("const", jsonNode);

        // Print the JSON Schema
        System.out.println(mapper.writerWithDefaultPrettyPrinter().writeValueAsString(schema));
    }
}

这段代码会生成一个 schema，它只验证与输入 JSON 字符串完全相同的 JSON。

大量数据样本的情况

如果有大量 JSON 样本，可以尝试编写程序生成一个验证所有样本的 JSON Schema。 然而，这仍然只是猜测，最终需要人工来表达数据的上下文，并定义准确的 Schema。 可以使用诸如 everit-org/json-schema 这样的库来验证生成的 Schema 是否符合预期。

注意事项

• Schema 的准确性： 自动生成的 Schema 可能不完全符合你的需求。 需要仔细检查并根据实际情况进行调整。
• 数据类型推断： 程序在推断数据类型时可能会出错。 例如，一个看起来像数字的字符串可能会被误认为整数。
• 复杂结构： 处理嵌套的 JSON 结构和数组可能需要更复杂的逻辑。
• 库的选择： Jackson 是一个常用的 JSON 处理库，但也有其他选择，例如 Gson。

总结

虽然可以使用 Java 动态生成 JSON Schema，但需要根据具体情况选择合适的方法。 对于单个 JSON 样本，使用 const 关键字可以生成一个简单的 Schema。 对于大量数据样本，可以尝试自动生成 Schema，但最终需要人工验证和调整。 重要的是要理解 JSON Schema 的作用，并根据数据的上下文来定义准确的 Schema。