学步园

The English version is available at: http://xizhizhu.blogspot.com/2010/11/beauty-of-qt-1-d-pointer-private.html

相信不少刚开始阅读Qt源代码的朋友在看到其中的Private类和诸如Q_D、Q_Q等宏时都会思考，为什么Qt要用这样一个设计模式呢？这样一段增加了不少复杂度的代码，到底有多大的好处呢？简单的说，这样的好处在于保证代码的二进制兼容性。

什么是二进制兼容性？大名鼎鼎的KDE项目是这样介绍的：一个库是二进制兼容的，如果一个程序和某个库的某个版本动态链接，并且不需要重新编译，即可在安装有该库较新版本的环境中运行。为什么要保证二进制兼容性？如果不能保证库的二进制兼容性，就意味着每次发布新版本时，依赖该库的所有程序都必须重新编译才能正常运行。显然，这对于像Qt这样被广泛采用的库而言是完全不可接受的。关于二进制兼容性的更多信息，感兴趣的朋友可以参考下KDE TechBase上的这篇文章，这里就不罗嗦了，仅仅和大家分享下具体的使用。

如果不使用D指针，那我们可能会有如下的一个类声明： 

class MyClass<br /> {<br /> public:<br /> MyClass();<br /> ~MyClass();<br /> private:<br /> int myVar;<br /> }; 

显然，这里的私有成员myVar是保证代码二进制兼容性的大敌，所以我们需要使用D指针，改写这个类：

class MyClassPrivate;<br /> class MyClass<br /> {<br /> public:<br /> MyClass();<br /> ~MyClass();<br /> private:<br /> MyClassPrivate * const d_ptr;<br /> Q_DECLARE_PRIVATE(MyClass);<br /> }; 

这里，我们定义了一个指针d_ptr指向私有实现类，然后用Q_DECLARE_PRIVATE宏来定义一些辅助函数和声明友元类：

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

然后这个私有类的实现如下所示：

class MyClassPrivate<br /> {<br /> public:<br /> MyClassPrivate(MyClass *parent);<br /> private:<br /> MyClass * const q_ptr;<br /> Q_DECLARE_PUBLIC(MyClass);<br /> int myVar;<br /> }; 

这里的q_ptr指针就是指向公开的接口了，然后Q_DECLARE_PUBLIC宏则定义了辅助函数并声明了友元类：

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

而我们还可以用Q_D和Q_Q两个宏来进一步简化访问：

#define Q_D(Class) Class##Private * const d = d_func()<br /> #define Q_Q(Class) Class * const q = q_func() 

这就是Qt中D指针/私有实现的最基本使用方法。最后用一个比较完整的例子作为结尾;)

// myclass.h<br /> #ifndef MYCLASS_H<br /> #define MYCLASS_H<br /> #include <QtCore/QObject><br /> class MyClassPrivate;<br /> class MyClass: public QObject<br /> {<br /> Q_OBJECT<br /> public:<br /> MyClass(QObject *parent = 0);<br /> virtual ~MyClass();<br /> void dummyFunc();<br /> signal:<br /> void dummySignal();<br /> private:<br /> MyClassPrivate * const d_ptr;<br /> Q_DECLARE_PRIVATE(MyClass);<br /> Q_DISABLE_COPY(MyClass);<br /> };<br /> #endif // MYCLASS_H<br /> // myclass.cpp<br /> #include "myclass.h"<br /> class MyClassPrivate<br /> {<br /> public:<br /> MyClassPrivate(MyClass *parent)<br /> : q_ptr(parent)<br /> {<br /> }<br /> void foobar()<br /> {<br /> Q_Q(MyClass);<br /> emit q->dummySignal();<br /> }<br /> private:<br /> MyClass * const q_ptr;<br /> Q_DECLARE_PUBLIC(MyClass);<br /> };<br /> MyClass::MyClass(QObject *parent)<br /> : QObject(parent)<br /> , d_ptr(new MyClassPrivate(this))<br /> {<br /> }<br /> MyClass::~MyClass()<br /> {<br /> Q_D(MyClass);<br /> delete d;<br /> }<br /> void MyClass::dummyFunc()<br /> {<br /> Q_D(MyClass);<br /> d->foobar();<br /> }