當(dāng)前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

Json风格指南

發(fā)布時間：2025/3/15 编程问答 30 豆豆

生活随笔收集整理的這篇文章主要介紹了 Json风格指南小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.

英文版：http://google-styleguide.googlecode.com/svn/trunk/jsoncstyleguide.xml

翻譯：Darcy Liu

簡介

該風(fēng)格指南是對在Google創(chuàng)建JSON APIs而提供的指導(dǎo)性準(zhǔn)則和建議。總體來講，JSON APIs應(yīng)遵循JSON.org上的規(guī)范。這份風(fēng)格指南澄清和標(biāo)準(zhǔn)化了特定情況，從而使Google的JSON APIs有一種標(biāo)準(zhǔn)的外觀和感覺。這些指南適用于基于RPC和基于REST風(fēng)格的API的JSON請求和響應(yīng)。

定義

為了更好地實(shí)現(xiàn)這份風(fēng)格指南的目的，下面幾項(xiàng)需要說明：

屬性(property) - JSON對象內(nèi)的鍵值對(name/value pair)

屬性名(property name) - 屬性的名稱(或鍵)

屬性值(property value) - 分配給屬性的值

示例：

{

??// 一組鍵值對稱作一個 "屬性".

??"propertyName": "propertyValue"

}

Javascript的數(shù)字(number)包含所有的浮點(diǎn)數(shù),這是一個寬泛的指定。在這份指南中，數(shù)字(number)指代Javascript中的數(shù)字(number)類型，而整型(integer)則指代整型。

一般準(zhǔn)則

注釋

JSON對象中不包含注釋。

JSON對象中不應(yīng)該包含注釋。該指南中的某些示例含有注釋。但這僅僅是為了說明示例。

{

??// 你可能在下面的示例中看到注釋,

??// 但不要在你的JSON數(shù)據(jù)中加入注釋.

??"propertyName": "propertyValue"

}

雙引號

使用雙引號

如果（某個）屬性需要引號，則必須使用雙引號。所有的屬性名必須在雙引號內(nèi)。字符類型的屬性值必須使用雙引號。其它類型值（如布爾或數(shù)字）不應(yīng)該使用雙引號。

扁平化數(shù)據(jù) VS 結(jié)構(gòu)層次

不能為了方便而將數(shù)據(jù)任意分組

JSON中的數(shù)據(jù)元素應(yīng)以扁平化方式呈現(xiàn)。不能為了方便而將數(shù)據(jù)任意分組。

在某些情況下，比如描述單一結(jié)構(gòu)的一批屬性，因?yàn)樗挥脕肀３纸Y(jié)構(gòu)層次，因而是有意義的。但是遇到這些情況還是應(yīng)當(dāng)慎重考慮，記住只有語義上有意義的時候才使用它。例如，一個地址可以有表示兩種方式，但結(jié)構(gòu)化的方式對開發(fā)人員來講可能更有意義：

扁平化地址:

{

??"company": "Google",

??"website": "http://www.google.com/",

??"addressLine1": "111 8th Ave",

??"addressLine2": "4th Floor",

??"state": "NY",

??"city": "New York",

??"zip": "10011"

}

結(jié)構(gòu)化地址：

{

??"company": "Google",

??"website": "http://www.google.com/",

??"address": {

????"line1": "111 8th Ave",

????"line2": "4th Floor",

????"state": "NY",

????"city": "New York",

????"zip": "10011"

??}

}

屬性名準(zhǔn)則

屬性名格式

選擇有意義的屬性名

屬性名必須遵循以下準(zhǔn)則:

屬性名應(yīng)該是具有定義語義的有意義的名稱。

屬性名必須是駝峰式的，ASCII碼字符串。

首字符必須是字母，下劃線(_)或美元符號($)。

隨后的其他字符可以是字母，數(shù)字，下劃線(_)或美元符號($)。

應(yīng)該避免使用Javascript中的保留關(guān)鍵字(下文附有Javascript保留字清單)

這些準(zhǔn)則反映JavaScript標(biāo)識符命名的指導(dǎo)方針。使JavaScript的客戶端可以使用點(diǎn)符號來訪問屬性。(例如,result.thisIsAnInstanceVariable).

