PIMPL 模式 以及Q_DECLARE_PUBLIC 与 Q_DECLARE_PRIVATE

PIMPL(Private Implementation)模式是一种设计模式,也被称为“编译期接口隔离”或“指针实现”模式。它的主要目的是将类的私有实现部分与公共接口部分分离,以减少编译依赖性、提高封装性和减少暴露的细节。在 C++ 中,PIMPL 模式通常通过将类的私有数据和实现放在一个单独的类中,然后在类的公共接口中使用指向该私有实现类的指针来实现。

在 Qt 中,Q_DECLARE_PRIVATE 和 Q_DECLARE_PUBLIC 是两个宏,用于实现 PIMPL 模式。Q_DECLARE_PRIVATE 用于在类中声明一个私有指针,指向私有实现类,而 Q_DECLARE_PUBLIC 用于在类中声明一个公共指针,用于访问公共接口。

下面是一个示例,演示如何使用 PIMPL 模式和 Q_DECLARE_PRIVATEQ_DECLARE_PUBLIC 宏:

// Widget.h

#include <QObject>

class WidgetPrivate; // 前向声明私有实现类

class Widget : public QObject
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(Widget)

public:
    Widget(QObject *parent = nullptr);
    void doSomething();

private:
    Q_DECLARE_PUBLIC(Widget)
};
// Widget.cpp

#include "Widget.h"
#include <QDebug>

class WidgetPrivate
{
    Q_DECLARE_PUBLIC(Widget)
public:
    void privateFunction()
    {
        q_ptr->doSomething();
    }
};

Widget::Widget(QObject *parent) : QObject(parent)
{
    d_ptr = new WidgetPrivate;
    q_ptr = this;
}

void Widget::doSomething()
{
    qDebug() << "Doing something!";
}

在这个示例中,Widget 类使用 PIMPL 模式实现了类的私有数据和实现的封装。Q_DECLARE_PRIVATE(Widget) 宏用于声明一个私有指针 d_ptr,指向私有实现类 WidgetPrivate,而 Q_DECLARE_PUBLIC(Widget) 宏用于声明一个公共指针 q_ptr,用于访问公共函数。

通过 PIMPL 模式和 Q_DECLARE_PRIVATEQ_DECLARE_PUBLIC 宏的结合使用,我们可以实现类的私有性和封装,避免暴露私有实现的细节,同时提高类的可维护性和灵活性。

  • Q_DECLARE_PUBLIC
#define Q_DECLARE_PUBLIC(Class) \
    inline Class *q_func() { return static_cast<Class *>(q_ptr); } \
    inline const Class *q_func() const { return static_cast<const Class *>(q_ptr); } \
    friend class Class;

在这个定义中,Q_DECLARE_PUBLIC 宏实际上定义了两个内联函数和一个友元类。这些部分的作用如下:

  1. inline Class *q_func() { return static_cast<Class *>(q_ptr); }:这个函数用于返回指向类的公共接口的指针。通常在私有实现类中使用,以便访问类的公共函数和成员变量。

  2. inline const Class *q_func() const { return static_cast<const Class *>(q_ptr); }:这个函数用于返回指向类的常量公共接口的指针。通常在私有实现类中使用,以便访问类的常量公共函数和成员变量。

  3. friend class Class;:这一行声明了一个友元类,使得类的公共接口可以访问私有实现类的私有成员。

使用 Q_DECLARE_PUBLIC 宏可以帮助在 Qt 的 PIMPL 模式中实现类的私有实现和公共接口的分离,提高代码的封装性和可维护性。

  • Q_DECLARE_PRIVATE 
#define Q_DECLARE_PRIVATE(Class) \
    inline Class##Private *d_func() { return reinterpret_cast<Class##Private *>(qGetPtrHelper(d_ptr)); } \
    inline const Class##Private *d_func() const { return reinterpret_cast<const Class##Private *>(qGetPtrHelper(d_ptr)); } \
    friend class Class##Private;

在这个定义中,Q_DECLARE_PRIVATE 宏实际上定义了两个内联函数和一个友元类。这些部分的作用如下:

  1. inline Class##Private *d_func() { return reinterpret_cast<Class##Private *>(qGetPtrHelper(d_ptr)); }:这个函数用于返回指向类的私有实现的指针。通常在类的公共接口中使用,以便访问私有实现的数据和功能。

  2. inline const Class##Private *d_func() const { return reinterpret_cast<const Class##Private *>(qGetPtrHelper(d_ptr)); }:这个函数用于返回指向类的私有实现的常量指针。通常在类的公共接口中使用,以便访问私有实现的常量数据和功能。

  3. friend class Class##Private;:这一行声明了一个友元类,使得类的私有实现可以访问类的私有成员。

通过使用 Q_DECLARE_PRIVATE 宏,可以实现在 Qt 中使用 PIMPL 模式(Private Implementation)来隐藏类的私有实现细节,从而提高封装性和灵活性。

  • 15
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值