1、 EspressifIoTSDKJson命名準(zhǔn)則 CONFIDENTIAL INTERNAL PUBLIC1 / 7Espressif SystemsJune 19, 2014StatusReleasedCurrent versionV0.1AuthorHan LiuCompletion Date2014.6.19ReviewerJiangang WuCompletion Date2014.6.19 版本信息免責(zé)申明和版權(quán)公告本文中的信息，包括供參考的 URL 地址，如有變更，恕不另行。文檔“按現(xiàn)狀”提供，不負(fù)任何擔(dān)保責(zé)任，包括對適銷性、適用于特定用途或非侵權(quán)性的任何擔(dān)保，和任何提案、規(guī)格或樣

2、品在他處提到的任何擔(dān)保。本文檔不負(fù)任何責(zé)任，包括使用本文檔內(nèi)信息產(chǎn)生的任何專利權(quán)行為的責(zé)任。本文檔在此未以禁止反言或其他方式授予任何知識(shí)產(chǎn)權(quán)使用許可，不管是明示許可還是暗示許可。Wi-Fi 聯(lián)盟成員標(biāo)志歸 Wi-Fi 聯(lián)盟所有。文中提到的所有商標(biāo)名稱、商標(biāo)和注冊商標(biāo)均屬其各自所有者的財(cái)產(chǎn)，特此聲明。版權(quán)歸 2014 樂鑫信息技術(shù)有限公司所有。保留所有權(quán)利。2 / 7Espressif SystemsJune 19, 2014日期版本撰寫人審核人修改說明20Han Liu初稿 目錄版本信息2目錄31.前言42.準(zhǔn)則52.1. 一般準(zhǔn)則52.1.1. 注釋52.1.2. 使用雙引

3、號(hào)52.1.3. 扁平化數(shù)據(jù) VS 結(jié)構(gòu)化數(shù)據(jù)52.2. 屬性名準(zhǔn)則62.2.1. 屬性名格式62.2.2. 命名沖突62.2.3. 屬性值準(zhǔn)則73 / 7Espressif SystemsJune 19, 2014 1.前言本文主要介紹基于ESP_IOT lib庫創(chuàng)建的JSON APIs而提供的指導(dǎo)性準(zhǔn)則和建議。總體來講，JSON APIs應(yīng)遵循JSON.org上的規(guī)范。這份準(zhǔn)則澄清和標(biāo)準(zhǔn)化了特定情況，適用于基于REST風(fēng)格的API的JSON請求和響應(yīng)。 4 / 7Espressif SystemsJune 19, 2014 2.準(zhǔn)則為了更好地實(shí)現(xiàn)這份的規(guī)范目的，下面幾項(xiàng)需要說明： 屬性(p

4、roperty) - JSON對象內(nèi)的鍵值對(name/value pair) 屬性名(property name) - 屬性的名稱 屬性值(property value) - 分配給屬性的值示例： / 一組鍵值對稱作一個(gè) 屬性. propertyName: propertyValue 2.1.一般準(zhǔn)則2.1.1. 注釋JSON對象中不應(yīng)該包含注釋。 2.1.2. 使用雙引號(hào)如果（某個(gè)）屬性需要引號(hào)，則必須使用雙引號(hào)。所有的屬性名必須在雙引號(hào)內(nèi)。字符類型的屬性值必須使用雙引號(hào)。其它類型值（如布爾或數(shù)字）不應(yīng)該使用雙引號(hào)。 2.1.3. 扁平化數(shù)據(jù) VS 結(jié)構(gòu)化數(shù)據(jù)JSON中的屬性元素應(yīng)以扁平化

5、方式呈現(xiàn)，不能為了方便而將數(shù)據(jù)任意分組。但是,在某些情況下，結(jié)構(gòu)化的方式對開發(fā)人員來講更有意義。比如描述單 一結(jié)構(gòu)的一批屬性，因它被用來保持結(jié)構(gòu)層次，所以是有意義的，遇到這些情況應(yīng)當(dāng)慎重考慮。示例： 扁平化方式： ssid: tenda_837R, password: 結(jié)構(gòu)化方式：Requese: Station: “Connect:ssid: tenda_837R, password: 5 / 7Espressif SystemsJune 19, 2014 2.2.屬性準(zhǔn)則2.2.1. 屬性名準(zhǔn)則選擇有意義的屬性名。必須遵循以下準(zhǔn)則:屬性名應(yīng)該是具有定義語義的有意義的名稱； 屬性名必須是駝峰

6、式的，ASCII碼字符串； 首字符必須是不能包含數(shù)字； 當(dāng)一個(gè)屬性名有子屬性，而無屬性值時(shí)，首字符大寫； 當(dāng)一個(gè)屬性名無子屬性，但有屬性值時(shí)，小寫； 隨后的其他字符可以包含數(shù)字。示例： Response: st atus:02.2.2. 命名沖突新的屬性可在將來被添加進(jìn)保留列表中。如果存在命名沖突，可通過選擇新的屬性名或者版本化來解決這個(gè)問題。示例： version: 1.0, message: sucessful:true,information: flash.bin, data: sensor, device如果希望將來把information列為保留字，可以通過下面兩件事情來達(dá)成。1.選

7、一個(gè)不同的名字 version: 1.0, Message: sucessful:true,information: flash.bin, information0: irom.bin, Data : sensor, device6 / 7Espressif SystemsJune 19, 2014 version: 2.0, Message : sucessful:true,information: irom.bin, Data: sensor, device2.2.3.屬性值準(zhǔn)則JSON.org上的標(biāo)準(zhǔn)準(zhǔn)確的說明了哪些類型的數(shù)據(jù)可以作為屬性值。屬性值必須是Unicode的booleans(布爾),數(shù)字(numbers),字符串(strings),對象(object),數(shù)組(arrays)或null等。 JavaScript表達(dá)式是不被接受的。APIs應(yīng)該支持該準(zhǔn)則，并為某個(gè)特定的屬性選擇最合適的數(shù)據(jù)類型。示例： message: null, / null sucessful: false, / b