Qt读取ini格式配置文件的类设计

目录

1.引言

2.QSettings

2.1.功能特点

2.2.基本用法

3.读取ini文件配置通用类设计

3.1.设计要点

3.2.完整实现

3.3.调用方法

4.总结

---

1.引言

        在编写应用程序的时，有些参数需要用户配置，那么这些参数就涉及到存储了，单从存储来讲，就有很多实现的方案，比如ini格式文件保存、xml格式文件保存、json格式文件保存，数据库保存等，其中ini格式文件保存比较简单，也是平时项目用的比较多的一种，下面就详细讲讲Qt中读取ini格式配置文件的方法和通用类设计。

2.QSettings

        QSettings 是 Qt 框架中用于读取和写入应用程序配置信息的类。它提供了一个跨平台的解决方案，可轻松地保存和获取应用程序的设置和状态。

2.1.功能特点

1）跨平台支持：QSettings能够自动适配不同的操作系统，确保配置数据能在不同平台间无缝迁移。无论是Windows的注册表、macOS的plist文件，还是INI文件或JSON格式的文件，QSettings都能轻松处理。

2）键值对存储：使用键值对的方式来存储和读取应用程序的设置信息，使得配置数据的管理变得简单直观。

3）多种存储格式：支持多种存储格式，包括NativeFormat（使用操作系统推荐的存储方式）、IniFormat（将数据保存为INI格式的文本文件）和CustomFormat（允许指定自定义的存储格式，但需配合自定义的QSettings backend实现）。

4）默认值支持：在读取设置值时，如果找不到指定的键，QSettings可以返回预设的默认值。

5）辅助方法：提供了一些辅助方法来处理组织和应用程序范围的设置，以及检查设置是否存在、删除设置项等功能。

2.2.基本用法

创建QSettings对象

在使用 QSettings 之前，首先需要创建一个 QSettings 对象。可以通过以下两种方式进行初始化：

使用应用程序的组织名称和应用程序名称进行初始化：

QSettings settings("组织名称", "应用程序名称");

使用配置文件路径进行初始化：

QSettings settings("ConfigFile/config.ini", QSettings::IniFormat);

注意：如果没有指定配置文件路径，QSettings 将使用平台特定的位置存储配置信息。

存储设置值

使用 setValue() 函数可以将键值对存储到配置文件中：

settings.setValue("key", "value");

读取设置值：

使用 value() 函数可以读取配置文件中的键对应的值：

QVariant value = settings.value("键");  
// 如果需要特定类型的值，可以使用如下方式：  
QString stringValue = settings.value("键").toString();  
int intValue = settings.value("键").toInt();

如果要指定默认值，可以在读取时提供：

QString username = settings.value("username", "DefaultUser").toString();

设置系统编码

当ini文件的内容中可能有中文，如果不设置编码，就可能出现乱码。

QSettings iniRead(file, QSettings::IniFormat);
iniRead.setIniCodec("utf-8"); //解决中文乱码的情况

检查设置是否存在：

bool exists = settings.contains("键");

删除设置项：

使用 remove() 函数可以删除配置文件中的指定键：

settings.remove("key");

持久化设置：

在多线程环境中，如果需要确保数据立即写入持久存储，可以使用sync()方法：

settings.setValue("Setting1", "Value1");  
settings.sync(); // 强制立即写入

访问子组：

settings.beginGroup("Window");  
settings.setValue("Width", 800);  
settings.endGroup(); // 可选，用于提高代码可读性

综合示例：

以下是一个使用QSettings保存和恢复窗口位置、大小等设置的示例：

#include <QApplication>  
#include <QMainWindow>  
#include <QSettings>  
  
int main(int argc, char *argv[]) {  
    QApplication app(argc, argv);  
    QMainWindow window;  
    window.setWindowTitle("QSettings Example");  
  
    // Load settings  
    QSettings settings("YourCompany", "YourApp");  
    window.resize(settings.value("WindowSize", QSize(640, 480)).toSize());  
    window.move(settings.value("WindowPosition", QPoint(100, 100)).toPoint());  
  
    // Connect signals to save settings when necessary  
    QObject::connect(&window, &QMainWindow::windowStateChanged, [&settings](Qt::WindowState state) {  
        if (state == Qt::WindowMaximized)  
            settings.setValue("WindowState", "maximized");  
        else  
            settings.setValue("WindowState", "normal");  
    });  
    QObject::connect(&window, &QMainWindow::moveEvent, [&](QMoveEvent *event) {  
        settings.setValue("WindowPosition", event->pos());  
    });  
    QObject::connect(&window, &QMainWindow::resizeEvent, [&](QResizeEvent *event) {  
        settings.setValue("WindowSize", event->size());  
    });  
  
    window.show();  
    return app.exec();  
}

