Qt 之 自定义json配置文件类，QJsonDocument应用

已于 2023-07-21 11:33:00 修改
阅读量698 收藏 1
点赞数 2
分类专栏： Qt进阶之路 文章标签： json qt c++
于 2023-07-21 11:31:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41632571/article/details/131847372
版权

目录

一、前言

二、头文件代码

三、源文件代码

四、使用示例

五、使用效果

一、前言

        Qt的配置类QSettings主要是键值结构的配置，若需要的配置项为树形结构，例如配置学校\学院\班级\学生这样，使用键值结构已经不满足我们的需求了，我们可以使用xml文件或json文件实现树形结构的配置。本文实现自定义的json文件配置类，实现快速的对json文件的增删改查。

        本代码示例对学院\班级\课程的配置，配置的结构有变化可自行修改代码，对json文件的增删改查结构可以通用。

二、头文件代码

jsonConfig.h
#pragma once

#include <QObject>
#include <QDir>
#include <QFile>
#include <QJsonArray>
#include <QJsonObject>
#include <QJsonDocument>
#include <QJsonParseError>
#include <QTextStream>
#include <QVector>

//班级
struct mClass{
    QString ClassName = "";            //班级名
    QVector<QString> CourseName ={};   //课程列表
};
//学院
struct mFaculty {
    QString FacultyName = "";    //学院名
    QVector<mClass> Class = {};  //班级列表
};


class jsonConfig  : public QObject
{
	Q_OBJECT

public:
	~jsonConfig();
	jsonConfig& operator = (const jsonConfig&) = delete;
	static jsonConfig& getInstance(void);

    QJsonObject mStruct2JsonObject(mFaculty);
    mFaculty jsonObject2MStruct(QJsonObject);

    bool find(QString name, mFaculty* out_mStruct = NULL);
    void add(mFaculty);
    void modify(mFaculty);
    void remove(QString facultyName);
    QVector<mFaculty> readAll();

private:
	jsonConfig();
	static jsonConfig* instance;

	QFile *jsonFile;
};

三、源文件代码

jsonConfig.cpp
#include "jsonConfig.h"

jsonConfig* jsonConfig::instance = NULL;

jsonConfig::jsonConfig()
{
    QDir* dir = new QDir();
    if (!dir->exists("./config"))
        dir->mkpath("./config");
    jsonFile = new QFile("./config/jsonConfigFile.json");
    if (!jsonFile->exists()) {
        if (jsonFile->open(QFile::WriteOnly)) {
            QJsonObject obj;
            QJsonArray arr;
            obj.insert("Faculty", arr);
            QJsonDocument doc(obj);
            QByteArray data = doc.toJson();
            jsonFile->write(data);
            jsonFile->close();
        }
    }
}

jsonConfig::~jsonConfig()
{}

jsonConfig& jsonConfig::getInstance(void)
{
    if (instance == NULL)
        instance = new jsonConfig();
    return *instance;
}

bool jsonConfig::find(QString name, mFaculty* out_mStruct)
{
    if (!jsonFile->open(QIODevice::ReadOnly))
        return false;
    QByteArray data = jsonFile->readAll();
    jsonFile->close();

    QJsonParseError parseError;
    QJsonDocument doc = QJsonDocument::fromJson(data, &parseError);
    if (parseError.error != QJsonParseError::NoError) {
        return false;
    }
    QJsonObject rootObj = doc.object();
    if (rootObj.contains("Faculty")) {
        if (rootObj.value("Faculty").type() == QJsonValue::Array) {
            QJsonArray sceneArray = rootObj.value("Faculty").toArray();
            for (int i = 0; i < sceneArray.size(); i++) {
                if (sceneArray.at(i).type() == QJsonValue::Object) {
                    QJsonObject obj = sceneArray.at(i).toObject();
                    if (obj.value("facultyName").toString() == name) {
                        *out_mStruct = jsonObject2MStruct(obj);
                        return true;
                    }
                }
            }
        }
    }
    return false;
}