下面是一個對象的一個屬性的例子：

{

??"thisPropertyIsAnIdentifier": "identifier value"

}

JSON Map中的鍵名

在JSON Map中鍵名可以使用任意Unicode字符

當(dāng)JSON對象作為Map(映射)使用時，屬性的名稱命名規(guī)則并不適用。Map（也稱作關(guān)聯(lián)數(shù)組）是一個具有任意鍵/值對的數(shù)據(jù)類型，這些鍵/值對通過特定的鍵來訪問相應(yīng)的值。JSON對象和JSON Map在運(yùn)行時看起來是一樣的；這個特性與API設(shè)計相關(guān)。當(dāng)JSON對象被當(dāng)作map使用時，API文件應(yīng)當(dāng)做出說明。

Map的鍵名不一定要遵循屬性名稱的命名準(zhǔn)則。鍵名可以包含任意的Unicode字符?？蛻舳丝墒褂胢aps熟悉的方括號來訪問這些屬性。（例如result.thumbnails["72"]）

{

??// "address" 屬性是一個子對象

??// 包含地址的各部分.

??"address": {

????"addressLine1": "123 Anystreet",

????"city": "Anytown",

????"state": "XX",

????"zip": "00000"

??},

??// "address" 是一個映射

??// 含有響應(yīng)規(guī)格所對應(yīng)的URL，用來映射thumbnail url的像素規(guī)格

??"thumbnails": {

????"72": "http://url.to.72px.thumbnail",

????"144": "http://url.to.144px.thumbnail"

??}

}

保留的屬性名稱

某些屬性名稱會被保留以便能在多個服務(wù)間相容使用

保留屬性名稱的詳細(xì)信息，連同完整的列表，可在本指南后面的內(nèi)容中找到。服務(wù)應(yīng)按照被定義的語義來使用屬性名稱。

單數(shù)屬性名 VS 復(fù)數(shù)屬性名

數(shù)組類型應(yīng)該是復(fù)數(shù)屬性名。其它屬性名都應(yīng)該是單數(shù)。

數(shù)組通常包含多個條目，復(fù)數(shù)屬性名就反映了這點(diǎn)。在下面這個保留名稱中可以看到例子。屬性名items是復(fù)數(shù)因?yàn)樗枋龅氖且唤M對象。大多數(shù)的其它字段是單數(shù)。

當(dāng)然也有例外，尤其是涉及到數(shù)字的屬性值的時候。例如，在保留屬性名中，totalItems?比?totalItem更合理。然后，從技術(shù)上講，這并不違反風(fēng)格指南，因?yàn)?totalItems?可以被看作?totalOfItems, 其中?total?是單數(shù)（依照風(fēng)格指南），OfItems?用來限定總數(shù)。字段名也可被改為?itemCount，這樣看起來更象單數(shù).

{

??// 單數(shù)

??"author": "lisa",

??// 一組同胞, 復(fù)數(shù)

??"siblings": [ "bart", "maggie"],

??// "totalItem" 看起來并不對

??"totalItems": 10,

??// 但 "itemCount" 要好些

??"itemCount": 10

}

命名沖突

通過選擇新的屬性名或?qū)PI版本化來避免命名沖突

新的屬性可在將來被添加進(jìn)保留列表中。JSON中不存在命名空間。如果存在命名沖突，可通過選擇新的屬性名或者版本化來解決這個問題。例如，假設(shè)我們由下面的JSON對象開始：

{

??"apiVersion": "1.0",

??"data": {

????"recipeName": "pizza",

????"ingredients": ["tomatoes", "cheese", "sausage"]

??}

}

如果我們希望將來把ingredients列為保留字，我們可以通過下面兩件事情來達(dá)成:

1.選一個不同的名字

{

??"apiVersion": "1.0",

??"data": {

????"recipeName": "pizza",

????"ingredientsData": "Some new property",

????"ingredients": ["tomatoes", "cheese", "sausage"]

??}

}

2.在主版本上重新命名屬性

