勘誤《C++ API設計》2.4.3節 一致性

《C++ API設計》是一本不錯的講解C++接口設計以及軟件工程的書籍,作者是前皮克斯架構師。值得一讀。本文是在咬文嚼字,并非質疑作者觀點。

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

2.4.3節 一致性

本節觀點沒有問題,就是闡述設計API時,要接口保持一致性,比如同一詞語的縮寫、相關函數中參數列表的順序等等。

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

另一個例子是,標準C函數read( )和write( )將文件描述符作為其第一個參數,而fgets( )和fputs( )函數把文件描述符作為最后一個參數(Henning,2009)。

錯誤一目了然:

  1. 首先read( )和write( )并非標準C函數,而是屬于Unix/Linux系統調用(system call)。出自POSIX標準,而非ANSI C
  2. 其次fgets( )和fputs( )函數的最后一個參數不是文件描述符,而是文件指針。

注意:fgets( )和fputs( )函數屬于ANSI C的標準庫函數,標準庫中的IO函數都是操縱的文件流指針(** FILE * **)而非文件描述符(file descriptor,實為整型)

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

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

然后我就說ACM官網檢索并下載了這篇論文,發現該論文原文其實是沒有異議的,原文該段落寫的不錯,整體摘錄如下:

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.)

關鍵的部分是我加粗顯示的部分。閱讀上下文可知,該處大意是說 “Unix 標準IO庫在很多地方違反了一致性原則。比如,系統調用read()和write()將文件描述符放置在第一個參數,而標準庫的函數,比如fgets()和fputs()等都是將流指針(即FILE *)放置在最后一個參數(除fscanf()和fprintf()以外)”

系統調用IO和標準庫IO有著不一致性,同時標準庫IO自身也存在著不一致性:fscanf()和fprintf()放置文件流指針在第一個參數位置,而其他標準庫IO的函數則是放置在最后一個位置上。

筆者:其實fscanf()和fprintf()這么設計,是為了保持和scanf()/printf()、sscanf()/sprintf()的一致性嘛。但是為什么不把整個標準C庫的文件流指針設計成第一個參數呢。。。


后記

多了解一些違反一致的例子,可以方便記憶整個庫的API。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,546評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,570評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,505評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,017評論 1 313
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,786評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,219評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,287評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,438評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,971評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,796評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,995評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,540評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,230評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,918評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,697評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374

推薦閱讀更多精彩內容