玩轉(zhuǎn) ESP32 + Arduino (十五) ArduinoJSON庫(V6版本)

書接上篇, 我們獲取了JSON數(shù)據(jù)怎么解析, 如果將來我們想發(fā)送JSON字符串怎么操作?
原來我們可以使用arduinoJson庫完成這些工作

以我們上一篇收到的JSON為例

{
  "results": [
    {
      "location": {
        "id": "WW7MBNP039PE",
        "name": "泰安",
        "country": "CN",
        "path": "泰安,泰安,山東,中國(guó)",
        "timezone": "Asia/Shanghai",
        "timezone_offset": "+08:00"
      },
      "now": { "text": "晴", "code": "0", "temperature": "28" },
      "last_update": "2020-09-09T10:09:00+08:00"
    }
  ]
}

我們?cè)撊绾谓馕鲞@個(gè)JSON呢?其實(shí)解析過程很簡(jiǎn)單, 而且只用了強(qiáng)大的ArduinoJson庫的一小部分功能
具體操作請(qǐng)參考本文第八節(jié)

下面是 ArduinoJSON庫的核心內(nèi)容:

一.V6版本函數(shù)庫結(jié)構(gòu)

可以看出艇抠，方法主要分為四大類：

JsonDocument相關(guān)嘶炭，這是整個(gè)json庫的入口宫补，它負(fù)責(zé)高效管理內(nèi)存以及調(diào)用json解析器蒜撮；
JsonObject相關(guān)；
JsonArray相關(guān)凑耻；
解析括尸、構(gòu)造相關(guān)镀钓；

在此先介紹一個(gè)概念: JsonVariant —— json變體（存儲(chǔ)可以放在json文件中的任意類型數(shù)據(jù)，包括int祭务，float内狗，數(shù)組，對(duì)象义锥，可以認(rèn)為它是一個(gè)抽象的對(duì)象概念柳沙，或者一個(gè)由JSON限定的var 或者dynamic ，理解即可）

二. 最重要的JsonDocument

JsonDocument作為整個(gè)V6版本ArduinoJson庫的內(nèi)存入口拌倍，負(fù)責(zé)處理整個(gè)json數(shù)據(jù)的內(nèi)存管理赂鲤，這是我們需要首先重點(diǎn)關(guān)注的內(nèi)容。

1.兩個(gè)實(shí)現(xiàn)類：

(1). DynamicJsonDocument

DynamicJsonDocument贰拿，內(nèi)存分配在heap區(qū)蛤袒，無固定大小，可以自動(dòng)增長(zhǎng)所需空間膨更，方法調(diào)用完自動(dòng)回收妙真，建議內(nèi)存大小大于1KB使用；

DynamicJsonDocument doc(2048); //創(chuàng)建一個(gè)DynamicJsonDocument類型的doc對(duì)象,大小2048byte

(2). StaticJsonDocument

StaticJsonDocument荚守，內(nèi)存分配在stack區(qū)珍德，有固定大小练般，大小值由開發(fā)者定義，方法調(diào)用完自動(dòng)回收锈候，建議內(nèi)存大小小于1KB使用薄料；

StaticJsonDocument<256> doc;

2. 使用JsonDocument

創(chuàng)建一個(gè)JsonDocument之后，默認(rèn)初始化為空泵琳，調(diào)用 JsonDocument::isNull()會(huì)返回true摄职，這個(gè)時(shí)候既可以代表當(dāng)做jsonObject，也可以當(dāng)做jsonArray获列，這取決于你插入第一個(gè)value的類型谷市。

例1: doc 作為JsonObject使用

DynamicJsonDocument doc(1024);
doc["answer"] = 42;
// the doc contains {"answer":42}

例2: doc 作為JsonArray使用

DynamicJsonDocument doc(1024);
doc.add(42);
// the doc contains [42]

3. as —— 獲取頂節(jié)點(diǎn)，并把它轉(zhuǎn)成T類型

