Qt中JSON操作的具體使用

Posted on 2022-08-22 by WalkonNet

JSON（JavaScript Object Notation，js對象標記）是一種輕量級的數據交換格式。它基於ECMAScript的一個子集，使用完全獨立於編程語言的文本格式來存儲和表示數據。簡潔和清晰的的層次結構使得JSON成為理想的數據交換語言。易於人閱讀和編寫，同時也易於機器解析和生成，並有效的提升網絡傳輸效率。關於JSON的更多解釋，請參看JSON官網。

在Qt庫中，為JSON的相關操作提供瞭完整的類支持，包括QJsonValue，QJsonObject，QJsonArray，QJsonDocument和QJsonParseError。其中，QJsonValue類表示json格式中的一個值；QJsonObject表示一個json對象；QJsonArray顧名思義表示一個json數組；QJsonDocument主要用來讀寫json文檔；而QJsonParseError是用來表示json解析過程中出現的錯誤的方便類。下面，我們就來看看這些類的詳細信息。

QJsonValue

QJsonValue類封裝瞭一個json格式中的值。該值可以是如下6中基本類型：

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

一個QJsonValue可以表示上面任何一種數據類型。此外，QJsonValue還有一個特殊的標志用來表示未定義的值。可以使用isUndefined()函數來進行判斷。而一個QJsonValue中存儲的類型可以通過type()或isBool()，isString()之類的函數進行查詢。同樣，QJsonValue中存儲的值可以通過toBool()，toString()等函數轉換到具體的類型。

QJsonValue中存儲的值在內部是強類型的，並且和QVariant相反，它不會嘗試進行任何的隱式類型轉換。這意味著將QJsonValue轉換成一個不是它存儲的類型，將返回一個該類型的模型構造函數返回的值。

其實，說到QJsonValue，還有另一個類要說，QJsonValueRef，該類是一個對於QJsonArray和QJsonObject來說的一個幫助類。當你獲得一個QJsonValueRef類的對象後，你可以把它當做一個QJsonValue對象的應用來使用。如果你向他賦值，該值會實際作用到底層的QJsonArray或者QJsonObject對象中的元素上。而要想使用該類，可以使用一下的兩個方法：

QJsonArray::operator[](int i)
QJsonObject::operator[](const QString& key)const;

下面來看一下QJsonValue的構造函數：

QJsonValue(Type type = Null)
QJsonValue(bool b)
QJsonValue(double n)
QJsonValue(int n)
QJsonValue(qint64 n)
QJsonValue(const QString &s)
QJsonValue(QLatin1String s)
QJsonValue(const char *s)
QJsonValue(const QJsonArray &a)
QJsonValue(const QJsonObject &o)
QJsonValue(const QJsonValue &other)

可以看到，該類主要是對基本類型的一個包裝。

QJsonObject

QJsonObject類封裝瞭一個json對象。一個json對象是一個鍵值對的列表，其中key是唯一的字符串，而值就是一個我們上面講到的QJsonValue。一個QJsonObject的對象可以轉換到QVariantMap，要可以由QVariantMap轉換得到。我們可以使用size()函數來查詢一個QJsonObject中存儲的鍵值對的個數；使用insert()和remove()來插入或從中刪除鍵值對；還可以使用標準的C++迭代器來遍歷它。 QJsonObject類是一個隱式共享類。其構造函數如下：

  QJsonObject object
  {
      {"property1", 1},
      {"property2", 2}
  };

我們可以使用初始化列表來快速的構建一個QJsonObject對象。如下：

  QJsonObject object
  {
      {"property1", 1},
      {"property2", 2}
  };

如此之外，比較常用的就是insert（）函數瞭：

iterator QJsonObject::insert(const QString &key, const QJsonValue &value)

一般，我們可以先定義一個空的QJsonObject對象，然後使用該函數向其中插入需要的鍵值對。如果新插入的key已存在，那麼會進行替換。

下面，我們通過一個例子還使用該類構造如下json字符串：{"name":"lily", "age":23, "addr":{"city":"xxx", "province":"yyy"}} 代碼如下：

#include <QCoreApplication>
#include <QDebug>
#include <QJsonObject>
 