QJsonObject jsonConfig::mStruct2JsonObject(mFaculty faculty)
{
    QJsonObject obj;
    obj.insert("facultyName", faculty.FacultyName);
    QJsonArray classArray;
    for (int i = 0; i < faculty.Class.size(); i++){
        QJsonObject classObj;
        classObj.insert("className", faculty.Class.at(i).ClassName);
        QJsonArray courseArray;
        for(QString course : faculty.Class.at(i).CourseName){
            if(!course.isEmpty())
                courseArray.append(course);
        }
        classObj.insert("classCourses",courseArray);
        classArray.append(classObj);
    }
    obj.insert("class", classArray);
    return obj;

}

mFaculty jsonConfig::jsonObject2MStruct(QJsonObject jsonObject)
{
    mFaculty faculty;
    if (jsonObject.value("facultyName").type() == QJsonValue::String)
        faculty.FacultyName = jsonObject.value("facultyName").toString();
    if (jsonObject.value("class").type() == QJsonValue::Array) {
        QJsonArray classArray = jsonObject.value("class").toArray();
        for (int i = 0; i < classArray.size(); i++) {
            mClass Class;
            QJsonObject classObj = classArray.at(i).toObject();
            if(classObj.value("className").type() == QJsonValue::String)
                Class.ClassName = classObj.value("className").toString();
            if(classObj.value("classCourses").type() == QJsonValue::Array){
                QJsonArray courseArray = classObj.value("classCourses").toArray();
                for (int j = 0; j < courseArray.size(); j++) {
                    if(!courseArray.at(j).toString().isEmpty())
                        Class.CourseName.append(courseArray.at(j).toString());
                }
            }
            faculty.Class.append(Class);
        }
    }
    return faculty;
}

void jsonConfig::add(mFaculty faculty)
{
    QJsonObject addObj = mStruct2JsonObject(faculty);
    if (!jsonFile->open(QIODevice::ReadOnly))
        return;
    QByteArray data = jsonFile->readAll();
    jsonFile->close();

    QJsonParseError parseError;
    QJsonDocument doc = QJsonDocument::fromJson(data, &parseError);
    if (parseError.error != QJsonParseError::NoError) {
        return;
    }
    QJsonObject rootObj = doc.object();

    if (rootObj.contains("Faculty")) {
        if (rootObj.value("Faculty").type() == QJsonValue::Array) {
            QJsonArray sceneArray = rootObj.value("Faculty").toArray();
            sceneArray.append(addObj);
            rootObj["Faculty"] = sceneArray;
        }
    }
    
    doc.setObject(rootObj);
    if (!jsonFile->open(QFile::WriteOnly | QFile::Truncate))
        return;
    QByteArray writeData = doc.toJson();
    jsonFile->write(writeData);
    jsonFile->close();
}

void jsonConfig::modify(mFaculty faculty)
{
    QJsonObject modifyObj = mStruct2JsonObject(faculty);
    if (!jsonFile->open(QIODevice::ReadOnly))
        return;
    QByteArray data = jsonFile->readAll();
    jsonFile->close();

    QJsonParseError parseError;
    QJsonDocument doc = QJsonDocument::fromJson(data, &parseError);
    if (parseError.error != QJsonParseError::NoError) {
        return;
    }
    QJsonObject rootObj = doc.object();

    if (rootObj.contains("Faculty")) {
        if (rootObj.value("Faculty").type() == QJsonValue::Array) {
            QJsonArray facultyArray = rootObj.value("Faculty").toArray();
            for (int i = 0; i < facultyArray.size(); i++) {
                if (facultyArray.at(i).type() == QJsonValue::Object) {
                    QJsonObject obj = facultyArray.at(i).toObject();
                    if (obj.value("facultyName").toString() == modifyObj.value("facultyName").toString()) {
                        facultyArray.removeAt(i);
                        facultyArray.append(modifyObj);
                    }
                }
            }
            rootObj["Faculty"] = facultyArray;
        }
    }

    doc.setObject(rootObj);
    if (!jsonFile->open(QFile::WriteOnly | QFile::Truncate))
        return;
    QByteArray writeData = doc.toJson();
    jsonFile->write(writeData);
    jsonFile->close();
}

