一個庫接口設計實例

這篇我們將從一個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*類型的變量,這個變量在后續(xù)的所有操作中都有出現踱卵,例如:readdir(dp),closedir(dp)瓤漏。這個變量dp充當了一種神奇的cookies,即:它使得庫函數知道具體操作的是那個目錄颊埃。
這個看似非常普通的程序,卻包含了一些隱含的約定蝶俱。首先看看我們可以針對這個例子提出哪些問題班利。

復雜的問題

  • 如果傳給opendir的字符串指定了一個不存在的目錄會怎樣?按照我們習慣榨呆,opendir應該是返回了一個空指針罗标。這樣可以方便用戶進行檢測。但是這樣就有了下面的問題积蜻。
  • 如果readdir()接受了一個空指針的DIR*會怎樣闯割?這里可能有兩種情況:1. readdir直接使用了這個空指針,那么將導致coredump竿拆。2. readdir進行了某些檢查宙拉,并進行了對應的處理。如果是第二種情況丙笋,又會導致下面的問題谢澈。
  • 如果readdir()接受的參數既不是空指針,又不是opendir()的返回值會發(fā)生什么御板?這種錯誤很難被發(fā)現锥忿。因為readdir()幾乎沒有辦法檢查傳入參數是否為合法值。針對readdir()的返回值怠肋,也有下面的問題敬鬓。
  • readdir()返回的結果,什么時候釋放掉申請的內存呢笙各?如果發(fā)生下面的情況:
d1 = readdir(dp);
d2 = readdir(dp);
printf("%s\n", d1->d_name);

這個時候d1還是有效的嗎钉答?為了解決這個問題,我們還需要弄清楚哪些操作會導致d1失效酪惭,以及我們應該怎么使用這些庫函數希痴。

上面的分析可以得出,我們在使用C庫函數的時候春感,已經遵守了一些隱含的約定砌创。下面我們來看看虏缸,使用C++重新進行封裝會不會減輕用戶的負擔。將這些約定通過數據抽象隱藏起來嫩实。

優(yōu)化接口

首先我們針對這個DIR神奇的cookies進行優(yōu)化刽辙,我們將它修改為一個類。這樣的話甲献,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的對象筹陵,這個對象創(chuàng)建的時候一定會使用opendir函數的返回值賦值給自身的成員變量。該對象析構的時候一定會使用closedir對資源進行回收镊尺。調用read成員函數通過d = *r進行拷貝朦佩,用戶也不再需要關心哪些操作會導致之前的賦值失效了。
通過類的封裝庐氮,我們可以將通用的編程約定隱藏在類中语稠,這樣用戶就只需要使用對象進行操作就行了。
數據抽象:如果對某個類對象的所有單個操作都將對象置于一種合理的狀態(tài)旭愧,那么對象的狀態(tài)就會始終保持合理颅筋。通過運用這個觀念,我們可以將對象的狀態(tài)變化同樣封裝在類中输枯,這樣我們的對象將一直處在合理的狀態(tài)中(狀態(tài)機)议泵。

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市桃熄,隨后出現的幾起案子先口,更是在濱河造成了極大的恐慌,老刑警劉巖瞳收,帶你破解...
    沈念sama閱讀 218,036評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件碉京,死亡現場離奇詭異,居然都是意外死亡螟深,警方通過查閱死者的電腦和手機谐宙,發(fā)現死者居然都...
    沈念sama閱讀 93,046評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來界弧,“玉大人凡蜻,你說我怎么就攤上這事搭综。” “怎么了划栓?”我有些...
    開封第一講書人閱讀 164,411評論 0 354
  • 文/不壞的土叔 我叫張陵兑巾,是天一觀的道長。 經常有香客問我忠荞,道長蒋歌,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,622評論 1 293
  • 正文 為了忘掉前任委煤,我火速辦了婚禮堂油,結果婚禮上,老公的妹妹穿的比我還像新娘碧绞。我一直安慰自己称诗,他們只是感情好,可當我...
    茶點故事閱讀 67,661評論 6 392
  • 文/花漫 我一把揭開白布头遭。 她就那樣靜靜地躺著,像睡著了一般癣诱。 火紅的嫁衣襯著肌膚如雪计维。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,521評論 1 304
  • 那天撕予,我揣著相機與錄音鲫惶,去河邊找鬼。 笑死实抡,一個胖子當著我的面吹牛欠母,可吹牛的內容都是我干的。 我是一名探鬼主播吆寨,決...
    沈念sama閱讀 40,288評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼赏淌,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了啄清?” 一聲冷哼從身側響起六水,我...
    開封第一講書人閱讀 39,200評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎辣卒,沒想到半個月后掷贾,有當地人在樹林里發(fā)現了一具尸體,經...
    沈念sama閱讀 45,644評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡荣茫,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,837評論 3 336
  • 正文 我和宋清朗相戀三年想帅,在試婚紗的時候發(fā)現自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片啡莉。...
    茶點故事閱讀 39,953評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡港准,死狀恐怖旨剥,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情叉趣,我是刑警寧澤泞边,帶...
    沈念sama閱讀 35,673評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站疗杉,受9級特大地震影響阵谚,放射性物質發(fā)生泄漏。R本人自食惡果不足惜烟具,卻給世界環(huán)境...
    茶點故事閱讀 41,281評論 3 329
  • 文/蒙蒙 一梢什、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧朝聋,春花似錦嗡午、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,889評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至言蛇,卻和暖如春僻他,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背腊尚。 一陣腳步聲響...
    開封第一講書人閱讀 33,011評論 1 269
  • 我被黑心中介騙來泰國打工吨拗, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人婿斥。 一個月前我還...
    沈念sama閱讀 48,119評論 3 370
  • 正文 我出身青樓劝篷,卻偏偏與公主長得像,于是被迫代替她去往敵國和親民宿。 傳聞我的和親對象是個殘疾皇子娇妓,可洞房花燭夜當晚...
    茶點故事閱讀 44,901評論 2 355

推薦閱讀更多精彩內容

  • 最近重新學習APUE,特開文章做學習筆記apue.h被我封裝在all.h中活鹰,apue配置可以參見我的另一篇文章[C...
    MachinePlay閱讀 346評論 0 0
  • 一峡蟋、Linux系統概述 不加引號可理解為宏,直接替換华望,單引號中特殊字符會被解釋為普通字符蕊蝗,雙引號中$,,'還是特殊...
    赤果_b4a7閱讀 1,506評論 0 2
  • 文件操作 (Linux文件操作)) [文件|目錄] Linux文件操作:為了對文件和目錄進程處理,你需要用到系統...
    JamesPeng閱讀 1,467評論 1 5
  • ### main函數執(zhí)行之前做了什么?(iOS) & dyld 是Apple 的動態(tài)鏈接器赖舟;在 xnu 內核為程...
    天使君閱讀 688評論 0 1
  • UNIX基礎知識 UNIX體系結構 登陸 文件和目錄文件系統【1蓬戚、目錄是一個包含目錄項的文件;2宾抓、根目錄:所有東西...
    yuq329閱讀 276評論 0 1