DynamicJsonBuffer doc(1024);
deserializeJson(doc, "{\"key\":\"value\")");

// get the JsonObject in the JsonDocument
JsonObject root = doc.as<JsonObject>();

// get the value in the JsonObject
const char* value = root["key"];

此方法不會(huì)改變 JsonDocument的內(nèi)容（JsonDocument::to()會(huì)改變）
此方法只會(huì)返回JsonDocument頂節(jié)點(diǎn)的引用击孩。如果頂節(jié)點(diǎn)的類型和強(qiáng)轉(zhuǎn)的T類型不匹配迫悠，此方法將會(huì)返回空引用

4. to —— jsondocument轉(zhuǎn)成T類型

函數(shù)說明：

/**
 * jsondocument轉(zhuǎn)成T類型,T為JsonArray、JsonObject巩梢、JsonVariant
 */
JsonArray   to<JsonArray>();
JsonObject  to<JsonObject>();
JsonVariant to<JsonVariant>();

此方法是釋放jsondocument的內(nèi)存空間创泄，也就是說之前已經(jīng)分配的引用無效，參考代碼：

DynamicJsonBuffer doc(1024);

JsonObject root1 = doc.to<JsonObject>();

JsonObject root2 = doc.to<JsonObject>();

// Don't use root1 here, because it's dangling!

5. clear —— 清除JsonDocument并釋放內(nèi)存空間

清除JsonDocument并釋放內(nèi)存空間

doc.clear();

6. isNull —— 判斷jsondocument是否為空

/**
 * 判斷jsondocument是否為空
 */
bool isNull() const;

7. memoryUsage —— jsondocument已使用內(nèi)存字節(jié)數(shù)

函數(shù)說明：

/**
 * jsondocument已使用內(nèi)存字節(jié)數(shù)
 */
size_t memoryUsage() const;

8. remove —— 移除特定key和value

  results.remove(0);
  root.remove("results");

三. 解析構(gòu)造相關(guān)

1.deserializeJson —— 解析json

/**
 * 解析json
 * @param doc jsondocument對(duì)象
 * @param input 輸入內(nèi)容
 * @return DeserializationError 解析結(jié)果
 */
// writable input => zero-copy
DeserializationError deserializeJson(JsonDocument& doc, char* input);
DeserializationError deserializeJson(JsonDocument& doc, char* input, size_t inputSize);

// read-only input => duplication
DeserializationError deserializeJson(JsonDocument& doc, const char* input);
DeserializationError deserializeJson(JsonDocument& doc, const char* input, size_t inputSize);
DeserializationError deserializeJson(JsonDocument& doc, const __FlashStringHelper* input);
DeserializationError deserializeJson(JsonDocument& doc, const __FlashStringHelper* input, size_t inputSize);
DeserializationError deserializeJson(JsonDocument& doc, const String& input);
DeserializationError deserializeJson(JsonDocument& doc, const std::string& input);
DeserializationError deserializeJson(JsonDocument& doc, Stream& input);
DeserializationError deserializeJson(JsonDocument& doc, std::istream& input);

例子:

const char* json = "{\"hello\":\"world\"}";
StaticJsonDocument<200> doc;
deserializeJson(doc, json);
const char* world = doc["hello"];

2. serializeJson —— 構(gòu)造序列化json (串口打印json)

StaticJsonDocument<200> doc;
doc["hello"] = "world";
serializeJson(doc, Serial);

3. serializeJsonPretty —— 構(gòu)造序列化json括蝠，格式化輸出 (串口美化打印json)

/**
 * 構(gòu)造序列化json鞠抑，格式化輸出
 * @param doc jsondocument對(duì)象
 * @param output 輸出內(nèi)容
 */
