勘誤《C++ API設(shè)計(jì)》2.4.3節(jié) 一致性

《C++ API設(shè)計(jì)》是一本不錯(cuò)的講解C++接口設(shè)計(jì)以及軟件工程的書籍,作者是前皮克斯架構(gòu)師。值得一讀城舞。本文是在咬文嚼字,并非質(zhì)疑作者觀點(diǎn)寞酿。

書名 API C++Design for C++
中譯本 《C++ API設(shè)計(jì)》
出版社 人民郵電出版社
版次 2013年9月第1版

2.4.3節(jié) 一致性

本節(jié)觀點(diǎn)沒有問題家夺,就是闡述設(shè)計(jì)API時(shí),要接口保持一致性伐弹,比如同一詞語的縮寫拉馋、相關(guān)函數(shù)中參數(shù)列表的順序等等。

第37頁(中譯版)有一小段文字列舉了一些違背API設(shè)計(jì)一致性的案例

另一個(gè)例子是,標(biāo)準(zhǔn)C函數(shù)read( )和write( )將文件描述符作為其第一個(gè)參數(shù)煌茴,而fgets( )和fputs( )函數(shù)把文件描述符作為最后一個(gè)參數(shù)(Henning随闺,2009)。

錯(cuò)誤一目了然:

  1. 首先read( )和write( )并非標(biāo)準(zhǔn)C函數(shù)蔓腐,而是屬于Unix/Linux系統(tǒng)調(diào)用(system call)矩乐。出自POSIX標(biāo)準(zhǔn),而非ANSI C回论;
  2. 其次fgets( )和fputs( )函數(shù)的最后一個(gè)參數(shù)不是文件描述符绰精,而是文件指針。

注意:fgets( )和fputs( )函數(shù)屬于ANSI C的標(biāo)準(zhǔn)庫(kù)函數(shù)透葛,標(biāo)準(zhǔn)庫(kù)中的IO函數(shù)都是操縱的文件流指針(** FILE * **)而非文件描述符(file descriptor笨使,實(shí)為整型)

原文給出了參考文獻(xiàn)(Henning,2009)僚害,通過查閱附錄硫椰,我找到這篇論文的信息:

M. Henning, API Design Matters, Commun. ACM 52 (5) (2009) 46-56

然后我就說ACM官網(wǎng)檢索并下載了這篇論文,發(fā)現(xiàn)該論文原文其實(shí)是沒有異議的萨蚕,原文該段落寫的不錯(cuò)靶草,整體摘錄如下:

Consistency is important because not only does it make things easier to use and memorize, but it also enables transference of learning: having learned a part of an API, the caller also has learned much of the remainder of the API and so experiences minimal friction. Transference is important not only within APIs but also across APIs—the more concepts APIs can adopt from each other,the easier it becomes to master all of them. (The Unix standard I/O library violates this idea in a number of places. For example, the read() and write() system calls place the file descriptor first, but the standard library I/O calls, such as fgets() and fputs(), place the stream pointer last, except for fscanf() and fprintf(), which place it first.This lack of parallelism is jarring to many people.)

關(guān)鍵的部分是我加粗顯示的部分蓖柔。閱讀上下文可知卦碾,該處大意是說 “Unix 標(biāo)準(zhǔn)IO庫(kù)在很多地方違反了一致性原則鳍咱。比如逻族,系統(tǒng)調(diào)用read()和write()將文件描述符放置在第一個(gè)參數(shù),而標(biāo)準(zhǔn)庫(kù)的函數(shù)础钠,比如fgets()和fputs()等都是將流指針(即FILE *)放置在最后一個(gè)參數(shù)(除fscanf()和fprintf()以外)”

系統(tǒng)調(diào)用IO和標(biāo)準(zhǔn)庫(kù)IO有著不一致性排监,同時(shí)標(biāo)準(zhǔn)庫(kù)IO自身也存在著不一致性:fscanf()和fprintf()放置文件流指針在第一個(gè)參數(shù)位置仇奶,而其他標(biāo)準(zhǔn)庫(kù)IO的函數(shù)則是放置在最后一個(gè)位置上捻艳。

筆者:其實(shí)fscanf()和fprintf()這么設(shè)計(jì)驾窟,是為了保持和scanf()/printf()、sscanf()/sprintf()的一致性嘛认轨。但是為什么不把整個(gè)標(biāo)準(zhǔn)C庫(kù)的文件流指針設(shè)計(jì)成第一個(gè)參數(shù)呢绅络。。嘁字。


后記

多了解一些違反一致的例子恩急,可以方便記憶整個(gè)庫(kù)的API。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末纪蜒,一起剝皮案震驚了整個(gè)濱河市衷恭,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌霍掺,老刑警劉巖匾荆,帶你破解...
    沈念sama閱讀 222,627評(píng)論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異杆烁,居然都是意外死亡牙丽,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,180評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門兔魂,熙熙樓的掌柜王于貴愁眉苦臉地迎上來烤芦,“玉大人,你說我怎么就攤上這事析校」孤蓿” “怎么了?”我有些...
    開封第一講書人閱讀 169,346評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵智玻,是天一觀的道長(zhǎng)遂唧。 經(jīng)常有香客問我,道長(zhǎng)吊奢,這世上最難降的妖魔是什么盖彭? 我笑而不...
    開封第一講書人閱讀 60,097評(píng)論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮页滚,結(jié)果婚禮上召边,老公的妹妹穿的比我還像新娘。我一直安慰自己裹驰,他們只是感情好隧熙,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,100評(píng)論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著幻林,像睡著了一般贞盯。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上沪饺,一...
    開封第一講書人閱讀 52,696評(píng)論 1 312
  • 那天邻悬,我揣著相機(jī)與錄音,去河邊找鬼随闽。 笑死父丰,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的掘宪。 我是一名探鬼主播蛾扇,決...
    沈念sama閱讀 41,165評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼魏滚!你這毒婦竟也來了镀首?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 40,108評(píng)論 0 277
  • 序言:老撾萬榮一對(duì)情侶失蹤鼠次,失蹤者是張志新(化名)和其女友劉穎更哄,沒想到半個(gè)月后芋齿,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,646評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡成翩,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,709評(píng)論 3 342
  • 正文 我和宋清朗相戀三年觅捆,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片麻敌。...
    茶點(diǎn)故事閱讀 40,861評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡栅炒,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出术羔,到底是詐尸還是另有隱情赢赊,我是刑警寧澤,帶...
    沈念sama閱讀 36,527評(píng)論 5 351
  • 正文 年R本政府宣布级历,位于F島的核電站释移,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏寥殖。R本人自食惡果不足惜秀鞭,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,196評(píng)論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望扛禽。 院中可真熱鬧锋边,春花似錦、人聲如沸编曼。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,698評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽掐场。三九已至往扔,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間熊户,已是汗流浹背萍膛。 一陣腳步聲響...
    開封第一講書人閱讀 33,804評(píng)論 1 274
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留嚷堡,地道東北人蝗罗。 一個(gè)月前我還...
    沈念sama閱讀 49,287評(píng)論 3 379
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像蝌戒,于是被迫代替她去往敵國(guó)和親串塑。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,860評(píng)論 2 361

推薦閱讀更多精彩內(nèi)容