《C++ API设计》读书笔记之 《Pimpl惯用法》

Pimpl是“pointer to implementation”的缩写, 该技巧可以避免在头文件中暴露私有细节。Pimpl利用了c++的一个特点,即可以将类的数据成员定义为指向某个已经声明过的类型的指针, 这里的类型仅仅作为名字引入, 并没有被完整地定义。

例如“自动定时器”的API, 它是一个具名对象,当对象被销毁时打印出其生存时间。

  • AutoTimer.h 如下:
#ifdef _WIN32 
#include <windows.h>
#else
#include <sys/time.h>
#endif

#include <string>

class AutoTimer
{
public:
    explicit AutoTimer(const std::string name);
    ~AutoTimer();
private:
    double getElapsed() const;
    std::string mName;

#ifdef _WIN32 
    DWORD mStartTime;
#else
    struct timeval mStartTime;
#endif
    
};

从上面的h文件可知,该API暴露了定时器在不同平台上存储的底层细节,利用Pimpl特性, 可轻易的隐藏掉这些底层实现的细节, 利用Pimpl特效后新的h文件如下:

#include <string>

class AutoTimer{
public:
    explicit AutoTimer(const std::string& name);
    ~AutoTimer();
private:
    class Impl;
    Impl* mImpl;
};

新API更简洁, 没有任何平台相关的预处理指令, 他人也不能通过头文件了解类的任何私有成员。

现在AutoTimer的功能实现都放在内嵌类Impl中了, 具体的AutoTimer的cpp文件如下:


#include "AutoTimer.h"

#ifdef _WIN32
#include <windows.h>
#else

#include <sys/time.h>
#include <iostream>

#endif

class AutoTimer::Impl
{
public:
    double getElapsed() const
    {
#ifdef _WIN32
        return (GetTickCount() - mStartTime) / 1e3;
#else
        struct timeval end_time;
        gettimeofday(&end_time, NULL);
        double t1 = mStartTime.tv_usec / 1e6 + mStartTime.tv_sec;
        double t2 = end_time.tv_usec / 1e6 + end_time.tv_sec;
        return t2 - t1;
#endif
    }

    std::string mName;
#ifdef _WIN32
    DWORD mStartTime;
#else
    struct timeval mStartTime;
#endif

};

AutoTimer::AutoTimer(const std::string &name)
: mImpl(new AutoTimer::Impl())
{
    mImpl->mName = name;
#ifdef _WIN32
    mImpl->mStartTime = GetTickCount();
#else
    gettimeofday(&mImpl->mStartTime, NULL);
#endif
}

AutoTimer::~AutoTimer()
{
    std::cout << mImpl->mName << ":took " << mImpl->getElapsed() << " secs" << std::endl;
    delete mImpl;
    mImpl = NULL;
}

将Impl类声明为AutoTimer类的私有内嵌类, 可以避免与该实现相关的符号污染全局命名空间。

  • Pimpl的优点:
  1. 信息隐藏, 将具体实现放在cpp文件中, h文件只暴露公有接口;
  2. 降低耦合;
  3. 加速编译;
  4. 更好的二进制兼容性,二进制兼容性指的是在升级库文件的时候(windows下的dll, uinx下的so),不必重新编译使用这个库的可执行文件或使用这个库的其他库文件,程序的功能不被破坏;
  5. 惰性分配;
  • 缺点
  1. 添加了一层封装, 可能进入性能问题;
  2. 代码可读性降低;
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,639评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,277评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,221评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,474评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,570评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,816评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,957评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,718评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,176评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,511评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,646评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,322评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,934评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,755评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,987评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,358评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,514评论 2 348

推荐阅读更多精彩内容