【Qt筆記】使用 QJson 處理 JSON

XML 曾經是各類應用的配置和傳輸的首選方式。可是如今 XML 遇到了一個強勁的對手：JSON。咱們能夠在這裏看到有關 JSON 的語法。整體來講，JSON 的數據比 XML 更緊湊，在傳輸效率上也要優於 XML。不過 JSON 數據的層次化表達不及 XML，至少不如 XML 那樣突出。不過這並不會阻止 JSON 的普遍應用。

 

一個典型的 JSON 文檔能夠像下面的例子：

{
  "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 內容：

#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. 建立 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對象。例如：

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之間的轉換。例如咱們有下面的類：

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 序列化：

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);

以及：

QJson::Parser parser;
QVariant variant = parser.parse(json);
Person person;
QObjectHelper::qvariant2qobject(variant.toMap(), &person);