size_t serializeJsonPretty(const JsonDocument& doc, char* output, size_t outputSize);
size_t serializeJsonPretty(const JsonDocument& doc, char output[size]);
size_t serializeJsonPretty(const JsonDocument& doc, Print& output);
size_t serializeJsonPretty(const JsonDocument& doc, String& output);
size_t serializeJsonPretty(const JsonDocument& doc, std::string& output);

4. measureJson —— 計(jì)算構(gòu)造序列化json的長(zhǎng)度

/**
 * 計(jì)算構(gòu)造序列化格式化json的長(zhǎng)度
 * @param doc jsondocument對(duì)象
 * @Note 關(guān)聯(lián)方法  serializeJsonPretty
 */
size_t measureJsonPretty(const JsonDocument& doc);

經(jīng)測(cè)試: 本例中的json長(zhǎng)度 263

5. measureJsonPretty —— 計(jì)算構(gòu)造序列化格式化json的長(zhǎng)度

/**
 * 計(jì)算構(gòu)造序列化格式化json的長(zhǎng)度
 * @param doc jsondocument對(duì)象
 * @Note 關(guān)聯(lián)方法  serializeJsonPretty
 */
size_t measureJsonPretty(const JsonDocument& doc);

經(jīng)測(cè)試: 美化后的長(zhǎng)度: 428

四. JsonObject相關(guān)函數(shù)

在JsonDocument所構(gòu)造出來的內(nèi)存空間中，Json對(duì)象的入口就是JsonObject又跛。

1. containsKey —— 判斷對(duì)象是否包含某一個(gè)key

bool hasCity = root.containsKey("city"); // true

2. createNestedArray —— 在當(dāng)前對(duì)象中添加子key碍拆，子value為json數(shù)組

StaticJsonDocument<256> doc;
JsonObject root = doc.to<JsonObject>();
root["status"] = "on";
JsonArray levels = root.createNestedArray("levels");
levels.add(10);
levels.add(30);
serializeJsonPretty(root, Serial);

結(jié)果:

{
  "status": "on",
  "levels": [
    10,
    20
  ]
}

3. createNestedObject —— 在當(dāng)前對(duì)象中添加子key，子value為json對(duì)象

StaticJsonDocument<256> doc;
JsonObject root = doc.to<JsonObject>();
root["city"] = "Paris";
JsonObject weather = root.createNestedObject("weather");
weather["temp"] = 14.2;
weather["cond"] = "cloudy";
serializeJsonPretty(root, Serial);

4. getMember —— 獲取key對(duì)應(yīng)的value (僅限JsonObject類型)

/**
 * 獲取key對(duì)應(yīng)的value
 * @param key 對(duì)應(yīng)的key
 * @param JsonVariant key對(duì)應(yīng)的value慨蓝，如果不匹配返回null
 */
JsonVariant getMember(const char* key);
JsonVariant getMember(String key);
JsonVariant getMember(std::string key);
JsonVariant getMember(const __FlashStringHelper* key);

5. getOrCreateMember —— 獲取或者創(chuàng)建key對(duì)應(yīng)的value(僅限JsonObject類型)

/**
 * 獲取或者創(chuàng)建key對(duì)應(yīng)的value
 * @param key 對(duì)應(yīng)的key
 * @param JsonVariant key對(duì)應(yīng)的value感混，如果不匹配返回null
 */
JsonVariant getOrCreateMember(const char* key);
JsonVariant getOrCreateMember(String key);
JsonVariant getOrCreateMember(std::string key);
JsonVariant getOrCreateMember(const __FlashStringHelper* key);

如果JsonDocument包含一個(gè)對(duì)象，那么getOrCreateMember方法會(huì)獲取指定key的值礼烈，如果對(duì)象不存在該key弧满，這個(gè)方法會(huì)往對(duì)象添加一個(gè)新的key-value鍵值對(duì)；
如果JsonDocument是空此熬，那么getOrCreateMember方法將創(chuàng)建一個(gè)對(duì)象給到JsonDocument庭呜；
如果屬于以上兩種情況之外的，此方法無效犀忱；

