json在qt中怎么用

JSON在Qt中的使用：从基础到实践

在跨平台应用程序开发中,数据交换格式的选择至关重要，JSON（JavaScript Object Notation）以其轻量级、易读易写的特性，成为前后端数据交互的主流格式之一，Qt作为成熟的跨平台C++框架，对JSON提供了完善的支持，无论是简单的键值对存储，还是复杂的数据结构嵌套，都能通过Qt的JSON模块高效处理，本文将详细介绍JSON在Qt中的使用方法，从核心类到实战应用，帮助开发者快速Qt与JSON的交互技巧。

Qt JSON模块核心类概览

Qt的JSON模块（QtJson模块，需在.pro文件中添加QT += core）提供了几个核心类，用于JSON数据的解析、生成和操作，分别是：

• QJsonDocument：JSON文档的容器，用于表示整个JSON数据（可以是对象或数组），并提供与JSON格式转换的方法（如转字符串、从字符串解析）。
• QJsonObject：JSON对象，类似于C++中的map或字典，存储键值对（键为字符串，值可以是JSON支持的任意类型）。
• QJsonArray：JSON数组，类似于C++中的list或向量，存储有序的值集合（值类型同样灵活）。
• QJsonValue：JSON值的通用类型，可以表示null、布尔值、整数、浮点数、字符串、对象、数组等7种基本JSON类型。
• QJsonParseError：用于解析JSON时的错误处理，返回解析过程中的错误信息（如格式错误、语法错误等）。

JSON数据生成：从Qt对象到JSON字符串

在实际开发中,常需要将程序中的数据（如自定义类的对象、配置信息等）转换为JSON字符串，以便存储或传输，以下是生成JSON数据的常用方法。

使用QJsonObject/QJsonArray构建JSON

示例1：构建简单的JSON对象

假设要生成如下JSON对象：

{
    "name": "张三",
    "age": 25,
    "isStudent": false,
    "scores": [90, 85, 92]
}

实现代码：

#include <QJsonObject>
#include <QJsonArray>
#include <QJsonDocument>
#include <QDebug>
int main() {
    // 创建JSON对象
    QJsonObject personObj;
    personObj["name"] = "张三";          // 字符串类型
    personObj["age"] = 25;               // 整数类型（自动转为QJsonValue）
    personObj["isStudent"] = false;      // 布尔类型
    // 创建JSON数组并添加到对象
    QJsonArray scoresArray;
    scoresArray.append(90);
    scoresArray.append(85);
    scoresArray.append(92);
    personObj["scores"] = scoresArray;
    // 将QJsonObject转换为QJsonDocument
    QJsonDocument doc(personObj);
    // 转换为JSON字符串（紧凑格式，无多余空格）
    QByteArray jsonString = doc.toJson(QJsonDocument::Compact);
    qDebug() << "生成的JSON字符串:" << jsonString;
    return 0;
}

输出：

生成的JSON字符串: {"name":"张三","age":25,"isStudent":false,"scores":[90,85,92]}

示例2：构建嵌套的JSON结构

对于更复杂的嵌套JSON（如包含对象和数组的组合），只需逐层构建即可：

{
    "id": 1001,
    "info": {
        "gender": "男",
        "address": "北京市朝阳区"
    },
    "courses": [
        {"name": "数学", "credit": 4},
        {"name": "物理", "credit": 3}
    ]
}

实现代码：

QJsonObject outerObj;
outerObj["id"] = 1001;
// 嵌套对象：info
QJsonObject infoObj;
infoObj["gender"] = "男";
infoObj["address"] = "北京市朝阳区";
outerObj["info"] = infoObj;
// 嵌套数组：courses
QJsonArray coursesArray;
QJsonArray course1;
course1.append("数学");
course1.append(4);
QJsonArray course2;
course2.append("物理");
course2.append(3);
coursesArray.append(QJsonObject::fromVariantMap(course1.toVariantList().toMap())); // 更推荐用QJsonObject直接构造
coursesArray.append(QJsonObject{{"name", "物理"}, {"credit", 3}}); // C++11初始化列表
outerObj["courses"] = coursesArray;
QJsonDocument doc(outerObj);
qDebug() << "嵌套JSON:" << doc.toJson(QJsonDocument::Indented); // Indented格式化输出

