【Qt专栏】Qt中Json的使用教程

拉伊卜

已于 2023-03-12 18:39:13 修改

阅读量1.5w

点赞数 30

分类专栏： Qt 文章标签： qt json 开发语言

于 2022-10-27 00:17:35 首次发布

本文链接：https://blog.csdn.net/weixin_43729127/article/details/127522889

版权

Qt 专栏收录该内容

16 篇文章 28 订阅

订阅专栏

1，测试读写的 test.json 文件内容（文件路径 E:\test.json）

2，所需要的头文件

3，写 Json 文件接口实现

4，读 Json 文件接口实现

前言

从 Qt 5.0 就开始提供处理 Json 数据的操作支持，JSON是一种对源自Javascript的对象数据进行编码的格式，但现在广泛用作互联网上的数据交换格式，Qt中的JSON支持提供了一个易于使用的C++ API来解析，修改和保存JSON数据。

Qt中所有的 JSON 类都是基于值的隐式共享类（隐式共享类的意思是只要它没有被修改，它就与创建它的文档共享数据）。常用的相关类为如下表格的前四个：

Json 类	介绍
QJsonDocument	它封装了一个完整的 JSON 文档，可以从基于UTF-8编码的文本表示和Qt自己的二进制格式来对该文档进行读写操作。
QJsonArray	JSON 数组是一个值的列表。可以通过从数组中插入和删除 QJsonValue 来操作该列表。
QJsonObject	JSON 对象是键值对的列表，其中键是唯一的字符串，值由 QJsonValue 表示。
QJsonValue	该类封装了 JSON 支持的数据类型。
QJsonParseError	用于报告 JSON 解析过程中的错误。

一，QJsonDocument

QJsonDocument 是一个封装完整JSON文档的类，可以从基于UTF-8编码的文本表示和Qt自己的二进制格式来对该文档进行读写操作。使用 QJsonDocument::fromJson() 可以将JSON文档从基于文本的表示形式转换为 QJsonDocument，使用 QJsonDocument::toJson() 可以将其转换回文本形式。解析器非常快速和有效，并可以使用 QJsonDocument::toBinaryData() 将 JSON 转换为Qt使用的二进制表示。

因为 QJsonObject 和 QJsonArray 这两个对象中的数据是不能直接转换为字符串类型的，如果要进行数据传输或者数据的持久化保存，需要对数据进行序列化和反序列化操作，详细如下

QJsonObject 或者 QJsonArray 序列化为字符串

1. 创建 QJsonDocument 对象

QJsonDocument::QJsonDocument(const QJsonObject &object);    //个人常用
QJsonDocument::QJsonDocument(const QJsonArray &array);
QJsonDocument::QJsonDocument(const QJsonDocument &other);    //几乎不用

QJsonDocument::QJsonDocument();    //或者创建一个空对象，使用以下两个方法设置数据
QJsonDocument::setArray(const QJsonArray &array);
QJsonDocument::setObject(const QJsonObject &object);

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

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

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

字符串反序列化为 QJsonObject 或者 QJsonArray

1. 将通过网络通信或磁盘文件读取得到的 Json 格式字符串转换为 QJsonDocument 对象

QJsonDocument QJsonDocument::fromJson(const QByteArray &json, QJsonParseError *error = Q_NULLPTR);    //个人常用
QJsonDocument QJsonDocument::fromBinaryData(const QByteArray &data, DataValidation validation = Validate);
QJsonDocument QJsonDocument::fromRawData(const char *data, int size, DataValidation validation = Validate)
QJsonDocument QJsonDocument::fromVariant(const QVariant &variant)

2. 将文档对象转换为 Json 数组或 Json 对象

bool QJsonDocument::isArray() const;    //判断文档对象中存储的数据是不是数组
bool QJsonDocument::isObject() const    //判断文档对象中存储的数据是不是json对象
QJsonObject QJsonDocument::object() const;    //文档对象中的数据转换为json对象
QJsonArray QJsonDocument::array() const;    //文档对象中的数据转换为json数组

3.通过调用 QJsonArray , QJsonObject 类提供的 API 读取存储在 QJsonDocument 对象中的数据

二，QJsonArray

QJsonArray 封装了 Json 中的数组，数组里面的所有元素统一为 QJsonValue 类型。常用API函数如下，详细参照官方文档：

创建一个 Json 数组

QJsonArray::QJsonArray();    //创建一个空数组
QJsonArray::QJsonArray(const QJsonArray &other)    //拷贝构造，不常用
QJsonArray::QJsonArray(std::initializer_list<QJsonValue> args)    //没用过

添加数据

void QJsonArray::append(const QJsonValue &value);        //在数组尾部追加
void QJsonArray::insert(int i, const QJsonValue &value); //将value插入到i的位置
iterator QJsonArray::insert(iterator before, const QJsonValue &value);  //std 知识
void QJsonArray::prepend(const QJsonValue &value);        //将value添加到数组头部
void QJsonArray::push_back(const QJsonValue &value);        //将value添加到数组尾部
void QJsonArray::push_front(const QJsonValue &value);        //将value添加到数组头部

删除数据

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位置的原素, 并返回删除的元素的值

获取数组中元素个数

int QJsonArray::count() const;
int QJsonArray::size() const;

获取数组中的元素值

QJsonValue QJsonArray::at(int i) const;    //获取指定i位置的元素
QJsonValue QJsonArray::first() const;    //头部元素
QJsonValue QJsonArray::last() const;    //尾部元素
QJsonValueRef QJsonArray::operator[](int i);    //注意这获取的是指定i位置的元素引用
QVariantList QJsonArray::toVariantList() const;