int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);
 
    QJsonObject obj;
    obj.insert("name", "lily");
    obj.insert("age", 23);
    QJsonObject addr;
    addr.insert("city", "guangzhou");
    addr.insert("province", "guangdong");
    obj.insert("addr", addr);
    qDebug() << obj;
 
    return a.exec();
}

我們先構建瞭一個QJsonObject對象obj，然後向其中插入姓名和年齡鍵值對；因為地址又是一個QJsonObject，所以我們又構建瞭addr對象，向其中插入城市和省份，最後，將該QJsonObject做為地址鍵值對的值，插入到obj中。打印結果如下：

QJsonArray

顧名思義，QJsonArray封裝瞭一個JSON數組。一個JSON數組是一個值的列表。我們可以向這個列表中插入或刪除QJsonValue。

同時，我們可以把一個QVariantList轉換成一個QJsonArray。也可以使用標準C++迭代器對它進行遍歷。其構造函數如下：

QJsonArray()
QJsonArray(std::initializer_list<QJsonValue> args)
QJsonArray(const QJsonArray &other)

我們也可以像上面那樣，使用一個初始化列表來構建一個QJsonArray對象：

QJsonArray array = { 1, 2.2, QString() };

在此我們隻使用瞭單個的值，沒有使用鍵值對。其實，這樣的json對象，一般我們就稱為數組。

和QJsonObject一樣，我們一般也是通過它的insert()函數來生成我們需要的json數組：

void insert(int i, const QJsonValue &value)
iterator insert(iterator before, const QJsonValue &value)

下面，我們繼續上面的例子，來生成一個表示人物信息的列表。代碼如下：

#include <QCoreApplication>
#include <QDebug>
#include <QJsonObject>
#include <QJsonArray>
 
int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);
 
    QJsonObject obj1;
    obj1.insert("name", "lily");
    obj1.insert("age", 23);
    QJsonObject addr1;
    addr1.insert("city", "guangzhou");
    addr1.insert("province", "guangdong");
    obj1.insert("addr", addr1);
    qDebug() << obj1;
 
    QJsonObject obj2;
    obj2.insert("name", "tom");
    obj2.insert("age", 24);
    QJsonObject addr2;
    addr2.insert("city", "shenzhen");
    addr2.insert("province", "guangdong");
    obj2.insert("addr", addr2);
    qDebug() << obj2;
 
    QJsonObject obj3;
    obj3.insert("name", "jerry");
    obj3.insert("age", 24);
    QJsonObject addr3;
    addr3.insert("city", "foshan");
    addr3.insert("province", "guangdong");
    obj3.insert("addr", addr3);
    qDebug() << obj3;
 
    QJsonArray array;
    array.push_back(obj1);
    array.push_back(obj2);
    array.push_back(obj3);
    qDebug() << array;
 
    return a.exec();
}

在此，我們隻是簡單的構建瞭三個人物的QJsonObject對象，然後將它們放入一個QJsonArray中。輸入結果如下：

QJsonDocument

QJsonDocument類提供瞭讀寫JSON文檔的方法。QJsonDocument類包裝瞭一個完整的JSON 文檔，我們可以以utf-8編碼的文本格式和Qt自己的二進制格式來操作該文檔。一個JSON文檔可以使用QJsonDocument::fromJson()函數轉換json文本字符串來得到。而toJson()可以將其轉換成文本。這個解析器是非常快速和高效的，Qt也是使用它來將JSON對象轉換成其二進制表示的。解析得到的文檔可以使用isNull()來判斷是否有效。還可以使用isArray()和isObject()函數來判斷該文檔所包含的是否是數據或json對象。如果是，可以使用array()或object（）函數還獲得其中的對象或數組。

其構造函數如下：

QJsonDocument()
QJsonDocument(const QJsonObject &object)
QJsonDocument(const QJsonArray &array)
QJsonDocument(const QJsonDocument &other)

除瞭構造函數外，該類還提供瞭兩個轉換函數，可以將json文檔序列化為二進制對象，然後我們就可以將該對象存儲到文件中，或發送到網絡上。

QByteArray toBinaryData() const
QByteArray toJson(JsonFormat format = Indented) const

下面，我們就使用該類將我們上面生成的json數組寫入到文件中：

代碼如下：

#include <QCoreApplication>
#include <QDebug>
#include <QJsonObject>
#include <QJsonArray>
#include <QFile>
#include <QJsonDocument>
 
