如何判断 JSON 模式与 Java 中的另一个模式兼容？

Question

例如，我有一个 JSON 架构，如下所示：

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "billing_address": { "$ref": "#/definitions/address" },
    "shipping_address": { "$ref": "#/definitions/address" }
  }

  "definitions": {
    "address": {
      "type": "object",
      "properties": {
        "street_address": { "type": "string" },
        "city":           { "type": "string" },
        "state":          { "type": "string" }
      }, 
      "required": ["street_address", "city", "state"]
    }
  }
}

该模式表示一个具有两个可用的billing_address和shipping_address的对象，它们都是address类型，其中包含三个属性：street_address、city和state。

现在我得到了另一个“更大”的模式：

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "billing_address": { "$ref": "#/definitions/address" },
    "shipping_address": { "$ref": "#/definitions/address" },
    "new_address": { "$ref": "#/definitions/address" }
  }

  "definitions": {
    "address": {
      "type": "object",
      "properties": {
        "street_address": { "type": "string" },
        "city":           { "type": "string" },
        "state":          { "type": "string" },
        "zip_code":       { "type": "string" }
      }, 
      "required": ["street_address", "city", "state"]
    }
  }
}

正如您所看到的，我在架构中添加了一个新属性new_address ，并且在address中有一个名为zip_code的新属性，这不是必需的属性。

因此，如果我从旧的 JSON 模式创建了一个对象，它也应该可用于新的 JSON 模式。在这种情况下，我们称新模式与旧模式兼容。（换句话说，新模式是旧模式的扩展，但没有修改。）

问题是如何判断 Java 中的模式是否与另一个模式兼容？还应该注意复杂的情况，例如数字字段的“最小”属性。

Answer 1

测试一下吧。在我当前的项目中，我正在编写以下合同测试：

1) 拥有 Java 域对象，我将其序列化为 JSON 并将其与引用 JSON 数据进行比较。我使用https://github.com/skyscreamer/JSONassert来比较两个 JSON 字符串。对于参考 JSON 数据，您需要使用“较小的架构”对象。

2) 有了示例 JSON 数据，我将其反序列化为我的域对象，并验证反序列化是否成功。我将反序列化结果与模型对象进行比较。对于示例 JSON 数据，您应该使用“更大的架构”对象。此测试验证“较大架构”JSON 数据是否向后兼容您的“较小架构”域。

我在域模型的每一级编写这些测试 - 一个用于顶级对象，另一个用于每个重要的嵌套对象。这需要更多的测试代码和更多的 JSON 示例数据，但可以提供更好的信心。如果出现故障，错误消息将进行微调，您将确切地知道层次结构的哪个级别被破坏（JSONAssert 错误消息可能有许多错误，并且对于深度嵌套的对象层次结构来说读取起来并不简单）。因此，这是 * 维护测试代码所花费的时间和数据 * 错误消息质量之间的权衡

这样的测试速度很快——它们只需要 JSON 序列化/反序列化。

https://github.com/spring-cloud/spring-cloud-contract将帮助您为 REST API、消息传递等编写合约测试 - 但对于简单的情况，我上面给出的过程可能已经足够了