Qt之JSON生成與解析

一、JSON概述

JSON（ JavaScript Object Notation，對象表示法） 是一種輕量級的數據交換格式。 它基於 ECMAScript 的一個子集。許多編程語言都很容易找到J SON 解析器和 JSON 庫。 JSON 文本格式在語法上與創建 JavaScript 對象的代碼相同。不同語言的不同 json 庫對 JSON 標准的支持不盡相同，為了能讓盡可能多的 JSON 庫都能正常解析和生成 JSON ，定義 JSON 的規范很重要，推薦一個 JSON 規范《Google - JSON風格指南》。

二、常用的JSON庫

在json.org 中介紹了 JSON 在各種語言中的應用，在 C/C++ 中比較常用的 JSON 庫主要有以下幾個：

• nlohmann：是一個用於解析 JSON 的開源 C++ 庫，口碑一流，使用非常方便直觀，是很多 C++ 程序員的首選。

• RapidJSON：騰訊員工開源的一個以高性能著稱的 JSON 庫，用的人也很多，缺點就是接口比較難用，不太友好。

• cJSON：是一個超輕巧，攜帶方便，只有兩個文件 cJSON.h 和 cJSON.cpp，簡單的可以作為 ANSI-C 標准的 JSON 解析器，缺點是容易造成內存泄漏，也不支持線程安全。

• QJson：是一個基於 Qt4 的開發包用來將 JSON 數據解析成 QVariant 對象，JSON 的數組將被映射為QVariantList 實例，而其他對象映射為 QVariantMap 實例，適合用在 Qt 開發平台上。

• json-c、JsonCpp等。

這里只簡單講解下 Qt 中對 JSON 的生成與解析，Qt5 以前的版本，可以使用 QJson 庫，需要單獨下載、編譯，才能使用。到了 Qt5，提供了專門的 QJsonDocument 及其相關類來讀和寫 JSON 文檔。

三、JSON 常用類

首先，JSON 的解析和構建都要包含如下頭文件，下面一個個介紹下：

#include <QJsonDocument>
#include <QJsonArray>
#include <QJsonObject>

3.1 QJsonDocument

QJsonDocument 類用於讀和寫 JSON 文檔。

一個 JSON 文檔可以使用 QJsonDocument::fromJson() 從基於文本的表示轉化為 QJsonDocument， toJson(JsonFormat format = Indented) 則可以反向轉化為文本，其中，format主要有兩種格式，一種是人們可讀的格式，一種是緊湊的格式。

已解析文檔的有效性，可以使用 !isNull() 進行查詢。

如果要查詢一個 JSON 文檔是否包含一個數組或一個對象，使用 isArray() 和 isObject()。包含在文檔中的數組或對象可以使用 array() 或 object() 檢索，然后讀取或操作。

也可以使用 fromBinaryData() 或 fromRawData() 從存儲的二進制表示創建來 JSON 文檔。

3.2 QJsonArray

QJsonArray 類封裝了一個 JSON 數組。

JSON 數組是值的列表。列表可以被操作，通過從數組中插入和刪除 QJsonValue 。

一個 QJsonArray 可以和一個 QVariantList 相互轉換。可以使用 size() 來查詢條目的數量，通過 insert() 在指定索引處插入值，removeAt() 來刪除指定索引的值。

3.3 QJsonObject

QJsonObject 類封裝了一個 JSON 對象。

一個 JSON 對象是一個 “key/value” 列表，key 是獨一無二的字符串，value 由一個 QJsonValue 表示。

一個 QJsonObject 可以和一個 QVariantMap 相互轉換。可以使用 size() 來查詢“key/value 對”的數量，通過 insert() 插入“key/value 對”， remove() 刪除指定的 key。

3.4 QJsonValue

QJsonValue 類封裝了一個值。JSON 中的值有 6 種基本數據類型：

• bool（QJsonValue::Bool）
• double（QJsonValue::Double）
• string（QJsonValue::String）
• array（QJsonValue::Array）
• object（QJsonValue::Object）
• null（QJsonValue::Null）

一個值可以由任何上述數據類型表示。此外，QJsonValue 有一個特殊的標記來表示未定義的值，可以使用 isUndefined() 查詢。

值的類型可以通過 type() 或 isBool()、isString() 等訪問函數查詢。同樣地，值可以通過 toBool()、toString() 等函數轉化成相應的存儲類型。