输出（格式化后）：

{
    "id": 1001,
    "info": {
        "gender": "男",
        "address": "北京市朝阳区"
    },
    "courses": [
        {"name": "数学", "credit": 4},
        {"name": "物理", "credit": 3}
    ]
}

自定义类对象转JSON

实际开发中,常需将自定义类的对象转换为JSON，可通过以下两种方式实现：

• 方法1：手动提取对象属性到JSON（适用于简单类，属性较少时）
• 方法2：通过QJsonObject的构造函数或fromVariantMap结合Qt的元对象系统（适用于复杂类，需结合Q_GADGET或Q_OBJECT宏）

示例3：自定义类转JSON（手动方式）

定义一个Student类，并实现其转JSON的方法：

#include <QString>
#include <QJsonObject>
class Student {
public:
    Student(const QString& name, int age, const QList<int>& scores)
        : m_name(name), m_age(age), m_scores(scores) {}
    // 手动转换为QJsonObject
    QJsonObject toJson() const {
        QJsonObject obj;
        obj["name"] = m_name;
        obj["age"] = m_age;
        QJsonArray scoresArray;
        for (int score : m_scores) {
            scoresArray.append(score);
        }
        obj["scores"] = scoresArray;
        return obj;
    }
private:
    QString m_name;
    int m_age;
    QList<int> m_scores;
};
// 使用示例
int main() {
    Student student("李四", 20, {88, 92, 76});
    QJsonDocument doc(student.toJson());
    qDebug() << "Student JSON:" << doc.toJson();
    return 0;
}

示例4：自定义类转JSON（结合Q_GADGET）

对于更复杂的类,可使用Q_GADGET宏（无需Q_OBJECT，避免信号槽开销），通过QJsonObject::fromVariantMap和QVariant转换实现自动序列化：

#include <QJsonObject>
#include <QVariantMap>
#include <QDebug>
// 使用Q_GADGET标记为可序列化的对象
class Teacher : public QObject { // 需继承QObject才能使用Q_PROPERTY
    Q_OBJECT
    Q_PROPERTY(QString name READ name WRITE setName)
    Q_PROPERTY(int age READ age WRITE setAge)
    Q_PROPERTY(QString subject READ subject WRITE setSubject)
public:
    Teacher(const QString& name, int age, const QString& subject)
        : m_name(name), m_age(age), m_subject(subject) {}
    // Getter方法（必须与Q_PROPERTY对应）
    QString name() const { return m_name; }
    int age() const { return m_age; }
    QString subject() const { return m_subject; }
    // 转换为QVariantMap（Qt的反射机制会自动读取Q_PROPERTY）
    QVariantMap toVariantMap() const {
        QVariantMap map;
        map["name"] = m_name;
        map["age"] = m_age;
        map["subject"] = m_subject;
        return map;
    }
private:
    QString m_name;
    int m_age;
    QString m_subject;
};
// 使用示例
int main() {
    Teacher teacher("王老师", 35, "C++编程");
    // 通过QVariantMap转QJsonObject
    QJsonObject teacherObj = QJsonObject::fromVariantMap(teacher.toVariantMap());
    QJsonDocument doc(teacherObj);
    qDebug() << "Teacher JSON:" << doc.toJson(QJsonDocument::Indented);
    return 0;
}

输出：

{
    "name": "王老师",
    "age": 35,
    "subject": "C++编程"
}

JSON数据解析：从JSON字符串到Qt对象

解析JSON字符串是Qt中JSON操作的另一核心场景,通常用于从网络请求、配置文件等来源读取数据并转换为Qt对象。

基本解析流程

解析JSON的步骤如下：

1. 使用QJsonDocument::fromJson()将JSON字符串转换为QJsonDocument对象；
2. 通过QJsonDocument::isObject()或isArray()判断JSON类型；
3. 从QJsonDocument中提取QJsonObject或QJsonArray；