五. JsonArray相關(guān)函數(shù)

1. add —— 往JsonArray中添加元素 (僅限JsonArray類型)

StaticJsonDocument<200> doc;
array.add("hello"); // null -> ["hello"]
array.add(3.14156); // ["hello"] -> ["hello",3.14156]
serializeJson(doc, Serial);

如果JsonDocument頂節(jié)點(diǎn)是一個(gè)JsonArray募谎，add方法會(huì)追加一個(gè)value到數(shù)組；
如果JsonDocument頂節(jié)點(diǎn)是一個(gè)JsonObject阴汇，add無效数冬；
如果JsonDocument是一個(gè)空對(duì)象，add方法會(huì)把JsonDocument變成一個(gè)包含一個(gè)元素的數(shù)組搀庶，這是一個(gè)創(chuàng)建數(shù)組的方式拐纱；

2. createNestedArray —— 添加json數(shù)組

StaticJsonDocument<200> doc;
JsonArray array = doc.to<JsonArray>();
array.add("hello");
JsonArray nested = array.createNestedArray();
nested.add("world");
serializeJson(array, Serial);

結(jié)果

["hello",["world"]]

3. createNestedObject —— 添加json對(duì)象

StaticJsonDocument<200> doc;
JsonArray array = doc.to<JsonArray>();
JsonObject nested = array.createNestedObject();
nested["hello"] = "world";
serializeJson(array, Serial);

結(jié)果

[{"hello":"world"}]

4. getElement —— 獲取index位置的元素(僅限JsonArray類型)

/**
 * 獲取index位置/key的元素
 * @param index 索引位置
 * @return JsonVariant 如果找不到匹配的返回null
 */
JsonVariant getElement(size_t index);

5. getOrAddElement —— 獲取或者創(chuàng)建index對(duì)應(yīng)的value(僅限JsonArray類型)

同上

六. 關(guān)于操作符

對(duì)象都可以用經(jīng)典的get/set方式操作,也可以用函數(shù)操作

//get   以下兩行代碼效果等同
JsonVariant value = object["key"];
JsonVariant value = object.getMember("key");

//set  以下兩行代碼效果等同
object["key"] = "value";
object.getOrCreateMember("key").set("value");

StaticJsonDocument<256> doc;
JsonObject object = doc.to<JsonObject>();
object["hello"] = "world";
const char* world = object["hello"];

七. 編碼JSON字符串示例:

#include <ArduinoJson.h>

void setup() {
  Serial.begin(115200);
  // 200 是大小 如果這個(gè)Json對(duì)象更加復(fù)雜铜异，那么就需要根據(jù)需要去增加這個(gè)值.
  StaticJsonDocument<200> doc;

  // StaticJsonDocument 在棧區(qū)分配內(nèi)存   它也可以被 DynamicJsonDocument（內(nèi)存在堆區(qū)分配） 代替
  // DynamicJsonDocument  doc(200);

  //添加鍵值對(duì)
  doc["sensor"] = "gps";
  doc["time"] = 1351824120;

  // 添加數(shù)組.
  JsonArray data = doc.createNestedArray("data");
  data.add(48.756080);
  data.add(2.302038);

//串口打印結(jié)果
  serializeJson(doc, Serial);
}

void loop() {
}

八. 解碼Json字符串示例:

#include <Arduino.h>
#include "ArduinoJson.h"

String jsonStr = "{\"results\":[{\"location\":{\"id\":\"WW7MBNP039PE\",\"name\":\"泰安\",\"country\":\"CN\",\"path\":\"泰安,泰安,山東,中國(guó)\",\"timezone\":\"Asia/Shanghai\",\"timezone_offset\":\"+08:00\"},\"now\":{\"text\":\"晴\",\"code\":\"0\",\"temperature\":\"28\"},\"last_update\":\"2020-09-09T10:09:00+08:00\"}]}";
DynamicJsonDocument doc(512);

