Qt 5.14.2 深度解析：打造高效JSON处理利器

Qt 5.14.2 深度解析：打造高效JSON处理利器

---

参考资料

• Qt官方文档：QJsonDocument
• Qt官方文档：QJsonObject
• Qt官方文档：QJsonArray
• Qt官方文档：QJsonValue

引言

在当今的软件开发世界中，JSON（JavaScript Object Notation）已经成为了数据交换的标准格式。Qt，作为一个跨平台的C++框架，自然也提供了强大的JSON处理能力。本文将带你深入Qt 5.14.2版本，探索如何利用其内置的JSON处理功能，打造一个高效、健壮的JSON处理系统。

一、JSON基础

JSON是一种轻量级的数据交换格式，易于人阅读和编写，同时也易于机器解析和生成。它基于JavaScript的一个子集，但独立于语言，几乎所有的现代编程语言都提供了JSON解析和生成的支持。

二、Qt中的JSON处理

在Qt 5.14.2中，我们可以直接使用QJsonDocument、QJsonObject、QJsonArray和QJsonValue等类来处理JSON数据。这些类提供了从字符串到JSON对象的解析，以及从JSON对象到字符串的序列化功能。

三、核心类解析

1. QJsonDocument：用于表示整个JSON文档。它可以是对象（QJsonObject）或数组（QJsonArray）。

2. QJsonObject：表示JSON对象，即键值对的集合。它可以直接转换为QVariantMap。

3. QJsonArray：表示JSON数组，即值的有序集合。它可以转换为QVariantList。

4. QJsonValue：表示JSON中的一个值，它可以是字符串、数字、布尔值、数组、对象或null。

四、实战演练：构建JSON

让我们通过一个简单的例子来构建一个JSON对象：

QJsonObject jsonObj;
jsonObj.insert("name", "Qt");
jsonObj.insert("version", "5.14.2");

QJsonDocument doc;
doc.setObject(jsonObj);

QByteArray byteArray = doc.toJson(QJsonDocument::Compact);
QString jsonString = QString::fromUtf8(byteArray);
1
2
3
4
5
6
7
8
9

五、实战演练：解析JSON

解析JSON的过程与构建相反，我们需要从字符串中提取出JSON对象，并进行操作：

QJsonParseError error;
QJsonDocument doc = QJsonDocument::fromJson(byteArray, &error);

if (!doc.isNull() && error.error == QJsonParseError::NoError) {
    QJsonObject obj = doc.object();
    QString name = obj.value("name").toString();
    QString version = obj.value("version").toString();
    // 使用解析出的数据
}
1
2
3
4
5
6
7
8
9

六、高级应用：处理复杂JSON

处理复杂的JSON结构，如嵌套的对象和数组，需要递归地解析和构建。以下是一个包含嵌套对象和数组的JSON示例：

QJsonObject companyObj;
companyObj.insert("name", "Qt Company");
companyObj.insert("website", "https://www.qt.io");

QJsonArray versionsArray;
versionsArray.append("5.8");
versionsArray.append("5.9");
versionsArray.append("5.10");

QJsonObject rootObj;
rootObj.insert("company", QJsonValue(companyObj));
rootObj.insert("versions", QJsonValue(versionsArray));

// 序列化和反序列化过程与前面示例相同
1
2
3
4
5
6
7
8
9
10
11
12
13
14

七、错误处理

在解析JSON时，我们需要特别注意错误处理。QJsonParseError类提供了错误类型和位置信息，帮助我们定位问题。

八、JsonHandler 工具类的封装及测试

#include <QCoreApplication>
#include <QFile>
#include <QIODevice>
#include <QJsonDocument>
#include <QJsonObject>
#include <QJsonArray>
#include <QMap>
#include <QList>
#include <QString>
#include <QTextStream>
#include <QDebug>

class JsonHandler {
public:
    JsonHandler() : root() {}