{

??"apiVersion": "2.0",

??"data": {

????"recipeName": "pizza",

????"ingredients": "Some new property",

????"recipeIngredients": ["tomatos", "cheese", "sausage"]

??}

}

屬性值準(zhǔn)則

屬性值格式

屬性值必須是Unicode 的 booleans（布爾）, 數(shù)字(numbers), 字符串(strings), 對象(objects), 數(shù)組(arrays), 或 null.

JSON.org上的標(biāo)準(zhǔn)準(zhǔn)確地說明了哪些類型的數(shù)據(jù)可以作為屬性值。這包含Unicode的布爾(booleans), 數(shù)字(numbers), 字符串(strings), 對象(objects), 數(shù)組(arrays), 或 null。JavaScript表達(dá)式是不被接受的。APIs應(yīng)該支持該準(zhǔn)則，并為某個特定的屬性選擇最合適的數(shù)據(jù)類型（比如，用numbers代表numbers等）。

好的例子：

{

??"canPigsFly": null, ????// null

??"areWeThereYet": false, // boolean

??"answerToLife": 42, ????// number

??"name": "Bart", ????????// string

??"moreData": {}, ????????// object

??"things": [] ???????????// array

}

不好的例子：

{

??"aVariableName": aVariableName, ????????// Bad - JavaScript 標(biāo)識符

??"functionFoo": function() { return 1; } // Bad - JavaScript 函數(shù)

}

空或Null 屬性值

考慮移除空或null值

如果一個屬性是可選的或者包含空值或null值，考慮從JSON中去掉該屬性，除非它的存在有很強(qiáng)的語義原因。

{

??"volume": 10,

??// 即使 "balance" 屬性值是零, 它也應(yīng)當(dāng)被保留,

??// 因?yàn)?"0" 表示 "均衡"

??// "-1" 表示左傾斜和"＋1" 表示右傾斜

??"balance": 0,

??// "currentlyPlaying" 是null的時候可被移除

??// "currentlyPlaying": null

}

枚舉值

枚舉值應(yīng)當(dāng)以字符串的形式呈現(xiàn)

隨著APIs的發(fā)展，枚舉值可能被添加，移除或者改變。將枚舉值當(dāng)作字符串可以使下游用戶幽雅地處理枚舉值的變更。

Java代碼：

public enum Color {

??WHITE,

??BLACK,

??RED,

??YELLOW,

??BLUE

{

??// 自由女神像的緯度/經(jīng)度位置.

??"statueOfLiberty": "+40.6894-074.0447"

}

JSON結(jié)構(gòu)和保留屬性名

為了使APIs保持一致的借口，JSON對象應(yīng)當(dāng)使用以下的結(jié)構(gòu)。該結(jié)構(gòu)適用于JSON的請求和響應(yīng)。在這個結(jié)構(gòu)中，某些屬性名將被保留用作特殊用途。這些屬性并不是必需的，也就是說，每個保留的屬性可能出現(xiàn)零次或一次。但是如果服務(wù)需要這些屬性，建議遵循該命名條約。下面是一份JSON結(jié)構(gòu)語義表，以O(shè)rderly格式呈現(xiàn)(現(xiàn)在已經(jīng)被納入 JSONSchema)。你可以在該指南的最后找到關(guān)于JSON結(jié)構(gòu)的例子。

object {

??string apiVersion?;

??string context?;

??string id?;

??string method?;

??object {

????string id?

??}* params?;

??object {

????string kind?;

????string fields?;

????string etag?;

????string id?;

????string lang?;

????string updated?; # date formatted RFC 3339

????boolean deleted?;

????integer currentItemCount?;

????integer itemsPerPage?;

????integer startIndex?;

????integer totalItems?;

????integer pageIndex?;

????integer totalPages?;

????string pageLinkTemplate /^https?:/ ?;

????object {}* next?;

????string nextLink?;

????object {}* previous?;

????string previousLink?;

????object {}* self?;

????string selfLink?;

????object {}* edit?;

????string editLink?;

????array [

??????object {}*;

????] items?;

??}* data?;

??object {

????integer code?;

????string message?;

????array [

??????object {

????????string domain?;

????????string reason?;

????????string message?;

????????string location?;

????????string locationType?;

????????string extendedHelp?;

????????string sendReport?;

??????}*;

????] errors?;

??}* error?;

}*;

JSON對象有一些頂級屬性，然后是data對象或error對象，這兩者不會同時出現(xiàn)。下面是這些屬性的解釋。

頂級保留屬性名稱

頂級的JSON對象可能包含下面這些屬性

apiVersion

屬性值類型: 字符串(string)

父節(jié)點(diǎn): -

呈現(xiàn)請求中服務(wù)API期望的版本，以及在響應(yīng)中保存的服務(wù)API版本。應(yīng)隨時提供apiVersion。這與數(shù)據(jù)的版本無關(guān)。將數(shù)據(jù)版本化應(yīng)該通過其他的機(jī)制來處理，如etag。

示例：

{ "apiVersion": "2.1" }

context

屬性值類型: 字符串(string)

父節(jié)點(diǎn): -

客戶端設(shè)置這個值，服務(wù)器通過數(shù)據(jù)作出回應(yīng)。這在JSON-P和批處理中很有用，用戶可以使用context將響應(yīng)與請求關(guān)聯(lián)起來。該屬性是頂級屬性，因?yàn)椴还茼憫?yīng)是成功還是有錯誤，context總應(yīng)當(dāng)被呈現(xiàn)出來。context不同于id在于context由用戶提供而id由服務(wù)分配。