void setup()
{
  Serial.begin(115200);
  delay(3000);
}
void loop()
{
  //解析JSON字符串
  Serial.println("從jsonStr解碼成的DynamicJsonDocument對(duì)象doc:");
  deserializeJson(doc, jsonStr);
  serializeJson(doc, Serial);
  Serial.println("從doc對(duì)象轉(zhuǎn)換成的JsonObject類型對(duì)象root:");
  JsonObject root = doc.as<JsonObject>();
  serializeJson(root, Serial);
  Serial.println();
  Serial.println(doc.memoryUsage());
  Serial.println(measureJson(doc));
  Serial.println(measureJsonPretty(doc));
  Serial.println("root里有一個(gè)子JsonArray對(duì)象 results:");
  JsonArray results = root["results"];
  serializeJson(results, Serial);
  Serial.println();
  //JsonArray類型的數(shù)組results里面只有一個(gè)元素: JsonObject對(duì)象results[0],
  //該元素有三個(gè)子對(duì)象 location, now, last_update
  //location
  Serial.println("JsonObject對(duì)象 results[0]中的子JsonObject對(duì)象location:");
  JsonObject location = results[0]["location"];
  serializeJson(location, Serial);
  Serial.println();
  Serial.println("從JsonObject對(duì)象location中取出id");
  const char *id = location["id"];
  Serial.println(id);
  Serial.println("從JsonObject對(duì)象location中取出name");
  const char *name = location["name"];
  Serial.println(name);
  Serial.println("從JsonObject對(duì)象location中取出country");
  const char *country = location["country"];
  Serial.println(country);
  Serial.println("從JsonObject對(duì)象location中取出path");
  const char *path = location["path"];
  Serial.println(path);
  Serial.println("從JsonObject對(duì)象location中取出timezone");
  const char *timezone = location["timezone"];
  Serial.println(timezone);
  Serial.println("從JsonObject對(duì)象location中取出timezone_offset");
  const char *timezone_offset = location["timezone_offset"];
  Serial.println(timezone_offset);
  //now
  Serial.println("JsonObject對(duì)象 results[0]中的子JsonObject對(duì)象now(為了避免和timer中的now重名,把它叫做now1):");
  JsonObject now1 = results[0]["now"];
  serializeJson(now1, Serial);
  Serial.println("從JsonObject對(duì)象now1中取出text");
  const char *text = now1["text"];
  Serial.println(text);
  Serial.println("從JsonObject對(duì)象now1中取出code");
  const char *code = now1["code"];
  Serial.println(code);
  Serial.println("從JsonObject對(duì)象now1中取出temperature");
  const char *temperature = now1["temperature"];
  Serial.println(temperature);
  //last_update
  const char *last_update = results[0].getMember("last_update");
  Serial.println("last_update:");
  Serial.println(last_update);
  Serial.println();
  delay(10000);
}

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者