    // 加载JSON文件
    bool load(const QString &fileName) {
        QFile file(fileName);
        if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
            qWarning() << "Failed to open file for reading:" << qPrintable(file.errorString());
            return false;
        }
        QJsonParseError parseError;
        QJsonDocument doc = QJsonDocument::fromJson(file.readAll(), &parseError);
        if (doc.error() != QJsonDocument::NoError) {
            qWarning() << "JSON parsing error at offset" << parseError.offset << ":" << qPrintable(parseError.errorString());
            return false;
        }
        root = doc.object();
        return true;
    }

    // 保存JSON到文件
    bool save(const QString &fileName) const {
        QFile file(fileName);
        if (!file.open(QIODevice::WriteOnly | QIODevice::Text)) {
            qWarning() << "Failed to open file for writing:" << qPrintable(file.errorString());
            return false;
        }
        QJsonDocument doc(root);
        QTextStream stream(&file);
        stream << doc.toJson(QJsonDocument::Indented);
        file.close(); // Ensure the file is properly closed
        return true;
    }

    // 获取JSON对象的值
    template <typename T>
    T getValue(const QString &key, const T &defaultValue = T()) const {
        QJsonValue value = root.value(key)
;
        if (value.isUndefined()) {
            return defaultValue;
        }
        if (value.isString() && typeid(T) == typeid(QString)) {
            return value.toString();
        } else if (value.isDouble() && typeid(T) == typeid(double)) {
            return value.toDouble();
        } else if (value.isBool() && typeid(T) == typeid(bool)) {
            return value.toBool();
        } else if (value.isInteger() && typeid(T) == typeid(int)) {
            return value.toInt();
        }
        qWarning() << "Value type mismatch for key" << key;
        return defaultValue;
    }

    // 获取JSON数组的元素
    template <typename T>
    QList<T> getArrayValues(const QString &key) const {
        QJsonArray array = root.value(key).toArray();
        QList<T> list;
        for (const QJsonValue &value : array) {
            if (value.isString() && typeid(T) == typeid(QString)) {
                list.append(value.toString());
            } else if (value.isDouble() && typeid(T) == typeid(double)) {
                list.append(value.toDouble());
            } else if (value.isBool() && typeid(T) == typeid(bool)) {
                list.append(value.toBool());
            } else if (value.isInteger() && typeid(T) == typeid(int)) {
                list.append(value.toInt());
            }
        }
        return list;
    }

    // 设置JSON值
    template <typename T>
    void setValue(const QString &key, const T &value) {
        if (typeid(T) == typeid(QString)) {
            root.insert(key, value.toString());
        } else if (typeid(T) == typeid(double)) {
            root.insert(key, value.toDouble());
        } else if (typeid(T) == typeid(bool)) {
            root.insert(key, value.toBool());
        } else if (typeid(T) == typeid(int)) {
            root.insert(key, value.toInt());
        } else if (typeid(T) == typeid(QJsonValue)) {
            root.insert(key, value);
        } else {
            qWarning() << "Unsupported value type for key" << key;
        }
    }

    // 删除JSON键
    bool remove(const QString &key) {
        if (root.contains(key)) {
            root.remove(key)
;
            return true;
        }
        return false;
    }

    // 将JSON对象转换为QMap<QString, QJsonValue>
    QMap<QString, QJsonValue> jsonObjectToMap() const {
        QMap<QString, QJsonValue> map;
        for (auto it = root.begin(); it != root.end(); ++it) {
            map.insert(it.key(), it.value());
        }
        return map;
    }


private:
    QJsonObject root;
};

#include <QDebug>

int main(int argc, char *argv[]) {
    QCoreApplication app(argc, argv);

    JsonHandler jsonHandler;
    QString jsonFileName = "example.json";

    // 加载JSON文件
    if (jsonHandler.load(jsonFileName)) {
        // 示例：获取不同类型的值
        QString stringValue = jsonHandler.getValue<QString>("stringKey");
        double doubleValue = jsonHandler.getValue<double>("doubleKey");
        bool boolValue = jsonHandler.getValue<bool>("boolKey");
        int intValue = jsonHandler.getValue<int>("intKey");

        // 修改JSON数据
        jsonHandler.setValue("newKey", "newValue");
        jsonHandler.setValue("doubleKey", 3.14);
        jsonHandler.setValue("boolKey", true);
        jsonHandler.setValue("intKey", 42);

        // 保存修改后的JSON文件
        if (jsonHandler.save(jsonFileName)) {
            qDebug() << "JSON file saved successfully.";
        } else {
            qDebug() << "Failed to save JSON file.";
        }
    } else {
        qDebug() << "Failed to load JSON file.";
    }

    return 0;
}
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

九、总结

JSON处理是现代软件开发中不可或缺的一部分。Qt 5.14.2为我们提供了强大的支持，让我们可以轻松地在C++项目中处理JSON数据。希望本文能够帮助你更好地理解和使用Qt的JSON处理功能。如果你有任何问题或想要深入讨论，欢迎在评论区留言，让我们一起探索Qt的无限可能！