3.5 QJsonParseError

QJsonParseError 類用於在 JSON 解析中報告錯誤。

枚舉 QJsonParseError::ParseError：該枚舉描述 JSON 文檔在解析過程中所發生的錯誤類型。

四、JSON 對象的構建與解析

一個簡單的 JSON 對象：

{
    "Cross Platform": true,
    "From": 1991,
    "Name": "Qt"
}

構建比較簡單，由於是一個對象，只需要用 QJsonObject 即可：

// 構建 JSON 對象
QJsonObject jsonObj;
jsonObj.insert("Name", "Qt");
jsonObj.insert("From", 1991);
jsonObj.insert("Cross Platform", true);
 
// 構建 JSON 文檔
QJsonDocument document;
document.setObject(jsonObj);
QByteArray byteArray = document.toJson(QJsonDocument::Compact);
QString strJson(byteArray);
 
qDebug() << strJson;

解析如下：

QJsonParseError jsonError;
QJsonDocument doucment = QJsonDocument::fromJson(byteArray, &jsonError);  // 轉化為 JSON 文檔
if (!doucment.isNull() && (jsonError.error == QJsonParseError::NoError)) {  // 解析未發生錯誤
    if (doucment.isObject()) { // JSON 文檔為對象
        QJsonObject object = doucment.object();  // 轉化為對象
        if (object.contains("Name")) {  // 包含指定的 key
            QJsonValue value = object.value("Name");  // 獲取指定 key 對應的 value
            if (value.isString()) {  // 判斷 value 是否為字符串
                QString strName = value.toString();  // 將 value 轉化為字符串
                qDebug() << "Name : " << strName;
            }
        }
        if (object.contains("From")) {
            QJsonValue value = object.value("From");
            if (value.isDouble()) {
                int nFrom = value.toVariant().toInt();
                qDebug() << "From : " << nFrom;
            }
        }
        if (object.contains("Cross Platform")) {
            QJsonValue value = object.value("Cross Platform");
            if (value.isBool()) {
                bool bCrossPlatform = value.toBool();
                qDebug() << "CrossPlatform : " << bCrossPlatform;
            }
        }
    }
}

注意：在轉化為 QJsonDocument 后，首先需要根據 QJsonParseError 的值判定是否轉化成功，然后在進行相應的轉化解析。

五、JSON 數組的構建與解析

一個簡單的 JSON 數組：

[
    "Qt",
    5.7,
    true
]

生成比較簡單，由於是一個數組，只需要用 QJsonArray 即可：

// 構建 JSON 數組
QJsonArray json;
json.append("Qt");
json.append(5.7);
json.append(true);
 
// 構建 JSON 文檔
QJsonDocument document;
document.setArray(json);
QByteArray byteArray = document.toJson(QJsonDocument::Compact);
QString strJson(byteArray);
 
qDebug() << strJson;

需要注意的是，和上面不同的是，這里使用的是 QJsonDocument 的 setArray() 函數，因為是數組嘛！解析如下：

QJsonParseError jsonError;
QJsonDocument doucment = QJsonDocument::fromJson(byteArray, &jsonError);  // 轉化為 JSON 文檔
if (!doucment.isNull() && (jsonError.error == QJsonParseError::NoError)) { // 解析未發生錯誤
    if (doucment.isArray()) { // JSON 文檔為數組
        QJsonArray array = doucment.array();  // 轉化為數組
        int nSize = array.size();  // 獲取數組大小
        for (int i = 0; i < nSize; ++i) {  // 遍歷數組
            QJsonValue value = array.at(i);
            if (value.type() == QJsonValue::String) {
                QString strName = value.toString();
                qDebug() << strName;
            }
            if (value.type() == QJsonValue::Double) {
                double dVersion = value.toDouble();
                qDebug() << dVersion;
            }
            if (value.type() == QJsonValue::Bool) {
                bool bCrossPlatform  = value.toBool();
                qDebug() << bCrossPlatform;
            }
        }
    }
}

和 JSON 對象類似，在遍歷數組時，獲取每個 value，首先需要判斷 value 的類型（和 is***() 函數類似，這里根據 type() 函數返回的枚舉值來判斷），然后再進行相應的轉換。

復雜的JSON的構建與解析

構造一個復雜的 JSON 對象：

