如何使用Qt的PIMPL习惯用法(PIMPL Idiom

2024-06-24 10:12

本文主要是介绍如何使用Qt的PIMPL习惯用法(PIMPL Idiom,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

PIMPL是指“Pointer to IMPLementation”(指向实现的指针),意味着将实现细节隐藏起来,用户类无需关注这些实现细节。在Qt中常用PIMPL习惯用法来清晰地区分接口与实现,尽管Qt官方文档并未详细说明该机制。本文将演示如何在Qt中使用PIMPL习惯用法,并以一个简单的坐标输入对话框作为实例。

原理与动机

PIMPL的核心在于将类的实现细节封装在一个私有类中,这个私有类包含了所有特定于实现的数据和方法。通过这种方式,可以将头文件中的实现细节移除,减少头文件的依赖。

// CoordinateDialog.h
#include <QDialog>
#include <QVector3D>class CoordinateDialogPrivate;  // 前向声明私有类
class CoordinateDialog : public QDialog
{Q_OBJECTQ_DECLARE_PRIVATE(CoordinateDialog)  // 声明私有指针
#if QT_VERSION <= QT_VERSION_CHECK(5,0,0)Q_PRIVATE_SLOT(d_func(), void onAccepted())  // 兼容Qt 4的私有槽
#endifQScopedPointer<CoordinateDialogPrivate> const d_ptr;  // 智能指针管理私有类实例
public:CoordinateDialog(QWidget * parent = 0, Qt::WindowFlags flags = 0);~CoordinateDialog();QVector3D coordinates() const;Q_SIGNAL void acceptedCoordinates(const QVector3D &);
};
Q_DECLARE_METATYPE(QVector3D)

对比非PIMPL接口

不使用PIMPL的接口如下所示,尽管实现更为简单,但是头文件中包含了大量实现细节,违反了接口与实现分离的原则。

// CoordinateDialog.h
#include <QDialog>
#include <QVector3D>
#include <QFormLayout>
#include <QDoubleSpinBox>
#include <QDialogButtonBox>class CoordinateDialog : public QDialog
{QFormLayout m_layout;QDoubleSpinBox m_x, m_y, m_z;QVector3D m_coordinates;QDialogButtonBox m_buttons;Q_SLOT void onAccepted();
public:CoordinateDialog(QWidget * parent = 0, Qt::WindowFlags flags = 0);QVector3D coordinates() const;Q_SIGNAL void acceptedCoordinates(const QVector3D &);
};
Q_DECLARE_METATYPE(QVector3D)

实现细节

下面详细介绍PIMPL实现的各个部分。

接口文件(Header)部分

// CoordinateDialog.h
#include <QDialog>
#include <QVector3D>class CoordinateDialogPrivate;  // 前向声明
class CoordinateDialog : public QDialog
{Q_OBJECTQ_DECLARE_PRIVATE(CoordinateDialog)  // 声明私有指针
#if QT_VERSION <= QT_VERSION_CHECK(5,0,0)Q_PRIVATE_SLOT(d_func(), void onAccepted())  // 兼容Qt 4的私有槽
#endifQScopedPointer<CoordinateDialogPrivate> const d_ptr;  // 智能指针管理私有类实例
public:CoordinateDialog(QWidget * parent = 0, Qt::WindowFlags flags = 0);~CoordinateDialog();QVector3D coordinates() const;Q_SIGNAL void acceptedCoordinates(const QVector3D &);
};
Q_DECLARE_METATYPE(QVector3D)

实现文件(Source)部分

// CoordinateDialog.cpp
#include "CoordinateDialog.h"
#include <QFormLayout>
#include <QDoubleSpinBox>
#include <QDialogButtonBox>// 私有类的定义
class CoordinateDialogPrivate {Q_DISABLE_COPY(CoordinateDialogPrivate)  // 禁用拷贝Q_DECLARE_PUBLIC(CoordinateDialog)  // 声明公有指针CoordinateDialog * const q_ptr;  // 指向公有类实例的指针QFormLayout layout;QDoubleSpinBox x, y, z;QDialogButtonBox buttons;QVector3D coordinates;void onAccepted();CoordinateDialogPrivate(CoordinateDialog*);
};CoordinateDialogPrivate::CoordinateDialogPrivate(CoordinateDialog *dialog) :q_ptr(dialog),layout(dialog),buttons(QDialogButtonBox::Ok | QDialogButtonBox::Cancel)
{layout.addRow("X", &x);layout.addRow("Y", &y);layout.addRow("Z", &z);layout.addRow(&buttons);dialog->connect(&buttons, SIGNAL(accepted()), SLOT(accept()));dialog->connect(&buttons, SIGNAL(rejected()), SLOT(reject()));
#if QT_VERSION <= QT_VERSION_CHECK(5,0,0)this->connect(dialog, SIGNAL(accepted()), SLOT(onAccepted()));
#elseQObject::connect(dialog, &QDialog::accepted, [this]{ onAccepted(); });
#endif
}void CoordinateDialogPrivate::onAccepted() {Q_Q(CoordinateDialog);  // 声明指向公有类实例的指针coordinates.setX(x.value());coordinates.setY(y.value());coordinates.setZ(z.value());emit q->acceptedCoordinates(coordinates);
}CoordinateDialog::CoordinateDialog(QWidget *parent, Qt::WindowFlags flags) :QDialog(parent, flags),d_ptr(new CoordinateDialogPrivate(this))  // 初始化私有数据指针
{}QVector3D CoordinateDialog::coordinates() const {Q_D(const CoordinateDialog);  // 声明指向私有数据的指针return d->coordinates;
}CoordinateDialog::~CoordinateDialog() {}

关键宏解释

  • Q_DECLARE_PRIVATE(Class): 声明私有指针,d_func()返回指向私有类实例的指针。
  • Q_PRIVATE_SLOT(instance_pointer, method signature): 用来声明私有槽,仅用于Qt 4或非C++11兼容项目。
  • Q_DISABLE_COPY(Class): 禁用复制和赋值操作。
  • Q_DECLARE_PUBLIC(Class): 声明公有指针,q_func()返回指向公有类实例的指针。

常见问题与注意事项

  1. 头文件包含顺序:在实现文件中,接口文件必须首先包含。
  2. 私有类的定义:私有类不能在公有类内部定义。
  3. Q_ 宏的使用:宏的定义中已经包含了分号,因此无需额外添加分号。

这篇关于如何使用Qt的PIMPL习惯用法(PIMPL Idiom的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1089852

相关文章

使用Python实现可恢复式多线程下载器

《使用Python实现可恢复式多线程下载器》在数字时代,大文件下载已成为日常操作,本文将手把手教你用Python打造专业级下载器,实现断点续传,多线程加速,速度限制等功能,感兴趣的小伙伴可以了解下... 目录一、智能续传:从崩溃边缘抢救进度二、多线程加速:榨干网络带宽三、速度控制:做网络的好邻居四、终端交互

Python中注释使用方法举例详解

《Python中注释使用方法举例详解》在Python编程语言中注释是必不可少的一部分,它有助于提高代码的可读性和维护性,:本文主要介绍Python中注释使用方法的相关资料,需要的朋友可以参考下... 目录一、前言二、什么是注释?示例:三、单行注释语法:以 China编程# 开头,后面的内容为注释内容示例:示例:四

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁

ModelMapper基本使用和常见场景示例详解

《ModelMapper基本使用和常见场景示例详解》ModelMapper是Java对象映射库,支持自动映射、自定义规则、集合转换及高级配置(如匹配策略、转换器),可集成SpringBoot,减少样板... 目录1. 添加依赖2. 基本用法示例:简单对象映射3. 自定义映射规则4. 集合映射5. 高级配置匹

Spring 框架之Springfox使用详解

《Spring框架之Springfox使用详解》Springfox是Spring框架的API文档工具,集成Swagger规范,自动生成文档并支持多语言/版本,模块化设计便于扩展,但存在版本兼容性、性... 目录核心功能工作原理模块化设计使用示例注意事项优缺点优点缺点总结适用场景建议总结Springfox 是

嵌入式数据库SQLite 3配置使用讲解

《嵌入式数据库SQLite3配置使用讲解》本文强调嵌入式项目中SQLite3数据库的重要性,因其零配置、轻量级、跨平台及事务处理特性,可保障数据溯源与责任明确,详细讲解安装配置、基础语法及SQLit... 目录0、惨痛教训1、SQLite3环境配置(1)、下载安装SQLite库(2)、解压下载的文件(3)、

使用Python绘制3D堆叠条形图全解析

《使用Python绘制3D堆叠条形图全解析》在数据可视化的工具箱里,3D图表总能带来眼前一亮的效果,本文就来和大家聊聊如何使用Python实现绘制3D堆叠条形图,感兴趣的小伙伴可以了解下... 目录为什么选择 3D 堆叠条形图代码实现:从数据到 3D 世界的搭建核心代码逐行解析细节优化应用场景:3D 堆叠图

Springboot如何正确使用AOP问题

《Springboot如何正确使用AOP问题》:本文主要介绍Springboot如何正确使用AOP问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录​一、AOP概念二、切点表达式​execution表达式案例三、AOP通知四、springboot中使用AOP导出

Navicat数据表的数据添加,删除及使用sql完成数据的添加过程

《Navicat数据表的数据添加,删除及使用sql完成数据的添加过程》:本文主要介绍Navicat数据表的数据添加,删除及使用sql完成数据的添加过程,具有很好的参考价值,希望对大家有所帮助,如有... 目录Navicat数据表数据添加,删除及使用sql完成数据添加选中操作的表则出现如下界面,查看左下角从左

python 常见数学公式函数使用详解(最新推荐)

《python常见数学公式函数使用详解(最新推荐)》文章介绍了Python的数学计算工具,涵盖内置函数、math/cmath标准库及numpy/scipy/sympy第三方库,支持从基础算术到复杂数... 目录python 数学公式与函数大全1. 基本数学运算1.1 算术运算1.2 分数与小数2. 数学函数