支持 json 模式中的 std::map< std::string, T >答案

【问题标题】：support for std::map< std::string, T > in json schema支持 json 模式中的 std::map< std::string, T >
【发布时间】：2013-07-30 14:42:58
【问题描述】：

是否有一种标准方法可以将属性指定为字典或以字符串为键的映射，其值类型为在架构中的其他位置指定的 T？

例如，假设您要为用户最喜欢的电影建模，其中键类型是电影的名称，值类型是电影的某些属性集（制作年份、预算、总收入等）

我想您可以首先将 MovieDataPair 建模为具有 name 属性和包含所需属性的 value 属性的类型。然后地图将是这些的数组。但是，你需要一个特殊的唯一约束来确保任何电影名称只出现一次。

json 模式中是否有支持这一点的东西，或者用于它的标准模式？如果 json schema 没有内置支持，那么其他 schema 解决方案呢？

【问题讨论】：

感谢您提出（并回答！）这个问题，这正是我想要的。

标签： json jsonschema

【解决方案1】：

经过一番研究，我想出了以下答案：

查看实际情况的最佳方法是找到一些示例。它碰巧在 draft04 模式中有几个这样的例子本身（定义、properties、patternProperties、...）和它们通常遵循相同的模式。

例如，draft04 模式的 definitions 属性定义了什么应该出现在 definitions 属性的架构中。这里是与 definitions 属性关联的子模式：

"definitions": {
    "type": "object",
    "additionalProperties": { "$ref": "#" },
    "default": {}
},

这表示“#/definitions/”处的条目必须是一个对象。事实它是一个 json 对象意味着它本身将具有唯一的键。现在对于对象中的 values，这就是 additionalProperties 旨在描述。在这种情况下，它表示每个值属性本身必须符合模式“#”的根。这是什么表示有效 json 模式的 definitions 属性对象中的每个值对象也必须是模式。如果这是像 C++ 一样的类型，它可能看起来像：

std::map< std::string, Schema > definitions;

实际上，带有字符串键的映射可以被认为是一个 json 具有结构化值类型的对象。因此，要创建自己的：

std::map< std::string, T >

首先定义 T 的架构。例如：

"definitions" : {
   "movie" : {
       "properties": {
          "title" : { "type" : "string" },
          "year_made" : { "type" : "integer" },
          "rating" : { "type" : "integer" }
       }
    }
}

对于存储的值类型 T，决定是否要允许任何属性，只要将这些指定的属性键入为上面指定。如果您只想要这些属性，请添加 “附加属性”：假

 "definitions" : {
   "movie" : {
       "additionalProperties" : false,
       "properties": {
          "title" : { "type" : "string" },
          "year_made" : { "type" : "integer" },
          "rating" : { "type" : "integer" }
       }
    }
 }

还要确定您是否真的需要所有属性为电影有效。如果是这样，请添加一个必需的条目。

