jsonschema - 如何根据字段描述的对象类型针对 JSON 模式验证 JSON 对象？

Question

我有许多对象(消息)需要针对 JSON 模式(draft-04)进行验证。每个对象都保证有一个“类型”字段，它描述了它的类型，但是每种类型都有一组完全不同的其他字段，因此每种类型的对象都需要一个唯一的模式。

我看到了几种可能性，但都不是特别吸引人，但我希望我遗漏了一些东西。

可能性 1:对每种消息类型使用 oneOf。我想这会起作用，但问题是很长的验证错误，以防出现问题:验证器倾向于报告每个失败的模式，其中包括“oneOf”数组中的所有元素。

{
  "oneOf":
  [
    {
      "type": "object",
      "properties":
      {
        "t":
        {
          "type": "string",
          "enum":
          [
            "message_type_1"
          ]
        }
      }
    },
    {
      "type": "object",
      "properties":
      {
        "t":
        {
          "type": "string",
          "enum":
          [
            "message_type_2"
          ]
        },
        "some_other_property":
        {
          "type": "integer"
        }
      },
      "required":
      [
        "some_other_property"
      ]
    }
  ]
}

可能性2:嵌套的“if”、“then”、“else”三元组。我没有尝试过，但我想在这种情况下错误可能会更好。但是，写起来很麻烦，因为嵌套的 if 堆积如山。

可能性 3:每个可能的“t”值的单独方案。这是最简单的解决方案，但我不喜欢它，因为它使我无法在模式中使用公共(public)元素(通过引用)。

那么，这些是我唯一的选择，还是我可以做得更好？

Answer 1

由于“type”是 JSON Schema 关键字，为了清楚起见，我将按照您的指示使用“t”作为类型区分字段。

没有特定的关键字来完成或表明这一点(但是，请参阅 https://github.com/json-schema-org/json-schema-spec/issues/31 进行讨论)。这是因为，出于验证的目的，您需要做的一切都已经成为可能。在 JSON Schema 中，错误是次要的验证。我们试图做的只是限制我们看到的错误数量，因为很明显有一个点错误不再有效。

通常，当您验证消息时，您首先知道它的类型，然后再阅读消息的其余部分。例如在 HTTP 中，如果您正在读取以 Date: 开头的行。并且下一个字符不是数字或字母，您可以立即发出错误(例如“意外的波浪号，预期的月份名称”)。

然而，在 JSON 中，这不是真的，因为属性是无序的，而且你可能直到最后都不会遇到“t”，如果有的话。 “如果/那么”可以帮助解决这个问题。

但首先，首先要考虑最重要的约束，并将它们移到顶部。

首先，使用 "type": "object"和 "required":["t"]在您的顶级架构中，因为在所有情况下都是如此。

其次，使用“properties”和“enum”枚举其所有有效值。这样，如果“t”确实输入错误，那将是顶级架构的错误，而不是子架构。

如果所有这些约束都通过了，但文档仍然无效，那么更容易断定问题一定出在消息的其他内容上，而不是“t”属性本身。

现在在每个子模式中，使用 "const"将子模式与类型名称匹配。

我们得到这样的模式:

{
  "type": "object",
  "required": ["t"],
  "properties": { "t": { "enum": ["message_type_1", "message_type_2"] } }
  "oneOf": [
     {
        "type": "object",
        "properties": {
          "t": { "const": "message_type_1" }
        }
     },
     {
        "type": "object",
        "properties": 
          "t": { "const": "message_type_2" },
          "some_other_property": {
             "type": "integer"
          }
        },
        "required": [ "some_other_property" ]
     }
  ]
}

现在，将每种类型拆分为不同的模式文件。通过在“t”之后命名文件来使其易于访问。这样，应用程序可以读取对象流并选择模式来验证每个对象。

{
  "type": "object",
  "required": ["t"],
  "properties": { "t": { "enum": ["message_type_1", "message_type_2"] } }
  "oneOf": [
     {"$ref": "message_type_1.json"},
     {"$ref": "message_type_2.json"}
  ]
}

从理论上讲，验证器现在有足够的信息来产生更清晰的错误(尽管我不知道有任何验证器可以做到这一点)。

因此，如果这不能为您生成足够清晰的错误报告，您有两种选择:

首先，您可以自己实现部分验证过程。如上所述，使用流式 JSON 解析器，如 Oboe.js读取流中的每个对象，解析对象并读取“t”属性，然后应用适当的模式。

或者第二，如果你真的想纯粹在 JSON Schema 中执行此操作，请在 "allOf"中使用 "if/then"语句:

{
  "type": "object",
  "required": ["t"],
  "properties": { "t": { "enum": ["message_type_1", "message_type_2"] } }
  "allOf": [
     {"if":{"properties":{"t":{"const":"message_type_1"}}}, "then":{"$ref": "message_type_1.json"}},
     {"if":{"properties":{"t":{"const":"message_type_2"}}}, "then":{"$ref": "message_type_2.json"}}
  ]
}

这应该会产生以下错误:

t not one of "message_type_1" or "message_type_2"

或者

(because t="message_type_2") some_other_property not an integer

而不是两者兼而有之。