【QT 读取JSON】深入浅出使用QT内置的QJson模块解析Json文件匠心之作

news2024/11/29 9:50:10

🙋‍♂️ 作者：海码007
📜 专栏：QT专栏
💥 标题：【QT 读取JSON】使用QT内置的QJson模块解析Json文件
❣️ 寄语：人生的意义或许可以发挥自己全部的潜力，所以加油吧！
🎈 最后：文章作者技术和水平有限，如果文中出现错误，希望大家能指正

0 引言

在项目开发过程中，经常会遇到读写Json文件的需求，掌握Json文件的操作是基础中的基础。

1 Json数据分析

要读取的Json数据格式如下：

[
        {
            "name":"ggr",
            "info":
                {
                    "age":21,
                    "height":174
                }
        },
        {
            "name":"lbw",
            "info":
                {
                    "age":21,
                    "height":174
                }
        }
]

接下来以QJson模块的角度，来解析这个Json数据

整个文件数据可以转换为 QJsonDocument 类型，其中有 “[ ]” 方括号、 "{ }“花括号、” : "冒号。

被 “[ ]” 方括号包围的数据是QJsonArray数组类型。
被 "{ }"花括号包围的数据是QJsonObject对象类型。
" : "冒号两侧的分别是Key和Value（key : value），冒号左右有空格不影响数据读取。

先了解四个重要的类型

QJsonDocument类型，指的是整个Json数据。
QJsonArray数组类型的元素是QJsonValue类型。
QJsonObject类型的元素是键值对，也就是 Key: Value 类型。Key 是字符串类型，Value 的类型是 QJsonValue。
QJsonValue类型可以转换成 QJsonObject 类型、int型、double型、QString类型、QJsonArray类型等基础数据类型。

总结：QJsonDocument 可以转换为 QJsonArray 或QJsonObjec t类型。然后 QJsonArray 中的元素和 QJsonObject 中键值对的值的类型都是 QJsonValue 类型。QJsonValue 类型可以转换成QJsonArray、QJsonObject、int、double、QString、bool等类型。（相当于闭环了，设计的非常巧妙）

2 解析Json数据

首先添加一些头文件

#include <QFile>				// 用于打开文件
#include <QJsonParseError>		// 返回错误信息
#include <QJsonArray>			// Json数据对象
#include <QJsonDocument>		// Json文档对象
#include <QJsonObject>			// 普通Json对象
#include <QDebug>				// 打印数据

新建一个函数解析Json数据

bool ReadJson::praseJsonFile(const QString &sJsonPathFn)
{
    //---------------------------------------------------------------------------------------------
    //1.读取磁盘中的文件
    QFile file( sJsonPathFn );
    if (!file.open(QIODevice::ReadOnly)) return false;

    QJsonParseError result;
    QJsonDocument   root_Doc = QJsonDocument::fromJson(file.readAll(), &result);    // 将文件数据格式化为JsonDocument对象
    if( result.error != QJsonParseError::NoError ) return false;                    // 数据格式错误就返回
    //---------------------------------------------------------------------------------------------

    QJsonArray roots = root_Doc.array();   // 将JsonDocument对象转换为QJsonArray类型

    //---------------------------------------------------------------------------------------------
    //2.遍历QJsonArray数组
    for (int i=0; i<roots.size(); i++)
    {
        QJsonObject root = roots.at(i).toObject();

        // 读取name和info的值
        QString     name    = root.value("name").toString();
        QJsonObject info    = root.value("info").toObject();

        // 读取info对象中age和height的值
        int         age     = info.value("age").toInt();
        int         height  = info.value("height").toInt();

        // 打印读取的数据
        qDebug() << "name = " << name;
        qDebug() << "info.age = " << age;
        qDebug() << "info.height = " << height;
    }
    //---------------------------------------------------------------------------------------------

    return true;
}

其实只要掌握关键的函数，就能看懂上面的代码：

readAll()
这是将文本文件读取成 QByteArray 类型的函数
QJsonDocument的fromJson(const QByteArray &json, QJsonParseError *error = Q_NULLPTR)函数
这是将 QByteArray 类型的字符数组转换成 QJsonDocument 类型的函数。
QJsonDocument 有两个函数，分别是 object() 和 array() 函数，它们可以将自己转换成 QJsonArray 类型或者 QJsonObject 类型
使用 object() 还是 array() 函数就看Json数据最开头的是 方括号 还是 花括号 ，本文数据是方括号开头，所以使用的是 array() 函数。
QJsonArray 的 at(int index) 函数，用于访问数组索引等于 index 的元素。
QJsonObject 的 value(const QString &key) 函数，用于读取花括号中的键值对的值。根据key的值，读取value的值。
该函数返回的是 QJsonValue 类型
QJsonValue 中的 toObject、toString、toInt、toDouble、toBool、toArray 函数用于将 QJsonValue 装换为 QJsonObject、QString、int、double、bool、QJsonArray 类型