"definitions" : {
  "movie" : {
    "additionalProperties": false,
    "required" : [ "title", "year_made", "rating" ],
    "properties": {
      "title" : { "type" : "string" },
      "year_made" : { "type" : "integer" },
      "rating" : { "type" : "integer" }
  }
},

现在定义了电影的shape T。为引用电影模式的电影集合或映射定义为草案模式中的定义。注：在 "movie_map" additionalProperties 的含义不同于 “电影”。在“电影”的情况下，它是一个布尔值 false 这表明除了列出的内容之外没有其他属性属性。在“movie_map”的情况下，它意味着 - 如果有附加属性，它们必须看起来像这个架构。但，因为在 movie_map 中没有指定任何属性，这实际上意味着对象实例中的所有属性都必须符合#/definitions/movie。现在都 “movie_map”中的值看起来像定义的 movie 架构。
```
{
  "definitions" : {
    "movie" : {
      "additionalProperties": false,
      "required" : [ "title", "year_made", "rating" ],
      "properties": {
        "title" : { "type" : "string" },
        "year_made" : { "type" : "integer" },
        "rating" : { "type" : "integer" }
      }
    },
    "movie_map" : {
      "type": "object",
      "additionalProperties": { "$ref": "#/definitions/movie" },
      "default": {}
    }
  }
}
```

现在在模式中的某处使用定义的模式movie_map：

{
  "title" : "movie data",
  "additionalProperties" : false,
  "required" : [ "movies" ],
  "properties" : {
    "movies" : { "$ref" : "#/definitions/movie_map" }
  },
  "definitions" : {
    "movie" : {
      "additionalProperties": false,
      "required" : [ "title", "year_made", "rating" ],
      "properties": {
        "title" : { "type" : "string" },
        "year_made" : { "type" : "integer" },
        "rating" : { "type" : "integer" }
      }
    },
    "movie_map" : {
      "type": "object",
      "additionalProperties": { "$ref": "#/definitions/movie" },
      "default": {}
    }
  }
}

这是一个示例对象，可以将其视为电影的地图验证架构：

{
  "movies" : {
    "the mission" : {
      "title":"The Mission",
      "year_made":1986,
      "rating":5
    },
    "troll 2" : {
      "title":"Troll 2",
      "year_made":1990,
      "rating":2
    }
  }
}

【讨论】：

我正在尝试解决相同的用例，但目前 Jackson 2.4.2 模块没有为 HashMap 获得这种类型的模式，我看到 github.com/FasterXML/jackson-module-jsonSchema 这个模块解决了这种模式，但它仍然存在自我引用问题，该模块将在 2.4.1 中修复。那么我们应该如何使用 Jackson Parser 来处理当前情况下的这种情况。我不知道问这个问题是否合适，但您似乎已经对此进行了大量研究。

【解决方案2】：

如果我想为用户最喜欢的电影建模一个结构（提醒 Json Schema 用于结构验证），我会做这样的事情：

{
"description":"moviesFan",
"properties": [
    "favoriteMovies": {
        "type":"array",
        "uniqueItems":True
        "allOf": [{ "$ref": "#/definitions/movie" }]
    }
],
"definitions": {
    "movie": {
        "type": "object",
        "properties": {
            "yearMade": {}
            ...
        }
    }
}

这对你有意义吗？

【讨论】：

有用 - 但我特别关注其中键是字符串（标题）和值是一组固定属性的映射。我希望标题成为关键，因为它已经用作代码中的索引。在研究了模式文档之后，我想知道是否需要一个模式属性，其中模式与任何字符串匹配，并且它的值是所需的电影属性。或者，或者，最简单的方法可能是仅使用所需的移动属性定义附加属性 - 这可能会做到吗？
我想我还没有理解你想要达到的目标。每部电影都有不同的模式，或者您想使用 Json-Schema 来开发电影目录并强制执行一种“参考完整性” à la XSD？
每部电影都有相同的架构。 json 实例将是这些电影的集合，这些电影作为值存储在 object（即地图）中。每部电影都有一个标题，我希望标题是关键。例如{“乱世佳人”：{...}，“战争游戏”：{...}}。这里的 {...} 将是由模式描述的电影属性，例如 #/definitions/movie，它可能再次包含标题。当然，标题可以是任何字符串。我不需要唯一的，因为它作为键存储在 json 实例中。
为什么你“需要”将标题作为“属性名称”？ Json-Schema 是关于结构的。 AFAIK 拥有越来越多的属性名称没有多大意义。
嗯，这就是数据的结构方式。 JSON 模式的使用排在第二位，仅次于事实。想想 mongo 文档中结构良好的数据，其中 id 是一个字符串。或者考虑一个 C++ 类，其中 PersonFavorites 的成员是 std::map _favoriteMovies;

【解决方案3】：

这是我支持地图的方式。希望有所帮助。

{ “类型”：“对象”， "title": "地图数据", “必需的”： [ “地图” ], “特性”： { “sOnePurRecord”：{ “标题”：“地图”， “附加属性”：假， “特性”： { “地图项”：{ “类型”：“对象”， “最大属性”：10， “最小属性”：1， “模式属性”：{ "^[a-zA-Z0-9]{5,20}$": { "$ref": "#/定义/值" } }, “附加属性”：{ "$ref": "#/定义/值" } } }, “必需的”： [ “地图项” ] } }, “定义”：{ “价值”： { “类型”：“对象”， “特性”： { “姓名”： { “类型”：“字符串” }, “ID”： { “类型”：“整数” } } } } }

【讨论】：