void jsonConfig::remove(QString facultyName)
{
    if (!jsonFile->open(QIODevice::ReadOnly))
        return;
    QByteArray data = jsonFile->readAll();
    jsonFile->close();

    QJsonParseError parseError;
    QJsonDocument doc = QJsonDocument::fromJson(data, &parseError);
    if (parseError.error != QJsonParseError::NoError) {
        return;
    }
    QJsonObject rootObj = doc.object();

    if (rootObj.contains("Faculty")) {
        if (rootObj.value("Faculty").type() == QJsonValue::Array) {
            QJsonArray sceneArray = rootObj.value("Faculty").toArray();
            for (int i = 0; i < sceneArray.size(); i++) {
                if (sceneArray.at(i).type() == QJsonValue::Object) {
                    QJsonObject obj = sceneArray.at(i).toObject();
                    if (obj.value("facultyName").toString() == facultyName)
                        sceneArray.removeAt(i);
                }
            }
            rootObj["Faculty"] = sceneArray;
        }
    }

    doc.setObject(rootObj);
    if (!jsonFile->open(QFile::WriteOnly | QFile::Truncate))
        return;
    QByteArray writeData = doc.toJson();
    jsonFile->write(writeData);
    jsonFile->close();
}

QVector<mFaculty> jsonConfig::readAll()
{
    QVector<mFaculty> faculty;
    if (!jsonFile->open(QIODevice::ReadOnly))
        return faculty;
    QByteArray data = jsonFile->readAll();
    jsonFile->close();

    QJsonParseError parseError;
    QJsonDocument doc = QJsonDocument::fromJson(data, &parseError);
    if (parseError.error != QJsonParseError::NoError) {
        return faculty;
    }
    QJsonObject rootObj = doc.object();
    if (rootObj.contains("Faculty")) {
        if (rootObj.value("Faculty").type() == QJsonValue::Array) {
            QJsonArray facultyArray = rootObj.value("Faculty").toArray();
            for (int i = 0; i < facultyArray.size(); i++) {
                if (facultyArray.at(i).type() == QJsonValue::Object) {
                    QJsonObject obj = facultyArray.at(i).toObject();
                    mFaculty scene = jsonObject2MStruct(obj);
                    faculty.push_back(scene);
                }
            }
        }
    }
    return faculty;
}

四、使用示例

#include "jsonConfig.h"

int main(int argc, char *argv[])
{
    //添加到配置文件
    mFaculty faculty;
    faculty.FacultyName = "数学学院";
    jsonConfig::getInstance().add(faculty);

    //从配置文件删除
    jsonConfig::getInstance().remove("美术学院");

    //查找并修改配置
    mFaculty findFaculty;
    jsonConfig::getInstance().find("音乐学院",&findFaculty);
    for(int i = 0; i <findFaculty.Class.size(); i++){
        mClass c = findFaculty.Class.at(i);
        if(c.ClassName == "1班"){
            if(c.CourseName.contains("高等数学")){
                  c.CourseName.removeOne(高等数学);//删除课程
                  findFaculty.Class.remove(i);
                  findFaculty.Class.append(c);
                  break;
            }
            c.CourseName.append("高等数学2");    //添加课程
        }
    }
    jsonConfig::getInstance().modify(findFaculty);//修改配置

    //读取json中学院
    QVector<mFaculty> facultys = jsonConfig::getInstance().readAll();

}

五、使用效果

 使用后添加内容后，在文件夹下生成jsonConfigFile.json文件。

