数据模式样式,应该'name'对象的键或属性

data schema style, should the 'name' of an object be the key or a property

本文关键字:属性 对象 name 应该 样式 数据 模式      更新时间:2023-09-26

我有一些麻烦找到关于这个主题的在线建议,尽管我不得不在API设计中多次做出选择。

一组数据应该以映射形式呈现,还是以数组形式呈现(每个节点的"name"作为属性)?

映射:

{ "data_name": {"data_value": 10, "unit": "bytes"} }
数组:

[ {"name": "data_name" "data_value": 10, "unit": "bytes"} ]

映射方法确实使数据创建和读取更容易,代码行更少。然而,数组方法创建了一个封装良好的类型,适合作为单个变量提供给构造函数或函数,而不是(name, data_type)对变量。数组方法似乎也更接近于数据库风格,其中的"name"可能是一些命名字段。

当然,数组方法可以简单地转换为映射;

mapping = dict((v['name'],v) for v in array)

从映射转换为数组需要改变数据类型(通过引入一个新属性'name')。数组->映射转换还允许对键的用户进行选择,例如UUID、散列或任何参数。

遗憾的是,谷歌的风格指南没有参与进来:http://google.github.io/styleguide/jsoncstyleguide.xml

事情似乎有利于数组方法,但它确实倾向于需要更多的代码,有时乍一看似乎不自然。

这是我经过几天的讨论后给出的答案。

简而言之,总是选择数组格式。以下是选择映射有意义的情况:

  1. 你正在黑掉或者写掉一个。-节省一行代码是值得的
  2. 有一个非常明显的键选择,它从来不需要作为数据的属性。

数组的好处是数据点作为一个单元存在,没有成对的键和数据。