C++ 慣用法之 PIMPL
一、背景
1.概述
PIMPL 是 C++ 中的一個(gè)編程技巧,意思為指向?qū)崿F(xiàn)的指針。具體操作是把類的實(shí)現(xiàn)細(xì)節(jié)放到一個(gè)單獨(dú)的類中,并用一個(gè)指針進(jìn)行訪問。
2.二進(jìn)制兼容性
(1) 概述
二進(jìn)制兼容是指當(dāng)庫文件升級(jí)后所有使用該庫的應(yīng)用程序不必重新編譯,其本質(zhì)就是類的內(nèi)存布局不變。使用 pimpl 方法設(shè)計(jì)類可以實(shí)現(xiàn)二進(jìn)制兼容的目的。
(2) 類成員更改后的內(nèi)存布局
原始類定義:
class demoClass
{
private:
int a;
int b;
};
內(nèi)存布局如下:
類更改后的定義:
class demoClass
{
private:
char c;
int a;
int b;
};
內(nèi)存布局如下:
(3) pimpl 下類的內(nèi)存布局
class demoClass
{
private:
class demoClassImpl;
demoClassImpl* impl;
};
class demoClass::demoClassImpl
{
public:
int a;
int b;
};
內(nèi)存布局如下:
如上圖所示,無論類的實(shí)現(xiàn)類的數(shù)據(jù)成員如何變化,類的布局始終不變。
二、pimpl 應(yīng)用
1.功能實(shí)現(xiàn)細(xì)節(jié)隱藏
(1) 概述
作為接口的提供者,我們希望接口的使用者不必知道接口實(shí)現(xiàn)的更多細(xì)節(jié),因?yàn)楦鶕?jù)類的私有數(shù)據(jù)成員和方法一般就可以猜測(cè)出接口的設(shè)計(jì)方式。
(2) 隱藏實(shí)現(xiàn)細(xì)節(jié)
通過 pimp 方法設(shè)計(jì)類可以實(shí)現(xiàn)隱藏類的私有成員和方法的目的,僅對(duì)外暴露公有的接口。
class demoClass
{
public:
void func();//對(duì)外接口
private:
class demoClassImpl;
demoClassImpl* impl;
};
class demoClass::demoClassImpl
{
private:
int a;
int b;
void func1();
void func2();
public:
void func();
};
void demoClass::func()
{
impl->func();
}
2.降低編譯依賴
(1) 概述
在一個(gè)常用的頭文件中如果包含了太多其他不必要的頭文件會(huì)嚴(yán)重降低編譯效率。
(2) 值類型的成員必須引用其頭文件
值類型的成員因?yàn)橐峙鋬?nèi)存大小必須知道其確定的定義,需要包含其頭文件
#include "A.h"
class demoClass
{
A a;
};
如果僅有類的申明則會(huì)出錯(cuò):
class A;
class demoClass
{
A a;
};
(3) 指針或者引用類型,僅需要類的申明
class A;
class demoClass
{
A func(A a);
};
(4) 使用 pimpl 降低編譯依賴
一般庫文件使用者僅需要包含當(dāng)前庫對(duì)應(yīng)的頭文件即可,不應(yīng)該再包含其他的頭文件。假設(shè)庫的頭文件定義如下:
#include "A.h"
class demoClass
{
private:
A a;
public:
void func();
};
此時(shí),若 A 為另外一個(gè)公共庫,則庫的使用者需要在項(xiàng)目中配置 A.h 的路徑;若 A 為自定義類,則庫的提供者還需要額外提供 A.h 文件。
使用 pimpl 方法改進(jìn)則可以減少編譯依賴,僅在類的實(shí)現(xiàn)文件中包含頭文件即可:
// demoClass.h
class demoClass
{
public:
void func();//對(duì)外接口
private:
class demoClassImpl;
demoClassImpl* impl;
};
// demoClass.cpp
#include "A.h"
class demoClass::demoClassImpl
{
private:
A a;
public:
void func();
};
2.動(dòng)態(tài)配置功能的實(shí)現(xiàn)方法
(1) 概述
使用 pimpl 的方式把類的功能實(shí)現(xiàn)用另外一個(gè)獨(dú)立的類來完成,可以在需要的時(shí)候動(dòng)態(tài)的配置類的實(shí)現(xiàn)方法,而保持類的接口不變。
(2) 代碼示例
公共接口類:
class demoClassImpl;
class demoClass
{
public:
void func();//對(duì)外接口
public:
demoClassImpl* impl;
};
void demoClass::func()
{
impl->func();
}
功能實(shí)現(xiàn)抽象類:
class demoClassImpl
{
public:
virtual void func() = 0;
};
功能實(shí)現(xiàn)派生類:
class demoClassImpl1 : public demoClassImpl
{
public:
void func() { cout << "實(shí)現(xiàn)方式1" << endl; }
};
class demoClassImpl2 : public demoClassImpl
{
public:
void func() { cout << "實(shí)現(xiàn)方式2" << endl; }
};
功能實(shí)現(xiàn)方式的動(dòng)態(tài)配置:
demoClass* demo = new demoClass;
demoClassImpl1* impl1 = new demoClassImpl1;
demo->impl = impl1;
demo->func();
demoClassImpl2* impl2 = new demoClassImpl2;
demo->impl = impl2;
demo->func();