一个库接口设计实例

这篇我们将从一个C程序入手简单分析C库在日常中的使用,然后在根据使用提出一些问题,进而为了解决这些问题,我们采用C++进行简单封装,看看这样做能带给我们什么好处。
首先看下例子:

#include <stdio.h>
#include <dirent.h>

int main()
{
    DIR* dp = opendir(".");
    struct dirent* d;
    while(d = readdir(dp))
        printf("*s\n", d->d_name);
    closedir(dp);
    return 0;
}

这个例子的意义在于:我们如何对那些不支持数据抽象的语言中十分通用的约定,使用数据抽象来自动管理。
上面的例子中,我们通过opendir()函数返回一个DIR*类型的变量,这个变量在后续的所有操作中都有出现,例如:readdir(dp),closedir(dp)。这个变量dp充当了一种神奇的cookies,即:它使得库函数知道具体操作的是那个目录。
这个看似非常普通的程序,却包含了一些隐含的约定。首先看看我们可以针对这个例子提出哪些问题。

复杂的问题

  • 如果传给opendir的字符串指定了一个不存在的目录会怎样?按照我们习惯,opendir应该是返回了一个空指针。这样可以方便用户进行检测。但是这样就有了下面的问题。
  • 如果readdir()接受了一个空指针的DIR*会怎样?这里可能有两种情况:1. readdir直接使用了这个空指针,那么将导致coredump。2. readdir进行了某些检查,并进行了对应的处理。如果是第二种情况,又会导致下面的问题。
  • 如果readdir()接受的参数既不是空指针,又不是opendir()的返回值会发生什么?这种错误很难被发现。因为readdir()几乎没有办法检查传入参数是否为合法值。针对readdir()的返回值,也有下面的问题。
  • readdir()返回的结果,什么时候释放掉申请的内存呢?如果发生下面的情况:
d1 = readdir(dp);
d2 = readdir(dp);
printf("%s\n", d1->d_name);

这个时候d1还是有效的吗?为了解决这个问题,我们还需要弄清楚哪些操作会导致d1失效,以及我们应该怎么使用这些库函数。

上面的分析可以得出,我们在使用C库函数的时候,已经遵守了一些隐含的约定。下面我们来看看,使用C++重新进行封装会不会减轻用户的负担。将这些约定通过数据抽象隐藏起来。

优化接口

首先我们针对这个DIR神奇的cookies进行优化,我们将它修改为一个类。这样的话,opendirclosedir就可以分别对应于构造函数和析构函数。readdir则作为成员函数。我们还可以根据C库提供的telldir()seekdir()两个函数添加相应的方法到类Dir中。

#include <dirent.h>
class Dir_offset;
class Dir {
public:
    Dir(const std::string& s):dp(opendir(s.c_str())) {}
    ~Dir() {
        if (dp != nullptr)
            closedir(dp);
    }
    Dir(const Dir&) = delete;
    Dir& operator=(const Dir&) = delete;
    bool read(struct dirent&);
    void seek(Dir_offset);
    Dir_offset tell() const;
private:
    DIR* dp;
};

class Dir_offset{
    friend class Dir;
private:
    long l;
    Dir_offset(long n) : l(n) {}
    operator long() { return l; } // 类型转换 
};

下面我们实现一下Dir未实现的接口。

bool Dir::read(struct dirent& d) {
    if (dp) {
        struct dirent* r  = readdir(dp) ;
        if (r != nullptr) {
            d = *r;
            return true;
        }
    }
    return false;
}
void Dir::seek(Dir_offset pos) {
    if (dp) {
         seekdir(dp, pos);
    }
}
Dir_offset Dir::tell() const {
    if (dp)
       return telldir(dp);
    return -1L;
}

总结

经过C++的封装,现在暴露在外面的名称从好多个库函数变成了三个类:Dir,Dir_offset,dirent。并且经过封装,我们将需要遵守的约定隐藏在了类定义中。例如:
如果想操作目录,我们需要一个Dir的对象,这个对象创建的时候一定会使用opendir函数的返回值赋值给自身的成员变量。该对象析构的时候一定会使用closedir对资源进行回收。调用read成员函数通过d = *r进行拷贝,用户也不再需要关心哪些操作会导致之前的赋值失效了。
通过类的封装,我们可以将通用的编程约定隐藏在类中,这样用户就只需要使用对象进行操作就行了。
数据抽象:如果对某个类对象的所有单个操作都将对象置于一种合理的状态,那么对象的状态就会始终保持合理。通过运用这个观念,我们可以将对象的状态变化同样封装在类中,这样我们的对象将一直处在合理的状态中(状态机)。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,110评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,443评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,474评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,881评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,902评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,698评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,418评论 3 419
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,332评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,796评论 1 316
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,968评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,110评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,792评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,455评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,003评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,130评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,348评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,047评论 2 355

推荐阅读更多精彩内容

  • 最近重新学习APUE,特开文章做学习笔记apue.h被我封装在all.h中,apue配置可以参见我的另一篇文章[C...
    MachinePlay阅读 346评论 0 0
  • 一、Linux系统概述 不加引号可理解为宏,直接替换,单引号中特殊字符会被解释为普通字符,双引号中$,,'还是特殊...
    赤果_b4a7阅读 1,510评论 0 2
  • 文件操作 (Linux文件操作)) [文件|目录] Linux文件操作:为了对文件和目录进程处理,你需要用到系统...
    JamesPeng阅读 1,473评论 1 5
  • ### main函数执行之前做了什么?(iOS) & dyld 是Apple 的动态链接器;在 xnu 内核为程...
    天使君阅读 690评论 0 1
  • UNIX基础知识 UNIX体系结构 登陆 文件和目录文件系统【1、目录是一个包含目录项的文件;2、根目录:所有东西...
    yuq329阅读 277评论 0 1