【库函数】Qt中Json的操作

2023-09-13 16:06:00

参考博客:

之前介绍了许多 C++ 的 Json 第三方库,

下面介绍一下 Json 在 Qt 中的使用。

从Qt 5.0开始提供了对 Json 的支持,我们可以直接使用Qt提供的 Json 类进行数据的组织和解析。相关的类常用的主要有四个,具体如下:

Json类介绍
QJsonDocument它封装了一个完整的JSON文档,并且可以从UTF-8编码的基于文本的表示以及Qt自己的二进制格式读取和写入该文档。
QJsonArrayJSON数组是一个值列表。可以通过从数组中插入和删除QJsonValue来操作该列表。
QJsonObjectJSON对象是键值对的列表,其中键是唯一的字符串,值由QJsonValue表示。
QJsonValue该类封装了JSON支持的数据类型。

一、QJsonValue

在Qt中 QJsonValue 可以封装的基础数据类型有六种(和Json支持的类型一致),分别为:

  • 布尔类型:QJsonValue::Bool
  • 浮点类型(包括整形):QJsonValue::Double
  • 字符串类型: QJsonValue::String
  • Json数组类型: QJsonValue::Array
  • Json对象类型:QJsonValue::Object
  • 空值类型: QJsonValue::Null

这个类型可以通过 QJsonValue 的构造函数被封装为一个类对象:

// Json对象
QJsonValue(const QJsonObject &o);
// Json数组
QJsonValue(const QJsonArray &a);
// 字符串
QJsonValue(const char *s);
QJsonValue(QLatin1String s);
QJsonValue(const QString &s);
// 整形 and 浮点型
QJsonValue(qint64 v);
QJsonValue(int v);
QJsonValue(double v);
// 布尔类型
QJsonValue(bool b);
// 空值类型
QJsonValue(QJsonValue::Type type = Null);

如果我们得到一个 QJsonValue 对象,如何判断内部封装的到底是什么类型的数据呢?这时候就需要调用相关的判断函数了,具体如下:

// 是否是Json数组
bool isArray() const;
// 是否是Json对象
bool isObject() const;
// 是否是布尔类型
bool isBool() const;
// 是否是浮点类型(整形也是通过该函数判断)
bool isDouble() const;
// 是否是空值类型
bool isNull() const;
// 是否是字符串类型
bool isString() const;
// 是否是未定义类型(无法识别的类型)
bool isUndefined() const;

通过判断函数得到对象内部数据的实际类型之后,如果有需求就可以再次将其转换为对应的基础数据类型,对应的API函数如下:

// 转换为Json数组
QJsonArray toArray(const QJsonArray &defaultValue) const;
QJsonArray toArray() const;
// 转换为布尔类型
bool toBool(bool defaultValue = false) const;
// 转换为浮点类型
double toDouble(double defaultValue = 0) const;
// 转换为整形
int toInt(int defaultValue = 0) const;
// 转换为Json对象
QJsonObject toObject(const QJsonObject &defaultValue) const;
QJsonObject toObject() const;
// 转换为字符串类型
QString toString() const;
QString toString(const QString &defaultValue) const;

二、QJsonObject

QJsonObject 封装了Json中的对象,在里边可以存储多个键值对,为了方便操作,键值为字符串类型,值为QJsonValue 类型。

关于这个类的使用类似于C++中的STL类,仔细阅读API文档即可熟练上手使用,下面介绍一些常用API函数:

  • 如何创建空的Json对象

    QJsonObject::QJsonObject();	// 构造空对象
  • 将键值对添加到空对象中

    iterator QJsonObject::insert(const QString &key, const QJsonValue &value);
  • 获取对象中键值对个数

    int QJsonObject::count() const;
    int QJsonObject::size() const;
    int QJsonObject::length() const;
  • 通过key得到value

    QJsonValue QJsonObject::value(const QString &key) const;    // utf8
    QJsonValue QJsonObject::value(QLatin1String key) const;	    // 字符串不支持中文
    QJsonValue QJsonObject::operator[](const QString &key) const;
    QJsonValue QJsonObject::operator[](QLatin1String key) const;
  • 删除键值对

    void QJsonObject::remove(const QString &key);
    QJsonValue QJsonObject::take(const QString &key);	// 返回key对应的value值
  • 通过key进行查找

    iterator QJsonObject::find(const QString &key);
    bool QJsonObject::contains(const QString &key) const;
  • 遍历,方式有三种:

    • 使用相关的迭代器函数

    • 使用 [] 的方式遍历, 类似于遍历数组, []中是键值

    • 先得到对象中所有的键值, 在遍历键值列表, 通过key得到value值

      QStringList QJsonObject::keys() const;