在这个示例中，我们创建了一个QSettings实例，并在窗口初始化时从其中加载先前保存的尺寸和位置。同时，连接了窗口状态变化、移动和调整大小的信号，以便在这些事件发生时自动更新存储的设置。

3.读取ini文件配置通用类设计

3.1.设计要点

1）应用程序用ini保存系统的配置，一般来说整个程序就一份，可以用单实例模式来实现整个类：

设计模式之单例模式-CSDN博客

class CShortWaveConfig
{
protected:
	CShortWaveConfig();
	~CShortWaveConfig();
	
    ...

public:
	static CShortWaveConfig& instance();

    ....
};

2）普通的编程思路是一行一行得读取ini文件，然后分别保存到变量中，这样做不具有批量操性；转变一下思路，可以一次性把整个文件读取出来，保存到QMap中，关键代码如下：

class CShortWaveConfig
{
protected:
    bool loadConfig();

    。。。
private:
	QMap<QString, QVariant> m_value;
};

bool CShortWaveConfig::loadConfig()
{
	。。。

	QStringList allKeys = iniRead.allKeys();
	for (auto& it : allKeys) {
		m_value[it] = iniRead.value(it);
	}
	return true;
}

3）元素的访问，每个元素的类型不知道，可利用C++中的模板把元素的类型T传入，判断是否可以从QVariant中的类型转换成T，关键代码如下：

template<typename T>
T value(const QString& key) {
    auto item = m_value.find(key);
    if (item != m_value.end()) {
		const QVariant& value1 = item.value();
		if (value1.canConvert<T>()) {
			return value1.value<T>();
		}
		assert(false);
	}
		
    。。。
}

4）元素的访问时，如果传入的路径找不到元素，可以返回默认参数，关键代码如下：

template<typename T>
T value(const QString& key, const T& defalutValue) {
	auto item = m_value.find(key);
	if (item != m_value.end()) {
		。。。
	}
	return defalutValue;
}

3.2.完整实现

ShortWaveConfig.h

#ifndef _SHORT_WAVE_CONFIG_H_
#define _SHORT_WAVE_CONFIG_H_
#include <QString>
#include <QMap>
#include <QVariant>
#include <assert.h>
using namespace std;

class CShortWaveConfig
{
protected:
	CShortWaveConfig();
	~CShortWaveConfig();
	bool loadConfig();

public:
	static CShortWaveConfig& instance();

	template<typename T>
	T value(const QString& key, const T& defalutValue) {
		auto item = m_value.find(key);
		if (item != m_value.end()) {
			const QVariant& value1 = item.value();
			if (value1.canConvert<T>()) {
				return value1.value<T>();
			}
			assert(false);
		}
		return defalutValue;
	}

private:
	QMap<QString, QVariant> m_value;
};

#endif

ShortWaveConfig.cpp

#include "ShortWaveConfig.h"
#include <QFile>
#include <QApplication>
#include <QSettings>

CShortWaveConfig::CShortWaveConfig()
{
	bool result = loadConfig();
	assert(result);
}

CShortWaveConfig::~CShortWaveConfig()
{

}

bool CShortWaveConfig::loadConfig()
{
	QString file = QCoreApplication::applicationDirPath() + "/systemConfig.ini";
	if (!QFile::exists(file)) {
		return false;
	}

	QSettings iniRead(file, QSettings::IniFormat);
	iniRead.setIniCodec("utf-8"); //解决中文乱码的情况
	QStringList allKeys = iniRead.allKeys();
	for (auto& it : allKeys) {
		m_value[it] = iniRead.value(it);
	}
	return true;
}

CShortWaveConfig& CShortWaveConfig::instance()
{
	static CShortWaveConfig config;
	return config;
}

3.3.调用方法

//姓名
QString name = CShortWaveConfig::instance().value<QString>("Attr/name", "xiaoming");

//年龄
int age = CShortWaveConfig::instance().value<int>("Attr/age", 20);

4.总结

        本文详细介绍了 Qt 中的 QSettings 类，包括初始化、读取、写入和删除配置信息的操作。还讲解了在整个系统中怎么去设计系统配置文件读取类CShortWaveConfig。通过合理使用类CShortWaveConfig，您可以轻松管理和存储应用程序的配置信息，提高应用程序的灵活性和可维护性。