勘误《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阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容