三、QJsonArray

QJsonArray 封装了Json中的数组,在里边可以存储多个元素,为了方便操作,所有的元素类统一为 QJsonValue 类型。关于这个类的使用类似于C++中的STL类,仔细阅读API文档即可熟练上手使用,下面介绍一些常用API函数:

  • 创建空的Json数组

    QJsonArray::QJsonArray();
  • 添加数据

    void QJsonArray::append(const QJsonValue &value);	// 在尾部追加
    void QJsonArray::insert(int i, const QJsonValue &value); // 插入到 i 的位置之前
    iterator QJsonArray::insert(iterator before, const QJsonValue &value);
    void QJsonArray::prepend(const QJsonValue &value); // 添加到数组头部
    void QJsonArray::push_back(const QJsonValue &value); // 添加到尾部
    void QJsonArray::push_front(const QJsonValue &value); // 添加到头部
  • 计算数组元素的个数

    int QJsonArray::count() const;
    int QJsonArray::size() const;
  • 从数组中取出某一个元素的值

    QJsonValue QJsonArray::at(int i) const;
    QJsonValue QJsonArray::first() const; // 头部元素
    QJsonValue QJsonArray::last() const; // 尾部元素
    QJsonValueRef QJsonArray::operator[](int i);
  • 删除数组中的某一个元素

    iterator QJsonArray::erase(iterator it);    // 基于迭代器删除
    void QJsonArray::pop_back();           // 删除尾部
    void QJsonArray::pop_front();          // 删除头部
    void QJsonArray::removeAt(int i);      // 删除i位置的元素
    void QJsonArray::removeFirst();        // 删除头部
    void QJsonArray::removeLast();         // 删除尾部
    QJsonValue QJsonArray::takeAt(int i);  // 删除i位置的原始, 并返回删除的元素的值
  • Json 数组的遍历,常用的方式有两种:

    • 可以使用迭代器进行遍历(和使用迭代器遍历STL容器一样)
    • 可以使用数组的方式遍历

四、QJsonDocument

它封装了一个完整的JSON文档,并且可以从 \(UTF-8\) 编码的基于文本的表示以及Qt自己的二进制格式读取和写入该文档。

QJsonObjectQJsonArray 这两个对象中的数据是不能直接转换为字符串类型的,如果要进行数据传输或者数据的持久化,操作的都是字符串类型而不是 QJsonObject 或者 QJsonArray 类型,我们需要通过一个Json文档类进行二者之间的转换。

下面依次介绍一下这两个转换流程应该如何操作:

  • QJsonObject 或者 QJsonArray ===> 字符串

    1. 创建 QJsonDocument 对象

      QJsonDocument::QJsonDocument(const QJsonObject &object);
      QJsonDocument::QJsonDocument(const QJsonArray &array);

      可以看出,通过构造函数就可以将实例化之后的 **QJsonObject 或者 QJsonArray **转换为QJsonDocument 对象了。

    2. 将文件对象中的数据进行序列化

      // 二进制格式的json字符串
      QByteArray QJsonDocument::toBinaryData() const;	 
      // 文本格式
      QByteArray QJsonDocument::toJson(JsonFormat format = Indented) const;

      通过调用 toxxx() 方法就可以得到文本格式或者二进制格式的 Json 字符串了。

    3. 使用得到的字符串进行数据传输, 或者磁盘文件持久化

  • 字符串 ===> QJsonObject 或者 QJsonArray

    一般情况下,通过网络通信或者读磁盘文件就会得到一个Json格式的字符串,如果想要得到相关的原始数据就需要对字符串中的数据进行解析,具体解析流程如下:

    1. 将得到的 Json 格式字符串通过 QJsonDocument 类的静态函数转换为 QJsonDocument 类对象

      [static] QJsonDocument QJsonDocument::fromBinaryData(const QByteArray &data, DataValidation validation = Validate);
      // 参数文件格式的json字符串
      [static] QJsonDocument QJsonDocument::fromJson(const QByteArray &json, QJsonParseError *error = Q_NULLPTR);
    2. 将文档对象转换为json数组/对象

      // 判断文档对象中存储的数据是不是数组
      bool QJsonDocument::isArray() const;
      // 判断文档对象中存储的数据是不是json对象
      bool QJsonDocument::isObject() const
          
      // 文档对象中的数据转换为json对象
      QJsonObject QJsonDocument::object() const;
      // 文档对象中的数据转换为json数组
      QJsonArray QJsonDocument::array() const;
    3. 通过调用QJsonArray , QJsonObject 类提供的 API 读出存储在对象中的数据。

    关于Qt中Json数据对象以及字符串之间的转换的操作流程是固定的,我们在编码过程中只需要按照上述模板处理即可,相关的操作是没有太多的技术含量可言的。