{
    "Company": "Digia",
    "From": 1991,
    "Name": "Qt",
    "Page": {
        "Developers": "https://www.qt.io/developers/",
        "Download": "https://www.qt.io/download/",
        "Home": "https://www.qt.io/"
    },
    "Version": [
        4.8,
        5.2,
        5.7
    ]
}

包含了一個擁有五個 “key/value” 的對象，values 中的兩個（Company、Name）是字符串，一個（From）是數字，一個（Page）是對象，一個（Version）是數組。

要生成這樣一個復雜的 JSON 文檔，需要分別構造對象和數組，然后將它們拼接起來：

// 構建 Json 數組 - Version
QJsonArray versionArray;
versionArray.append(4.8);
versionArray.append(5.2);
versionArray.append(5.7);
 
// 構建 Json 對象 - Page
QJsonObject pageObject;
pageObject.insert("Home", "https://www.qt.io/");
pageObject.insert("Download", "https://www.qt.io/download/");
pageObject.insert("Developers", "https://www.qt.io/developers/");
 
// 構建 Json 對象
QJsonObject json;
json.insert("Name", "Qt");
json.insert("Company", "Digia");
json.insert("From", 1991);
json.insert("Version", QJsonValue(versionArray));
json.insert("Page", QJsonValue(pageObject));
 
// 構建 Json 文檔
QJsonDocument document;
document.setObject(json);
QByteArray byteArray = document.toJson(QJsonDocument::Compact);
QString strJson(byteArray);
 
qDebug() << strJson;

解析部分其實並沒有看起來這么復雜，只要一步步搞明白對應的類型，然后進行相應轉化即可。

QJsonParseError jsonError;
QJsonDocument doucment = QJsonDocument::fromJson(byteArray, &jsonError);  // 轉化為 JSON 文檔
if (!doucment.isNull() && (jsonError.error == QJsonParseError::NoError)) {  // 解析未發生錯誤
    if (doucment.isObject()) {  // JSON 文檔為對象
        QJsonObject object = doucment.object();  // 轉化為對象
        if (object.contains("Name")) {
            QJsonValue value = object.value("Name");
            if (value.isString()) {
                QString strName = value.toString();
                qDebug() << "Name : " << strName;
            }
        }
        if (object.contains("Company")) {
            QJsonValue value = object.value("Company");
            if (value.isString()) {
                QString strCompany = value.toString();
                qDebug() << "Company : " << strCompany;
            }
        }
        if (object.contains("From")) {
            QJsonValue value = object.value("From");
            if (value.isDouble()) {
                int nFrom = value.toVariant().toInt();
                qDebug() << "From : " << nFrom;
            }
        }
        if (object.contains("Version")) {
            QJsonValue value = object.value("Version");
            if (value.isArray()) {  // Version 的 value 是數組
                QJsonArray array = value.toArray();
                int nSize = array.size();
                for (int i = 0; i < nSize; ++i) {
                    QJsonValue value = array.at(i);
                    if (value.isDouble()) {
                        double dVersion = value.toDouble();
                        qDebug() << "Version : " << dVersion;
                    }
                }
            }
        }
        if (object.contains("Page")) {
            QJsonValue value = object.value("Page");
            if (value.isObject()) {  // Page 的 value 是對象
                QJsonObject obj = value.toObject();
                if (obj.contains("Home")) {
                    QJsonValue value = obj.value("Home");
                    if (value.isString()) {
                        QString strHome = value.toString();
                        qDebug() << "Home : " << strHome;
                    }
                }
                if (obj.contains("Download")) {
                    QJsonValue value = obj.value("Download");
                    if (value.isString()) {
                        QString strDownload = value.toString();
                        qDebug() << "Download : " << strDownload;
                    }
                }
                if (obj.contains("Developers")) {
                    QJsonValue value = obj.value("Developers");
                    if (value.isString()) {
                        QString strDevelopers = value.toString();
                        qDebug() << "Developers : " << strDevelopers;
                    }
                }
            }
        }
    }
}

基本的用法就這些，比較簡單，細節很關鍵，建議在處理的過程中啟用嚴格模式，例如：先通過 QJsonParseError::NoError 判斷轉化 JSON 文檔無誤，再進行解析。在解析過程中，先判斷 QJsonValue 是否為對應的類型如 isObject()，再通過 toObject() 轉化。

參考：

Qt之JSON生成與解析