示例：

請求 #1:

http://www.google.com/myapi?context=bart

請求 #2:

http://www.google.com/myapi?context=lisa

響應(yīng) #1:

{

??"context": "bart",

??"data": {

????"items": []

??}

}

響應(yīng) #2:

{

??"context": "lisa",

??"data": {

????"items": []

??}

}

公共的JavaScript處理器通過編碼同時處理以下兩個響應(yīng)：

function handleResponse(response) {

??if (response.result.context == "bart") {

屬性值類型: 對象(object)

父節(jié)點(diǎn): -

包含響應(yīng)的所有數(shù)據(jù)。該屬性本身擁有許多保留屬性名，下面會有相應(yīng)的說明。服務(wù)可以自由地將自己的數(shù)據(jù)添加到這個對象。一個JSON響應(yīng)要么應(yīng)當(dāng)包含一個data對象，要么應(yīng)當(dāng)包含error對象，但不能兩者都包含。如果data和error同時出現(xiàn)，則error對象優(yōu)先。

error

屬性值類型: 對象(object)

父節(jié)點(diǎn): -

表明錯誤發(fā)生，提供錯誤的詳細(xì)信息。錯誤的格式支持從服務(wù)返回一個或多個錯誤。一個JSON響應(yīng)可以有一個data對象或者一個error對象，但不能兩者都包含。如果data和error都出現(xiàn)，error對象優(yōu)先。

示例：

{

??"apiVersion": "2.0",

??"error": {

????"code": 404,

????"message": "File Not Found",

????"errors": [{

??????"domain": "Calendar",

??????"reason": "ResourceNotFoundException",

??????"message": "File Not Found

????}]

??}

}

data對象的保留屬性名

JSON對象的data屬性可能包含以下屬性。

data.kind

屬性值類型: 字符串(sting)

父節(jié)點(diǎn): data

kind屬性是對某個特定的對象存儲何種類型的信息的指南?？梢园阉旁?/span>data層次，或items的層次，或其它任何有助于區(qū)分各類對象的對象中。如果kind對象被提供，它應(yīng)該是對象的第一個屬性（詳見下面的屬性順序部分）。

示例：

// "Kind" indicates an "album" in the Picasa API.

{"data": {"kind": "album"}}

data.fields

屬性值類型: 字符串(string)

父節(jié)點(diǎn): data

表示做了部分GET之后響應(yīng)中出現(xiàn)的字段，或做了部分PATCH之后出現(xiàn)在請求中的字段。該屬性僅在做了部分GET請求/批處理時存在，且不能為空。

示例：

{

??"data": {

????"kind": "user",

????"fields": "author,id",

????"id": "bart",

????"author": "Bart"

??}

} ??

data.etag

屬性值類型: 字符串(string)

父節(jié)點(diǎn): data

響應(yīng)時提供etag。關(guān)于GData APIs中的ETags詳情可以在這里找到：http://code.google.com/apis/gdata/docs/2.0/reference.html#ResourceVersioning

示例：

{"data": {"etag": "W/"C0QBRXcycSp7ImA9WxRVFUk.""}}

data.id

屬性值類型: 字符串(string)

父節(jié)點(diǎn): data

一個全局唯一標(biāo)識符用于引用該對象。id屬性的具體細(xì)節(jié)都留給了服務(wù)。

示例：

{"data": {"id": "12345"}}

data.lang

屬性值類型: 字符串(string)(格式由BCP 47指定)

父節(jié)點(diǎn): data (或任何子元素)

表示該對象內(nèi)其他屬性的語言。該屬性模擬HTML的lang屬性和XML的xml:lang屬性。值應(yīng)該是BCP 47中定義的一種語言值。如果一個單一的JSON對象包含的數(shù)據(jù)有多種語言，服務(wù)負(fù)責(zé)制定和標(biāo)明lang屬性的適當(dāng)位置。

示例：

{"data": {

??"items": [

????{ "lang": "en",

??????"title": "Hello world!" },

????{ "lang": "fr",

??????"title": "Bonjour monde!" }

??]}

}

data.updated

屬性值類型: 字符串(string)(格式由RFC 3339指定)

父節(jié)點(diǎn): data

指明條目更新的最后日期/時間(RFC 3339)，由服務(wù)規(guī)定。

示例：

{"data": {"updated": "2007-11-06T16:34:41.000Z"}}

data.deleted

屬性值類型: 布爾(boolean)

父節(jié)點(diǎn): data (或任何子元素)

一個標(biāo)記元素，當(dāng)出現(xiàn)時，表示包含的條目已被刪除。如果提供了刪除屬性，它的值必須為true;為false會導(dǎo)致混亂，應(yīng)該避免。

示例：

{"data": {

??"items": [

????{ "title": "A deleted entry",

??????"deleted": true

????}

??]}

}

data.items

屬性值類型: 數(shù)組(array)

父節(jié)點(diǎn): data

屬性名items被保留用作表示一組條目(例如,Picasa中的圖片，YouTube中的視頻)。這種結(jié)構(gòu)的目的是給與當(dāng)前結(jié)果相關(guān)的集合提供一個標(biāo)準(zhǔn)位置。例如，知道頁面上的items是數(shù)組，JSON輸出便可能插入一個通用的分頁系統(tǒng)。如果items存在，它應(yīng)該是data對象的最后一個屬性。（詳見下面的屬性順序部分）。

示例：

{

??"data": {

????"items": [

??????{ /* Object #1 */ },

??????{ /* Object #2 */ },

??????...

????]

??}

}

用于分頁的保留屬性名

下面的屬性位于data對象中，用來給一列數(shù)據(jù)分頁。一些語言和概念是從OpenSearch規(guī)范中借鑒過來的。

下面的分頁數(shù)據(jù)允許各種風(fēng)格的分頁，包括：

上一頁/下一頁 - 允許用戶在列表中前進(jìn)和后退，一次一頁。nextLink?和previousLink屬性 (下面的"鏈接保留屬性名"部分有描述) 用于這種風(fēng)格的分頁。

基于索引的分頁 - 允許用戶直接跳到條目列表的某個條目位置。例如，要從第200個條目開始載入10個新的條目，開發(fā)者可以給用戶提供一個URL的查詢字符串?startIndex=200。

基于頁面的分頁 - 允許用戶直接跳到條目內(nèi)的具體頁。這跟基于索引的分頁很類似,但節(jié)省了開發(fā)者額外的步驟，不需再為新一頁的條目計算條目索引。例如，開發(fā)人員可以直接跳到第20頁，而不是跳到第200條條目?；陧撁娣猪摰木W(wǎng)址，可以使用查詢字符串?page=1或?page=20。pageIndex和?totalPages?屬性用作這種風(fēng)格的分頁.

在這份指南的最后可以找到如何使用這些屬性來實(shí)現(xiàn)分頁的例子。

data.currentItemCount

屬性值類型: 整數(shù)(integer)

父節(jié)點(diǎn): data

結(jié)果集中的條目數(shù)目。應(yīng)該與items.length相等，并作為一個便利屬性提供。例如，假設(shè)開發(fā)者請求一組搜索條目，并且要求每頁10條。查詢集共有14條。第一個條目頁將會有10個條目，因此itemsPerPage和currentItemCount都應(yīng)該等于10。下一頁的條目還剩下4條；itemsPerPage仍然是10,但是currentItemCount是4.

示例：

{

??"data": {

????// "itemsPerPage" 不需要與 "currentItemCount" 匹配

????"itemsPerPage": 10,

????"currentItemCount": 4

??}

}

data.itemsPerPage

屬性值類型: 整數(shù)(integer)

父節(jié)點(diǎn): data

items結(jié)果的數(shù)目。未必是data.items數(shù)組的大小；如果我們查看的是最后一頁，data.items的大小可能小于itemsPerPage。但是，data.items的大小不應(yīng)超過itemsPerPage。

示例：

{

??"data": {

????"itemsPerPage": 10

??}

}

data.startIndex

屬性值類型: 整數(shù)(integer)

父節(jié)點(diǎn): data

data.items中第一個條目的索引。為了一致，startIndex應(yīng)從1開始。例如，第一組items中第一條的startIndex應(yīng)該是1。如果用戶請求下一組數(shù)據(jù)，startIndex可能是10。

示例：

{

??"data": {

????"startIndex": 1

??}

}

data.totalItems

屬性值類型: 整數(shù)(integer)

父節(jié)點(diǎn): data

當(dāng)前集合中可用的總條目數(shù)。例如，如果用戶有100篇博客文章，響應(yīng)可能只包含10篇，但是totalItems應(yīng)該是100。

示例：

{

??"data": {

????"totalItems": 100

??}

}

data.pagingLinkTemplate

屬性值類型: 字符串(string)

父節(jié)點(diǎn): data

URL模板指出用戶可以如何計算隨后的分頁鏈接。URL模板中也包含一些保留變量名：表示要載入的條目的{index}，和要載入的頁面的{pageIndex}。

示例：

{

??"data": {

????"pagingLinkTemplate": "http://www.google.com/search/hl=en&q=chicago+style+pizza&start={index}&sa=N"

??}

}

data.pageIndex

屬性值類型: 整數(shù)(integer)

父節(jié)點(diǎn): data

條目的當(dāng)前頁索引。為了一致，pageIndex應(yīng)從1開始。例如，第一頁的pageIndex是1。pageIndex也可以通過基于條目的分頁而計算出來pageIndex = floor(startIndex / itemsPerPage) + 1。

示例：

{

??"data": {

????"pageIndex": 1

??}

}

data.totalPages

屬性值類型: 整數(shù)(integer)

JSON對象的error屬性應(yīng)包含以下屬性。

error.code

屬性值類型: 整數(shù)(integer)

父節(jié)點(diǎn): error

表示該錯誤的編號。這個屬性通常表示HTTP響應(yīng)碼。如果存在多個錯誤，code應(yīng)為第一個出錯的錯誤碼。

示例：

{

??"error":{

????"code": 404

??}

}

error.message

屬性值類型: 字符串(string)

父節(jié)點(diǎn): error

一個人類可讀的信息，提供有關(guān)錯誤的詳細(xì)信息。如果存在多個錯誤，message應(yīng)為第一個錯誤的錯誤信息。

示例：

{

??"error":{

屬性值類型: 字符串(string)

父節(jié)點(diǎn): error.errors

一個人類可讀的信息，提供有關(guān)錯誤的更多細(xì)節(jié)。如果只有一個錯誤，該字段應(yīng)該與error.message匹配。

示例：

{

??"error":{

????"code": 404

????"message": "File Not Found",

????"errors": [{"message": "File Not Found"}]

??}

} ??????

error.errors[].location

屬性值類型: 字符串(string)

父節(jié)點(diǎn): error.errors

錯誤發(fā)生的位置（根據(jù)locationType字段解釋該值）。

示例：

{

??"error":{

????"errors": [{"location": ""}]

??}

}

error.errors[].locationType

屬性值類型: 字符串(string)

父節(jié)點(diǎn): error.errors

標(biāo)明如何解釋location屬性。

示例：

{

??"error":{

????"errors": [{"locationType": ""}]

??}

}

error.errors[].extendedHelp

屬性值類型: 字符串(string)

父節(jié)點(diǎn): error.errors

help text的URI，使錯誤更易于理解。

示例：（注：原示例這里有筆誤，中文版這里做了校正）

{

??"error":{

????"errors": [{"extendedHelp": "http://url.to.more.details.example.com/"}]

??}

}

error.errors[].sendReport

屬性值類型: 字符串(string)

父節(jié)點(diǎn): error.errors

report form的URI，服務(wù)用它來收集錯誤狀態(tài)的數(shù)據(jù)。該URL會預(yù)先載入描述請求的參數(shù)

示例：

{

??"error":{

????"errors": [{"sendReport": "http://report.example.com/"}]

??}

}

屬性順序

在JSON對象中屬性可有任意順序。然而，在某些情況下，有序的屬性可以幫助分析器快速解釋數(shù)據(jù)，并帶來更好的性能。在移動環(huán)境下的解析器就是個例子，在這種情況下，性能和內(nèi)存是至關(guān)重要的，不必要的解析也應(yīng)盡量避免。

Kind屬性

Kind屬性應(yīng)為第一屬性

假設(shè)一個解析器負(fù)責(zé)將一個原始JSON流解析成一個特定的對象。kind屬性會引導(dǎo)解析器將適合的對象實(shí)例化。因而它應(yīng)該是JSON對象的第一個屬性。這僅適用于對象有一個kind屬性的情況(通常可以在data和items屬性中找到)。

Items屬性

items應(yīng)該是data對象的最后一個屬性

這使得閱讀每一個具體條目前前已讀所有的集合屬性。在有很多條目的情況下，這樣就避免了開發(fā)人員只需要從數(shù)據(jù)的字段時不必要的解析這些條目。

這讓閱讀所有集合屬性先于閱讀單個條目。如遇多個條目的情況，當(dāng)開發(fā)者僅需要數(shù)據(jù)中的字段時，這就可避免解析不必要的條目。

屬性順序示例：

// "kind" 屬性區(qū)分 "album" 和 "photo".

// "Kind" 始終是它父對象的第一個屬性.

// "items" 屬性是 "data" 對象的最后一個屬性.

{

??"data": {

????"kind": "album",

????"title": "My Photo Album",

????"description": "An album in the user's account",

????"items": [

??????{

????????"kind": "photo",

????????"title": "My First Photo"

??????}

????]

??}

}

示例

YouTube JSON API

這是YouTube JSON API響應(yīng)對象的示例。你可以從中學(xué)到更多關(guān)于YouTube JSON API的內(nèi)容：http://code.google.com/apis/youtube/2.0/developers_guide_jsonc.html

{

??"apiVersion": "2.0",

??"data": {

????"updated": "2010-02-04T19:29:54.001Z",

????"totalItems": 6741,

????"startIndex": 1,

????"itemsPerPage": 1,

????"items": [

??????{

????????"id": "BGODurRfVv4",

????????"uploaded": "2009-11-17T20:10:06.000Z",

????????"updated": "2010-02-04T06:25:57.000Z",

????????"uploader": "docchat",

????????"category": "Animals",

????????"title": "From service dog to SURFice dog",

????????"description": "Surf dog Ricochets inspirational video ...",

????????"tags": [

??????????"Surf dog",

??????????"dog surfing",

??????????"dog",

??????????"golden retriever",

????????],

????????"thumbnail": {

??????????"default": "http://i.ytimg.com/vi/BGODurRfVv4/default.jpg",

??????????"hqDefault": "http://i.ytimg.com/vi/BGODurRfVv4/hqdefault.jpg"

????????},

????????"player": {

??????????"default": "http://www.youtube.com/watch?v=BGODurRfVv4&feature=youtube_gdata",

??????????"mobile": "http://m.youtube.com/details?v=BGODurRfVv4"

????????},

????????"content": {

??????????"1": "rtsp://v5.cache6.c.youtube.com/CiILENy73wIaGQn-Vl-0uoNjBBMYDSANFEgGUgZ2aWRlb3MM/0/0/0/video.3gp",

??????????"5": "http://www.youtube.com/v/BGODurRfVv4?f=videos&app=youtube_gdata",

??????????"6": "rtsp://v7.cache7.c.youtube.com/CiILENy73wIaGQn-Vl-0uoNjBBMYESARFEgGUgZ2aWRlb3MM/0/0/0/video.3gp"

????????},

????????"duration": 315,

????????"rating": 4.96,

????????"ratingCount": 2043,

????????"viewCount": 1781691,

????????"favoriteCount": 3363,

????????"commentCount": 1007,

????????"commentsAllowed": true

??????}

????]

??}

}

分頁示例

如何將Google搜索條目作為JSON對象展現(xiàn)出來，對分頁變量也有特別關(guān)注。

這個示例僅用作說明。下面的API實(shí)際上并不存在。

這是Google搜索結(jié)果頁面的示例：?

這是該頁面JSON形式的呈現(xiàn)：

{

??"apiVersion": "2.1",

??"id": "1",

??"data": {

????"query": "chicago style pizza",

????"time": "0.1",

????"currentItemCount": 10,

????"itemsPerPage": 10,

????"startIndex": 11,

????"totalItems": 2700000,

????"nextLink": "http://www.google.com/search?hl=en&q=chicago+style+pizza&start=20&sa=N"

????"previousLink": "http://www.google.com/search?hl=en&q=chicago+style+pizza&start=0&sa=N",

????"pagingLinkTemplate": "http://www.google.com/search/hl=en&q=chicago+style+pizza&start={index}&sa=N",

????"items": [

??????{

????????"title": "Pizz'a Chicago Home Page"

????????// More fields for the search results

??????}

??????// More search results

????]

??}

}

這是如何展現(xiàn)屏幕截圖中的色塊的例子（背景顏色對應(yīng)下圖中的顏色）

Results 11 - 20 of about 2,700,000 = startIndex

Results 11 - 20 of about 2,700,000 = startIndex + currentItemCount - 1

Results 11 - 20 of about 2,700,000 = totalItems

Search results = items (formatted appropriately)

Previous/Next = previousLink / nextLink

Numbered links in "Gooooooooooogle" = Derived from "pageLinkTemplate". The developer is responsible for calculating the values for {index} and substituting those values into the "pageLinkTemplate". The pageLinkTemplate's {index} variable is calculated as follows:

Index #1 = 0 * itemsPerPage = 0

Index #2 = 2 * itemsPerPage = 10

Index #3 = 3 * itemsPerPage = 20

Index #N = N * itemsPerPage

附錄

附錄A:JavaScript中的保留字

下列JavaScript保留字應(yīng)該避免在屬性名中使用

下面的但在在JavaScript語言中被保留，不能作為在點(diǎn)訪問符中使用。這份名單代表此時的最佳關(guān)鍵字的知識;列表可能會改變或根據(jù)您的特定的執(zhí)行環(huán)境更改。

下面是JavaScript語言中的保留字，且不能在點(diǎn)訪問符中使用。這份清單集合了當(dāng)前最新的關(guān)鍵字，該清單可能會根據(jù)具體的執(zhí)行環(huán)境而有所變更或改變。

來自ECMAScript 語言規(guī)范第五版

abstract

boolean break byte

case catch char class const continue

debugger default delete do double

else enum export extends

false final finally float for function

goto

if implements import in instanceof int interface

let long

native new null

package private protected public

return

short static super switch synchronized

this throw throws transient true try typeof

var volatile void

while with

yield

除了特別說明，該頁面的內(nèi)容均由共同創(chuàng)作協(xié)議(CC BY 3.0)授權(quán)許可，示例代碼均由Apache 2.0許可證授權(quán)許可）

總結(jié)

以上是生活随笔為你收集整理的Json风格指南的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。

上一篇： Javascript中“==”与“===
下一篇：飞鸽传书的这一新的通信方式采用云技术