人面猴
序言：七十年代末，一起剝皮案震驚了整個(gè)濱河市秸架，隨后出現(xiàn)的幾起案子揍庄，更是在濱河造成了極大的恐慌，老刑警劉巖东抹，帶你破解...
沈念sama閱讀 212,542評(píng)論 6贊 493
死咒
序言：濱河連續(xù)發(fā)生了三起死亡事件蚂子，死亡現(xiàn)場(chǎng)離奇詭異，居然都是意外死亡缭黔，警方通過查閱死者的電腦和手機(jī)缆镣，發(fā)現(xiàn)死者居然都...
沈念sama閱讀 90,596評(píng)論 3贊 385
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進(jìn)店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來试浙，“玉大人，你說我怎么就攤上這事寞蚌√锇停” “怎么了？”我有些...
開封第一講書人閱讀 158,021評(píng)論 0贊 348
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵挟秤，是天一觀的道長(zhǎng)壹哺。經(jīng)常有香客問我，道長(zhǎng)艘刚，這世上最難降的妖魔是什么管宵？我笑而不...
開封第一講書人閱讀 56,682評(píng)論 1贊 284
?港島之戀（遺憾婚禮）
正文為了忘掉前任，我火速辦了婚禮攀甚，結(jié)果婚禮上箩朴，老公的妹妹穿的比我還像新娘。我一直安慰自己秋度，他們只是感情好炸庞，可當(dāng)我...
茶點(diǎn)故事閱讀 65,792評(píng)論 6贊 386
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布。她就那樣靜靜地躺著荚斯，像睡著了一般埠居。火紅的嫁衣襯著肌膚如雪。梳的紋絲不亂的頭發(fā)上事期，一...
開封第一講書人閱讀 49,985評(píng)論 1贊 291
城市分裂傳說
那天滥壕，我揣著相機(jī)與錄音，去河邊找鬼兽泣。笑死绎橘，一個(gè)胖子當(dāng)著我的面吹牛，可吹牛的內(nèi)容都是我干的撞叨。我是一名探鬼主播金踪，決...
沈念sama閱讀 39,107評(píng)論 3贊 410
雙鴛鴦連環(huán)套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼浊洞，長(zhǎng)吁一口氣：“原來是場(chǎng)噩夢(mèng)啊……” “哼！你這毒婦竟也來了胡岔？” 一聲冷哼從身側(cè)響起法希，我...
開封第一講書人閱讀 37,845評(píng)論 0贊 268
萬榮殺人案實(shí)錄
序言：老撾萬榮一對(duì)情侶失蹤，失蹤者是張志新（化名）和其女友劉穎靶瘸，沒想到半個(gè)月后苫亦，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
沈念sama閱讀 44,299評(píng)論 1贊 303
?護(hù)林員之死
正文獨(dú)居荒郊野嶺守林人離奇死亡怨咪，尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛以下內(nèi)容為張勛視角年9月15日...
茶點(diǎn)故事閱讀 36,612評(píng)論 2贊 327
?白月光啟示錄
正文我和宋清朗相戀三年屋剑，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片诗眨。...
茶點(diǎn)故事閱讀 38,747評(píng)論 1贊 341
活死人
序言：一個(gè)原本活蹦亂跳的男人離奇死亡唉匾，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出匠楚，到底是詐尸還是另有隱情巍膘，我是刑警寧澤，帶...
沈念sama閱讀 34,441評(píng)論 4贊 333
?日本核電站爆炸內(nèi)幕
正文年R本政府宣布芋簿，位于F島的核電站峡懈，受9級(jí)特大地震影響，放射性物質(zhì)發(fā)生泄漏与斤。R本人自食惡果不足惜肪康，卻給世界環(huán)境...
茶點(diǎn)故事閱讀 40,072評(píng)論 3贊 317
男人毒藥：我在死后第九天來索命
文/蒙蒙一、第九天我趴在偏房一處隱蔽的房頂上張望撩穿。院中可真熱鬧磷支，春花似錦、人聲如沸冗锁。這莊子的主人今日做“春日...
開封第一講書人閱讀 30,828評(píng)論 0贊 21
一樁弒父案，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽冻河。三九已至箍邮，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間叨叙，已是汗流浹背锭弊。一陣腳步聲響...
開封第一講書人閱讀 32,069評(píng)論 1贊 267
情欲美人皮
我被黑心中介騙來泰國(guó)打工，沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留擂错，地道東北人味滞。一個(gè)月前我還...
沈念sama閱讀 46,545評(píng)論 2贊 362
代替公主和親
正文我出身青樓，卻偏偏與公主長(zhǎng)得像，于是被迫代替她去往敵國(guó)和親剑鞍。傳聞我的和親對(duì)象是個(gè)殘疾皇子昨凡，可洞房花燭夜當(dāng)晚...
茶點(diǎn)故事閱讀 43,658評(píng)論 2贊 350