您使用哪个词来描述类似JSON的对象?

时间:2009-09-23 21:49:20

标签: json naming-conventions

我有一个命名问题。

如果我从某些JSON读取对象x,我可以调用我的变量xJson(或某些变体)。然而,有时数据可能来自许多不同的来源,其中JSON并不特殊(例如,XMLRPC,以编程方式从地图,列表和原语等构建)。

在这种情况下,变量的一个好名字是什么?到目前为止,我提出的最好的东西是“动态数据”,在某些情况下可以使用,但对于不熟悉约定的人来说有点长并且可能不太清楚。

3 个答案:

答案 0 :(得分:1)

SerializedData?

答案 1 :(得分:1)

无论使用何种序列化格式,散列和数据列表的分层集合通常称为文档。另一个有用的描述可能是 payload body ,它们是用于传输的消息体或写入键/值存储的值字符串。

我倾向于将对象层次结构称为“doc”,而序列化格式则称为“文档”。因此,RequestDocument被解析为RequestDoc,并且在进一步识别时它可能变成OrderDoc或CustomerUpdateDoc等。一般来说,InvoiceDoc可能被称为ResponseDoc,最终被序列化为ResponseDocument。

较长的形式很笨拙,但是这样的序列化字符串通常是短暂的并且无论如何都会在代码中本地化。

答案 2 :(得分:1)

如果您的数据是模型,请在它所代表的模型之后命名。例如,在内容的目的之后命名它,而不是内容的格式。因此,如果它是客户信息列表,请将其命名为“customers”或“customerModel”,或类似名称。

如果您不知道内容是什么,名称并不重要,除非您想要区分格式。 “responseData”,“jsonResponse”等......

“动态数据”并不是一个长名称,除非绝对没有任何关于数据的描述。 “数据”可能就好了。