如何使用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

相关文章

GO语言中函数命名返回值的使用

《GO语言中函数命名返回值的使用》在Go语言中,函数可以为其返回值指定名称,这被称为命名返回值或命名返回参数,这种特性可以使代码更清晰,特别是在返回多个值时,感兴趣的可以了解一下... 目录基本语法函数命名返回特点代码示例命名特点基本语法func functionName(parameters) (nam

使用shardingsphere实现mysql数据库分片方式

《使用shardingsphere实现mysql数据库分片方式》本文介绍如何使用ShardingSphere-JDBC在SpringBoot中实现MySQL水平分库,涵盖分片策略、路由算法及零侵入配置... 目录一、ShardingSphere 简介1.1 对比1.2 核心概念1.3 Sharding-Sp

Java 正则表达式的使用实战案例

《Java正则表达式的使用实战案例》本文详细介绍了Java正则表达式的使用方法,涵盖语法细节、核心类方法、高级特性及实战案例,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录一、正则表达式语法详解1. 基础字符匹配2. 字符类([]定义)3. 量词(控制匹配次数)4. 边

Python Counter 函数使用案例

《PythonCounter函数使用案例》Counter是collections模块中的一个类,专门用于对可迭代对象中的元素进行计数,接下来通过本文给大家介绍PythonCounter函数使用案例... 目录一、Counter函数概述二、基本使用案例(一)列表元素计数(二)字符串字符计数(三)元组计数三、C

使用Spring Cache本地缓存示例代码

《使用SpringCache本地缓存示例代码》缓存是提高应用程序性能的重要手段,通过将频繁访问的数据存储在内存中,可以减少数据库访问次数,从而加速数据读取,:本文主要介绍使用SpringCac... 目录一、Spring Cache简介核心特点:二、基础配置1. 添加依赖2. 启用缓存3. 缓存配置方案方案

使用Python的requests库来发送HTTP请求的操作指南

《使用Python的requests库来发送HTTP请求的操作指南》使用Python的requests库发送HTTP请求是非常简单和直观的,requests库提供了丰富的API,可以发送各种类型的HT... 目录前言1. 安装 requests 库2. 发送 GET 请求3. 发送 POST 请求4. 发送

Nginx中配置使用非默认80端口进行服务的完整指南

《Nginx中配置使用非默认80端口进行服务的完整指南》在实际生产环境中,我们经常需要将Nginx配置在其他端口上运行,本文将详细介绍如何在Nginx中配置使用非默认端口进行服务,希望对大家有所帮助... 目录一、为什么需要使用非默认端口二、配置Nginx使用非默认端口的基本方法2.1 修改listen指令

Python WebSockets 库从基础到实战使用举例

《PythonWebSockets库从基础到实战使用举例》WebSocket是一种全双工、持久化的网络通信协议,适用于需要低延迟的应用,如实时聊天、股票行情推送、在线协作、多人游戏等,本文给大家介... 目录1. 引言2. 为什么使用 WebSocket?3. 安装 WebSockets 库4. 使用 We

python中的显式声明类型参数使用方式

《python中的显式声明类型参数使用方式》文章探讨了Python3.10+版本中类型注解的使用,指出FastAPI官方示例强调显式声明参数类型,通过|操作符替代Union/Optional,可提升代... 目录背景python函数显式声明的类型汇总基本类型集合类型Optional and Union(py

Java使用正则提取字符串中的内容的详细步骤

《Java使用正则提取字符串中的内容的详细步骤》:本文主要介绍Java中使用正则表达式提取字符串内容的方法,通过Pattern和Matcher类实现,涵盖编译正则、查找匹配、分组捕获、数字与邮箱提... 目录1. 基础流程2. 关键方法说明3. 常见场景示例场景1:提取所有数字场景2:提取邮箱地址4. 高级