五、Example

5.1 Write to File

void writeJson()
{
    QJsonObject obj;
    obj.insert("Name", "Ace");
    obj.insert("Sex", "man");
    obj.insert("Age", 20);

    QJsonObject subObj;
    subObj.insert("Father", "Gol·D·Roger");
    subObj.insert("Mother", "Portgas·D·Rouge");
    QJsonArray array;
    array.append("Sabo");
    array.append("Monkey D. Luffy");
    subObj.insert("Brother", array);
    obj.insert("Family", subObj);
    obj.insert("IsAlive", false);
    obj.insert("Comment", "yyds");

    QJsonDocument doc(obj);
    QByteArray json = doc.toJson();

    QFile file("d:\\ace.json");
    file.open(QFile::WriteOnly);
    file.write(json);
    file.close();
}

5.2 Read from File

void MainWindow::readJson()
{
    QFile file("d:\\ace.json");
    file.open(QFile::ReadOnly);
    QByteArray json = file.readAll();
    file.close();

    QJsonDocument doc = QJsonDocument::fromJson(json);
    if(doc.isObject())
    {
        QJsonObject obj = doc.object();
        QStringList keys = obj.keys();
        for(int i=0; i<keys.size(); ++i)
        {
            QString key = keys.at(i);
            QJsonValue value = obj.value(key);
            if(value.isBool())
            {
                qDebug() << key << ":" << value.toBool();
            }
            if(value.isString())
            {
                qDebug() << key << ":" << value.toString();
            }
            if(value.isDouble())
            {
                qDebug() << key << ":" << value.toInt();
            }
            if(value.isObject())
            {
                qDebug()<< key << ":";
                // 直接处理内部键值对, 不再进行类型判断的演示
                QJsonObject subObj = value.toObject();
                QStringList ls = subObj.keys();
                for(int i=0; i<ls.size(); ++i)
                {
                    QJsonValue subVal = subObj.value(ls.at(i));
                    if(subVal.isString())
                    {
                        qDebug() << "   " << ls.at(i) << ":" << subVal.toString();
                    }
                    if(subVal.isArray())
                    {
                        QJsonArray array = subVal.toArray();
                        qDebug() << "   " << ls.at(i) << ":";
                        for(int j=0; j<array.size(); ++j)
                        {
                            // 因为知道数组内部全部为字符串, 不再对元素类型进行判断
                            qDebug() << "       " << array[j].toString();
                        }
                    }
                }
            }
        }
    }
}

一般情况下,对于Json字符串的解析函数都是有针对性的,因为需求不同设计的Json格式就会有所不同,所以不要试图写出一个通用的Json解析函数,这样只会使函数变得臃肿而且不易于维护,每个Json格式对应一个相应的解析函数即可。

上面的例子中为了给大家演示Qt中Json类相关API函数的使用将解析步骤写的复杂了,因为在解析的时候我们是知道Json对象中的所有key值的,可以直接通过key值将对应的value值取出来,因此上面程序中的一些判断和循环其实是可以省去的。

更多推荐

【C++ 程序设计】实战:C++ 实践练习题(11~20)

目录11.循环计数、变量赋值、递增运算12.递归序列13.遍历输出结构体数组中每个元素的姓名和年龄14.指向整型变量的指针和一个整数作为参数15.从键盘读取字符,并执行操作,打印字符结果16.找出三位数中全部的水仙花数17.输入数字返回英文单词18.分科输入学生成绩计算总分、平均分19.创建一个5x5的二维数组,并按照

