java - 如何在 Java 中将 JSON 架构中的默认值添加到 JSON 文档

Question

我需要验证 JSON 文档，如果给定文档中缺少值，则添加架构中定义的默认值。我正在使用networknt/json-schema-validator用于验证，但我不确定如何添加默认值。有没有办法使用上面的库或其他一些工具来做到这一点？

Answer 1

在 JSON 架构中没有明确定义的方法来执行此操作。

<小时/>

虽然 JSON 架构中有一个“default”关键字，但它主要用于用户界面使用，以提供默认初始值。考虑架构:

{ "type":"string", "minLength":1, "default":"" }

在本例中，含义是“当我创建此模式的实例时，为其指定一个空字符串的初始值。”

首先，请注意此默认文档仍然无效 - 用户必须对其进行更改才能生效。 “默认”只需是格式良好的 JSON。提供它是因为，在这种情况下，空字符串是比空文档(这将是无效的 JSON)更好的默认值。

其次，JSON Schema 并不假设未定义的值与提供的默认值相同。允许使用默认值填充未定义的属性来更改实例的含义。例如，给定以下架构:

{ "properties":
    "port": { "type":"number", "default": 80 }
}

未定义的属性可能意味着一件事，但一旦我创建该属性，它应该默认为 80。

第三，“default”关键字甚至不适用，除非实例存在以便可以考虑该关键字。如果您尝试填充对象中的属性，为了让 JSON 模式 validator “看到”“default”关键字，它必须首先针对具有此类关键字的模式应用实例。

使用上面的架构，如果您有一个像 {} 这样的实例， validator 甚至永远不会遇到“default”关键字，因为该实例没有可以加载子项的“port”属性包含它的架构。

<小时/>

我不知道有哪个库可以执行您所描述的操作。

但是，如果您想编写一个，我建议您编写这样的模式:

{
  "default": {
    "port": 80
  },
  "properties": {
    "port": { "type":"integer" }
  }
}

这将使 validator 可以访问“default”关键字的值，即使“port”属性丢失也是如此。然后，您可以编写一个简短的脚本来合并任何缺失的属性。

参见https://github.com/json-schema-org/json-schema-spec/issues/858 JSON Schema 问题跟踪器中的类似内容。