int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);
 
    QJsonObject obj1;
    obj1.insert("name", "lily");
    obj1.insert("age", 23);
    QJsonObject addr1;
    addr1.insert("city", "guangzhou");
    addr1.insert("province", "guangdong");
    obj1.insert("addr", addr1);
    qDebug() << obj1;
 
    QJsonObject obj2;
    obj2.insert("name", "tom");
    obj2.insert("age", 24);
    QJsonObject addr2;
    addr2.insert("city", "shenzhen");
    addr2.insert("province", "guangdong");
    obj2.insert("addr", addr2);
    qDebug() << obj2;
 
    QJsonObject obj3;
    obj3.insert("name", "jerry");
    obj3.insert("age", 24);
    QJsonObject addr3;
    addr3.insert("city", "foshan");
    addr3.insert("province", "guangdong");
    obj3.insert("addr", addr3);
    qDebug() << obj3;
 
    QJsonArray array;
    array.push_back(obj1);
    array.push_back(obj2);
    array.push_back(obj3);
    qDebug() << array;
 
    QJsonDocument jsonDoc(array);
    QByteArray ba = jsonDoc.toJson();
    QFile file("result.json");
    if(!file.open(QIODevice::WriteOnly))
    {
        qDebug() << "write json file failed";
        return 0;
    }
    file.write(ba);
    file.close();
 
    return a.exec();
}

我們先使用QJsonArray構建出一個QJsonDocument對象，然後調用其toJson()方法，將該json文檔轉換成一個字節數組。註意，toJson（）函數會接受一個格式化參數：

QByteArray QJsonDocument::toJson(JsonFormat format = Indented) const

其中，format主要有兩種格式，一種是人們可讀的格式，一種是緊湊的格式。分別描述如下表：

Constant	Value	Description
QJsonDocument::Indented	0	定義人們可讀的輸出格式，如下： { "Array":[ true, 999, "string" ], "key": "value", "null": null }
QJsonDocument::Compact	1	定義一個緊湊的輸出格式，如下： {"Array": [true, 999, "string"], "key": "value", "null":null}

toJson()函數默認使用Indented，一縮進的形式生成人們可讀的json文件。

運行該程序後，在編譯目錄查看生成的json文件。結果如下：

當然，除瞭將json對象寫入到文件中，QJsonDocument還提供瞭幾個靜態函數，將從文件中讀取出的原始數據或json字符串轉換成一個QJsonDocument對象。函數聲明信息如下：

QJsonDocument fromBinaryData(const QByteArray &data, DataValidation validation = Validate)
QJsonDocument fromJson(const QByteArray &json, QJsonParseError *error = Q_NULLPTR)
QJsonDocument fromRawData(const char *data, int size, DataValidation validation = Validate)
QJsonDocument fromVariant(const QVariant &variant)

下面，我們就使用這些函數，將我們寫入到文件中的json對象再讀出來，並生成一個QJsonDocument對象。

代碼如下：

#include <QCoreApplication>
#include <QDebug>
#include <QFile>
#include <QJsonDocument>
 
int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);
 
    QFile file("result.json");
    if(!file.open(QIODevice::ReadOnly))
    {
        qDebug() << "read json file failed";
        return 0;
    }
    QByteArray ba = file.readAll();
    qDebug() << "讀出的數據如下：";
    qDebug() << ba;
    QJsonParseError e;
    QJsonDocument jsonDoc = QJsonDocument::fromJson(ba, &e);
    if(e.error == QJsonParseError::NoError && !jsonDoc.isNull())
    {
        qDebug() << jsonDoc;
    }
 
    return a.exec();
}

在此，因為我們從文件中讀出的是一個json形式的字符串，所以可以使用fromJson()函數，將其轉換成一個QJsonDocument對象。同時，在調用fromJson()函數時，我們還為它傳入瞭一個QJsonParseError對象，用來接收解析json字符串的過程中，有可能發生的錯誤信息。

代碼運行如下：

到此這篇關於Qt中JSON操作的具體使用的文章就介紹到這瞭,更多相關Qt JSON操作內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

Qt中JSON操作的具體使用

目錄

QJsonValue

QJsonObject

QJsonArray

QJsonDocument

推薦閱讀：

發佈留言取消回覆

近期文章

目錄

QJsonValue

QJsonObject

QJsonArray

QJsonDocument

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