// MyClass.h
class MyClass {
public:
void func1();
void func2();
private:
void func3();
void func4();
int a;
int b;
};
假设我们在开发一个SDK,或者设计某个模块,需要暴露出去一个MyClass.h头文件,并向用户提供func1和func2两个功能。但是MyClass中还有一些private函数和字段,这些函数和字段我们本意可能是不想被用户知道,因为可能里面有些隐私内容,用户有可能通过这些private方法和字段就能猜到我们的架构及实现。这也是我们平时设计模块需要注意的一点:只暴露出该暴露的东西。
pimpl实现方法
// MyClass.h
class MyClass {
public:
void func1();
void func2();
private:
class impl;
impl* pimpl;
};
// MyClass.cc
class MyClass::impl {
public:
void func1();
void func2();
private:
void func3();
void func4();
int a;
int b;
};
MyClass::MyClass() {
pimpl = new impl;
}
void MyClass::func1() {
pimpl->func1();
}
将类的private属性隐藏进一个内部类,然后通过一个指针访问(提前声明)它的接口。在头文件中只暴露出应该暴露的功能,然后持有一个Impl的指针,而Impl则具体在MyClass.cc中定义,用户什么都看不到。然后所有的功能都通过Impl完成。头文件里的Impl的指针也可以通过智能指针(unique_ptr)来代替。
pimpl模式的优点:
-
非常适合隐藏private实现:如果想要在头文件中暴露public接口,但又不想暴露private实现的细节,则可以使用pimpl模式来隐藏细节。
-
pimpl模式也被称为编译防火墙,是一种用来减少编译时间的方法。通常来讲,如果头文件里的某些内容变更了,意味着所有引用该头文件的代码都要被重新编译,即使变更的是无法被用户类访问的私有成员。将这部分代码从被引用多次的头文件里移除到只被引用编译一次的源文件中,更改此文件就不会付出太长的编译时间。