STM32 OLED屏幕显示详解

目录1.OLED介绍2.OLED如何显示一个点?内存管理​编辑​编辑页地址模式水平地址模式​编辑垂直地址模式​编辑3.OLED显示图片用到的库函数:向OLED写命令的封装:显示图片代码示例:1.OLED介绍OLED是有机发光管(OrganicLight-EmittingDiode)的缩写,是一种新兴的平面显示屏技术。与

PSP - 蛋白质序列提取 Transformer 蛋白质语言模型 ESM2 特征

欢迎关注我的CSDN:https://spike.blog.csdn.net/本文地址:https://spike.blog.csdn.net/article/details/132888139蛋白质语言模型ESM(EvolutionaryScaleModeling)是一种利用深度学习技术来预测蛋白质结构和功能的方法。

pixel2的root过程

用adb连接手机首先学会用adb连接手机可以配置在主机Windows和虚拟机上手机打开设置,连续点击版本号进入开发者模式点击进入开发者选项,允许USB调试,连接在电脑上,在手机授权对话框中允许电脑调试连接完成后,输入adbdevices查看一下进行刷机先解锁oem输入上述命令上述图片已经解锁了oem锁没有解锁的话输入f

【跟晓月学shell脚本】掌握shell脚本变量原理及概念

前言跟晓月一起学shell,死磕shell脚本,让shell脚本学习不再难。想学习更多shell脚本的案例,可以前往我的师父的shell脚本专栏:shell脚本从入门到实战-案例篇文章目录前言一.什么是变量?二.变量分类2.1按照变量的作用分2.2按照变量的作用域分三.变量的定义与查看3.1环境变量3.2特殊变量3.3

(三十一)大数据实战——一键式DolphinScheduler高可用工作流任务调度系统部署安装

前言DolphinScheduler(DolphinScheduler)是一个分布式、易扩展的开源DAG(有向无环图)工作流任务调度系统,可用于构建大规模数据处理、数据仓库、ETL等复杂的数据处理和数据分析场景。DolphinScheduler支持多种任务类型,包括Shell、SQL、Spark、Python、Sub-

一文讲解Linux内核中的设计模式

在软件开发中,设计模式是一种被广泛应用的解决问题的方法。设计模式可以帮助开发人员有效地解决软件设计中的问题,提高软件的可维护性和可扩展性,同时也能提高代码的可读性和可重用性。而在Linux内核的开发中,设计模式也扮演了重要的角色。Linux内核作为一个开源操作系统内核,其内部架构复杂,代码庞大,设计模式在其中的应用也十

02-yaml资源文件

1、创建pod的基础文件创建pod的yaml文件详解---apiVersion:extensions/v1beta1#当前格式的版本kind:Deployment#当前创建资源的类型,当前类型是Deploymentmetadata:#当前资源的元数据name:test-os#当前资源的名字是元数据必须的项spec:#是

如何搭建游戏平台?

搭建游戏平台是一个复杂的任务,涉及多个方面的工作。下面是一些关键步骤和注意事项,以帮助您搭建游戏平台:平台开发:开发游戏平台的关键部分,包括网站或应用程序的开发、数据库设计、用户界面设计、游戏上传和管理工具。选择游戏类型:决定您的平台将提供哪种类型的游戏。这可以包括手机游戏、在线游戏、桌面游戏等。游戏内容和开发者合作:

友元和优化

目录友元函数:友元函数不能用const修饰友元函数可以在类定义的任意位置声明:友元类内部类(了解)匿名对象:​编辑编译器优化:优化场景1优化场景2:无法优化的场景:优化场景3优化场景4:友元函数:友元函数不能用const修饰原因:友元函数并不是类的成员函数,类的成员函数中有this指针,this指针才需要被const修

正规股票配资网站的三个明显特点分析

随着股票市场的快速发展,越来越多的投资者开始考虑使用股票配资来增加自己的资金流动性和收益率。然而,在选择股票配资网站时,投资者往往难以辨别哪些网站是正规的,哪些网站存在风险。因此,以下将分析正规股票配资网站的三个明显特点。第一个特点是资质和证照齐全。正规股票配资网站需要具备相关的资质和证照。例如,需要有基金从业人员资格

热文推荐