Qt 學習之路 2（63）：使用 QJson 處理 JSON
XML 曾經是各種應用的配置和傳輸的首選方式。但是現在 XML 遇到了一個強勁的對手：JSON。我們可以在這里看到有關 JSON 的語法。總體來說，JSON 的數據比 XML 更緊湊，在傳輸效率上也要優於 XML。不過 JSON 數據的層次化表達不及 XML，至少不如 XML 那樣突出。不過這並不會阻止 JSON 的廣泛應用。
一個典型的 JSON 文檔可以像下面的例子：
|
1
2
3
4
5
6
7
8
9
|
{
"encoding" : "UTF-8",
"plug-ins" : [
"python",
"c++",
"ruby"
],
"indent" : { "length" : 3, "use_space" : true }
}
|
JSON 的全稱是 JavaScript Object Notation，與 JavaScript 密不可分。熟悉 JavaScript 的童鞋馬上就會發現，JSON 的語法就是 JavaScript 對象聲明的語法。JSON 文檔其實就是一個 JavaScript 對象，因而也稱為 JSON 對象，以大括號作為起止符，其實質是不排序的鍵值對，其中鍵要求是 string 類型，值可以是任意類型。比如上面的示例，鍵 encoding 的值是字符串 UTF-8；鍵 plug-ins 的值是一個數組類型，在 JSON 中，數組以中括號表示，這個數組是一個字符串列表，分別有 python、c++ 和 ruby 三個對象；鍵 indent 的值是一個對象，這個對象有兩個屬性，length = 3，use_space = true。
對於 JSON 的解析，我們可以使用 QJson 這個第三方庫。QJson 可以將 JSON 數據轉換為 QVariant 對象，將 JSON 數組轉換成 QVariantList 對象，將 JSON 對象轉換成 QVariantMap 對象。我們在這里使用 git clone 出 QJson 的整個代碼。注意 QJson 沒有提供鏈接庫的 pro 文件，因此我們只需要將所有源代碼文件添加到我們的項目即可（如同這些文件是我們自己寫的一樣）。接下來就可以使用 QJson 讀取 JSON 內容：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
#include "parser.h"
//////////
QJson::Parser parser;
bool ok;
QString json("{"
"\"encoding\" : \"UTF-8\","
"\"plug-ins\" : ["
"\"python\","
"\"c++\","
"\"ruby\""
"],"
"\"indent\" : { \"length\" : 3, \"use_space\" : true }"
"}");
QVariantMap result = parser.parse(json.toUtf8(), &ok).toMap();
if (!ok) {
qFatal("An error occurred during parsing");
exit (1);
}
qDebug() << "encoding:" << result["encoding"].toString();
qDebug() << "plugins:";
foreach (QVariant plugin, result["plug-ins"].toList()) {
qDebug() << "\t-" << plugin.toString();
}
QVariantMap nestedMap = result["indent"].toMap();
qDebug() << "length:" << nestedMap["length"].toInt();
qDebug() << "use_space:" << nestedMap["use_space"].toBool();
|
將 JSON 對象轉換成QVariant對象很簡單，基本只需要下面幾行：
|
1
2
3
4
5
6
|
// 1. 創建 QJson::Parser 對象
QJson::Parser parser;
bool ok;
// 2. 將 JSON 對象保存在一個對象 json 中，進行數據轉換
QVariant result = parser.parse (json, &ok);
|
QJson::Parser::parse()函數接受兩個參數，第一個參數是 JSON 對象，可以是QIODevice *或者是QByteArray；第二個參數是轉換成功與否，如果成功則被設置為 true。函數返回轉換后的QVariant對象。注意我們轉換后的對象其實是一個QVariantMap類型，可以像QMap一樣使用重載的 [] 獲取鍵所對應的值。另外，由於 result[“plug-ins”] 是一個QVariantList對象（因為是由 JSON 數組返回的），因而可以調用其toList()函數，通過遍歷輸出每一個值。
如果需要將QVariant生成 JSON 對象，我們則使用QJson::Serializer對象。例如：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
QVariantList people;
QVariantMap bob;
bob.insert("Name", "Bob");
bob.insert("Phonenumber", 123);
QVariantMap alice;
alice.insert("Name", "Alice");
alice.insert("Phonenumber", 321);
people << bob << alice;
QJson::Serializer serializer;
bool ok;
QByteArray json = serializer.serialize(people, &ok);
if (ok) {
qDebug() << json;
} else {
qCritical() << "Something went wrong:" << serializer.errorMessage();
}
|
QJson::Serializer和前面的QJson::Parser的用法相似，只需要調用QJson::Serializer::serialize()即可將QVariant類型的數據轉換為 JSON 格式。其返回值是QByteArray類型，可以用於很多其它場合。
上面是 QJson 的主要使用方法。其實 QJson 還提供了另外一個類QObjectHelper，用於QVariant和QObject之間的轉換。注意我們上面所說的 QJson 的轉換需要的是QVariant類型的數據，無論是轉換到 JSON 還是從 JSON 轉換而來。但是通常我們在應用程序中使用的是QObject及其子類。QObjectHelper提供了一個工具函數，完成QVariant和QObject之間的轉換。例如我們有下面的類：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
class Person : public QObject
{
Q_OBJECT
Q_PROPERTY(QString name READ name WRITE setName)
Q_PROPERTY(int phoneNumber READ phoneNumber WRITE setPhoneNumber)
Q_PROPERTY(Gender gender READ gender WRITE setGender)
Q_PROPERTY(QDate brithday READ brithday WRITE setBrithday)
Q_ENUMS(Gender)
public:
Person(QObject* parent = 0);
~Person();
QString name() const;
void setName(const QString& name);
int phoneNumber() const;
void setPhoneNumber(const int phoneNumber);
enum Gender {Male, Female};
void setGender(Gender gender);
Gender gender() const;
QDate brithday() const;
void setBrithday(const QDate& dob);
private:
QString m_name;
int m_phoneNumber;
Gender m_gender;
QDate m_dob;
};
|
那么，我們可以使用下面的代碼將Person類進行 JSON 序列化：
|
1
2
3
4
5
6
7
8
9
|
Person person;
person.setName("Flavio");
person.setPhoneNumber(123456);
person.setGender(Person::Male);
person.setDob(QDate(1982, 7, 12));
QVariantMap variant = QObjectHelper::qobject2qvariant(&person);
QJson::Serializer serializer;
qDebug() << serializer.serialize( variant);
|
以及：
|
1
2
3
4
|
QJson::Parser parser;
QVariant variant = parser.parse(json);
Person person;
QObjectHelper::qvariant2qobject(variant.toMap(), &person);
|
進行反序列化。