C++的pimpl用法

  C++的pImpl可以说是最常见的惯用手法了,在很多的C++项目和C++开发库中都有所见。plmp的缩写就是Pointer to Implementor,顾名思义就是将真正的实现细节的Implementor从类定义的头文件中分离出去,公有类通过一个私有指针指向隐藏的实现类,是促进接口和实现分离的重要机制。
  在C++语言中,要定义某个类型的变量或者使用类型的某个成员,就必须知道这个类的完整定义,其例外情况是:如果定义这个类型的指针,或者该类型是函数的参数或者返回类型(即使是传值类型的),那么就可以通过前置声明引入这个类型的名字,而不需要提供暴露其完整的类型定义,从而类型的完整定义可以被隐藏在其他hpp头文件或者cpp实现文件中,而这个指针也被称为不透明指针(opaque pointer)。通常的pImp的手法是在API的头文件中提供接口类的定义以及实现类的前置声明,实现类的本身定义和成员函数的实现都隐藏在cpp文件中去,同时为了避免实现类的符号污染外部名字空间,实现类大多作为接口类的内部嵌套类的形式。

一、pImpl手法的优势和目的

1.1 信息隐蔽

  私有成员完全可以隐藏在共有接口之外,尤其对于闭源API的设计尤其的适合。同时,很多代码会应用平台依赖相关的宏控制,这些琐碎的东西也完全可以隐藏在实现类当中,给用户一个间接明了的使用接口再好不过了。

1.2 加速编译

  这通常是用pImpl手法的最重要的收益,称之为编译防火墙(compilation firewall),主要是阻断了类的实现和类的实现两者的编译依赖性。这样,类用户不需要额外include不必要的头文件,同时实现类的成员可以随意变更,而公有类的使用者不需要重新编译。
compilation firewall

1.3 更好的二进制兼容性

  承接上面说的,通常对一个类的修改,会影响到类的大小、对象的表示和布局等信息,那么任何该类的用户都需要重新编译才行。而且即使更新的是外部不可访问的private部分,虽然从访问性来说此时只有类成员和友元能否访问类的私有部分,但是由于C++的特性是名字查找先于名字查找和重载解析的(即使不可访问也会返回调用失败,而不是视而不见),私有部分的修改也会影响到类使用者的行为,这也迫使类的使用者需要重新编译。而对于使用pImpl手法,如果实现变更被限制在实现类中,那公有类只持有一个实现类的指针,所以实现做出重大变更的情况下,pImpl也能够保证良好的二进制兼容性。
  因此,独立和自由是pImpl的精髓所在。

1.4 惰性分配

  实现类可以做到按需分配或者实际使用时候再分配,从而节省资源提高响应。如果你意识到这点了,那是很不错的。

二、公有类和实现类的隔离程度

  由于公有类是实现类的抽象,实现类是公有类的封装隐藏,推荐的隔离方式是:将所有非virtual的private成员都放置到impl中去,同时将private成员函数需要调用的公有函数也放置到impl中去,virtual函数和protected的成员不应当放到impl中去
  protected的成员放到impl中没有任何的意义,因为protected是相对于继承关系而生效的;同样的,virtual成员也不应该放到impl中去,因为virtual函数需要被继承链中的派生类去override。这里需要提到,virtual函数也可以是private的,函数的virtual和access两者是正交毫无关联的,即使派生类无法访问基类的虚函数,但是派生类仍然可以override基类的虚函数!这引出了一个Template Method的设计模式。
  将private函数需要调用到的public方法也放到impl中去,是为了避免下面所描述的back pointer带来开销的妥协。当然,还有一种极端的方式是除此以外将所有的public成员都丢到impl中去,那么公有类就相当于一个接口类,进而所有接口都需要一个wrapper进行调用的转发,此时公有类会实现的比较无趣和杂乱,而且无法被继承复用。

三、pImpl实现需要注意事项

3.1 资源管理

  尽可能避免的使用原始指针来创建和delete释放实现类对象,使用boost::scoped_ptr或者std::unique_ptr来管理实现类对象,而且如果确实需要实现类共享,可以使用boost::shared_ptr来管理。同时scoped_ptr、unique_ptr实现上要比shared_ptr高效的多。
  如果使用智能指针管理实现类对象的话,使用unique_ptr则需要手动在实现文件中定义共有类的析构函数,这是因为虽然unique_ptr和shared_ptr都可以在类型不完全的情况下定义其智能指针,但是unique_ptr其析构函数则需要具有持有类型的完全定义,而shared_ptr比较智能则没有这个限制。

3.2 拷贝语义

  pImpl最需要关注的就是共有类的复制语义,因为实现类是以指针的方式作为共有类的一个成员,而默认C++生成的拷贝操作只会执行对象的浅复制,这显然违背了pImpl的原本意图,除非是真的想要底层共享一个实现对象。针对这个问题,解决方式有:
  a. 禁止复制操作,将所有的复制操作定义为private的,或者继承boost::noncopyable,或者在新标准中将这些复制操作定义为delete的即刻;
  b. 显式定义复制语义,创建新的实现类对象,执行深度复制操作。此处需要记住0-3-5法则哦,要么不定义拷贝、移动操作符,要定义就需要将他们全部重新定义。

3.3 impl对公有类的反向引用

  实现类中的私有成员如果需要访问公有类的公共、保护的成员,就必须要能够引用到公有类对象,实现其手段有:
  a. impl持有一个对公有类对象的指针或者引用。虽然方便但是往往会有问题:如果持有的是引用,则拷贝赋值就难以实现,如果持有的是指针,则需要小心指针有效性的同步负担(比如移动操作)。
  b. 推荐的方式,是impl中的这些函数都增加一个对公有类的引用或者指针,那么其调用方法类似于:

1
pimpl->func(this, params);

3.4 pImpl手法的缺点:

  a. 该手法需要在调用和实现之间插入了一个指针,公有类在访问私有成员的时候都需要增加mImpl->前缀的方式,使用、阅读和调试都可能有所不便;
  b. pImpl对拷贝操作比较敏感,要么你禁止拷贝操作,要么就需要自定义拷贝操作;
  c. 编译器将不再能够捕获const方法中对成员变量的修改,因为私有成员变量已经从公有类脱离到了实现类当中了,公有类的const只能保护指针值本身是否改变,而不再能进一步保护其所指向的数据。如果要达到类似的保护效果,可以使用std::experimental::propagate_const技术。

  pImpl是一个很重要、实用的编程技巧,强烈建议掌握之!

本文完!

参考