源客V
关注
  • 2
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Qt基础篇：Qt生成与解析修改JSON文件
欧特GO
03-28 3959
简述 Qt5 中包含了处理 JSON 的类，均以 QJson 开头（例如：QJsonDocument、QJsonArray、QJsonObject），在 QtCore 模块中，不需要额外引入其它模块。 效果： 代码如下： #include <QCoreApplication> #include <QJsonArray> #include <QJsonDocument> #include <QJsonObject> #include <QJsonPars
QT,解析和写json文件
12-07
Qt，使用QT自带类，解析Json文件，写Json文件、、、、
QJsonDocument、 QJsonObject、QJsonValue关系以及用法
bigger_belief的博客
05-31 3702
介绍QJson 三兄弟，以及如何使用
Qt5.5 二次封装QJsonDocument 实现Json更加方便的组装、解析
08-23
自己根据CMarkup启发，使用QJsonDocument完成类似CMarkup调用的json组装解析实例，内测多次无问题，目前还有优化空间，我的环境是qt5.5，欢迎大家提出不同意见共同进步。 本实例使用数据为测试数据，实际数据可根据业务需求进行扩展。
Qt 自定义配置文件configfile
ZZC555666的博客
08-28 812
1、定义configfile函数为外部静态函数，方便其他直接文件引用。 2、配置文件初始化，先判断路径，没有创建，然后新建配置信息。 3、配置文件读取，写入采取QSetting分组，键值对的方式。 configfile.h #ifndef CONFIGFILE_H #define CONFIGFILE_H #include "globe_data.h" #inclu...
Qt中QJsonDocument 类
GuoGuoABC
11-24 3040
​ 使用isArray()和isObject()可以分别查询一个文档是否包含了一个数组或一个object。使用array()或object()可以将包含在文档中的数组或object提取出来。​ QJsonDocument是一个包含了完整JSON文档的类，支持以UTF-8编码的文本和QT自身的二进制格式来读写JSON文档。​ 使用fromBinaryData()或fromRawData()也可以从一个二进制形式创建一个QJsonDocument对象。isNull() 进行查询。// JSON 文档为对象。
Qt-QJsonDocument读写json
萧海的博客
05-28 7474
QJsonDocument: 提供一种读取和写入JSON文档的方法,可以通过它的的成员函数array()或object()检索文档中包含的数组或对象，然后读取JSON数据,或者修改数据。 QJsonObject: 封装了一个JSON对象, 可以使用它的成员函数size()、insert()和remove()来对修改JSON数据. QJsonArray: 封装了一个JSON数组,用来实现JSON数组的 1.解析JSON-示例 注意:JSON中的Key命名不能相同,否则的话会覆盖掉,比如: { .
【Qt专栏】Qt中Json的使用教程
weixin_43729127的博客
10-27 1万+
两天奋斗的总结效果，一学就会，一用绝不废~哈哈哈
Qt扫盲-QJsonDocument理论总结
洪源兄
10-16 665
QJsonDocument类提供了一种读写JSON文档的方法。QJsonDocument是一个包装完整JSON文档的类，可以从基于UTF-8编码的文本表示和Qt自己的二进制格式读写该文档。所谓的JSON文档指的是就是一个我们能看到的用JSON语法构成的文档。比如下面的文本几种形式纯对象JSON文档基础数组JSON文档对象数组JSON文档},"我是普通文本~",},"我是普通文本~",},"我是普通文本~",},"我是普通文本~"混合JSON文档"data": [},},
【QT】——QJson类的使用
sjp11的博客
07-07 3753
QJsonArray中的所有类型的操作，都需要统一为 QJsonValue 类型。在QT中，从文件中或从网络中读取的数据是 QJson的字符流，这种字符流则用QJsonDocument来表示。QJsonObject 封装了 Json 中的对象，在里边可以存储多个键值对.QJsonArray 封装了 Json 中的数组，在里边可以存储多个元素，Json中主要两种数据格式：Json数组，和Json 对象。toBinaryData()函数转化的效果；，不允许同时存储多个并列的根节点。在一个 Json 文件中。
QT自定义代理类应用示例
01-05
如果我们使用QTableView来作为表格控件，显示数据，但是突然有需求需要在里面添加一些交互的控件，例如：按钮、进度条之类的，直接使用模型是无法实现的。可以使用QTableWidget控件可以很轻松的实现，但是这个不支持...
Qt4实现json文件的读取和显示
04-28
QT4不支持JSON格式，QT5自带了库，所以QT4需要引入第三方，这里使用的是Eeli Reilin的QtJson。本资源是对json库的实现案例，适合学习和理解json库的qt读写使用。
Qt之单例 - 读写配置文件
08-12
Qt之单例 - 读写配置文件。 具体可查看:https://blog.csdn.net/automoblie0/article/details/107955750
Qt学习笔记#第十章：INI、JSON、XML文件操作
m0_62299670的博客
09-18 449
include <QFile> // 文件读写\\\\\\#include <QJsonDocument> // JSON文档\\\\\#include <QJsonObject> // JSON对象\\\\\\#include <QJsonParseError> // JSON异常捕捉。可扩展标记语言（Extensible Markup Language，XML），标准通用语言子集，可以用来标记数据、定义数据、是一种允许用户对自己的标记语言进行定义的源语言。(键=值)name=value；
[QT编程系列-35]：数据存储 - JSON格式配置数据的存储与通知
文火冰糖（王文兵）的博客
08-01 950
这些 JSON 示例展示了不同的数据结构，包括简单对象、嵌套对象、数组，以及各种数据类型，例如字符串、数值、布尔值和空值。通过读取和解析这个 JSON 配置文件，应用程序可以获取和使用配置信息来设定其行为和设置。JSON 文本可以被解析和生成以在不同的编程语言和平台之间传输和处理数据。使用 QJsonObject，你可以创建、操作和访问 JSON 对象中的键值对数据。QJsonDocument 还提供了其他一些有用的方法，例如设置和获取文档的元数据，合并多个 JSON 文档等。
QJsonDocument实现Qt下JSON文档读写
coologic
12-20 764
介绍 Qt提供了一系列类以供进行Json 文档的读写，分别为： QJsonDocumentJson文档、QJsonArray数组、QJsonObject对象、QJsonValue值、QJsonParseError错误。 错误分类 Constant Value Description QJsonParseError::NoError 0 No error ...
qt5 json使用
热门推荐
寂寞的秋叶
04-28 2万+
Qt5中JSON的生成与解析 QJsonDocument     QJsonDocument既可以从一个基于文本表示的UTF-8编码，又可以从Qt自己的二进制格式读取和写入这个文件。     JSON文档可以从它的基于文本的表示使用QJsonDocument::fromJson()转换为QJsonDocument，用.toJSON()将其转换回文字。解析器非常快速和高效，将JSO
Ubuntu22.04本地部署qwen模型、jupyterlab开发环境、LoRA微调全流程-续
最新发布
weixin_42118737的博客
05-18 657
接着上一篇，在Ubuntu22.04本地部署qwen模型，准备数据，进行LoRA微调。
qt使用json作为配置文件
06-10
是的，Qt可以使用JSON作为配置文件。Qt提供了QJsonDocument和QJsonObject等类来处理JSON数据，可以将JSON数据解析为Qt中的对象，也可以将Qt中的对象序列化为JSON数据。以下是一个简单的示例： ```C++ #include <QCoreApplication> #include <QJsonDocument> #include <QJsonObject> #include <QFile> #include <QDebug> int main(int argc, char *argv[]) { QCoreApplication a(argc, argv); // 读取JSON文件 QFile file("config.json"); if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) return 1; // 解析JSON数据 QJsonParseError error; QJsonDocument doc = QJsonDocument::fromJson(file.readAll(), &error); if (error.error != QJsonParseError::NoError) { qDebug() << "JSON解析错误:" << error.errorString(); return 1; } // 读取配置项 QJsonObject obj = doc.object(); QString name = obj["name"].toString(); int age = obj["age"].toInt(); qDebug() << "姓名:" << name; qDebug() << "年龄:" << age; return a.exec(); } ``` 上面的示例中，我们读取了一个名为config.json的JSON文件，解析出其中的name和age字段，并将它们输出到控制台。你可以根据自己的需要修改JSON文件和代码。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

源客V

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值