Categories: Yurii谈开发

迷失自我的API

本文由Yurii原创,转载请注明来源: Life Sailor

本文链接 迷失自我的API


说起API,做开发的人大概都知道也用过,我也是如此。不过除去使用,我还亲眼目睹过API制定,参与搭建过开放API平台,也与合作方商量确定过API方案;算是各个方面都有了解和经历,感受过让人啧啧称奇的赞赏,也经历过举步维艰的尴尬。目睹还有很多同行在API的泥泞里挣扎,我把自己的经验写在这里与大家分享。

大家都知道,API是Application Program Interface,也就是应用程序接口,看起来非常容易理解,实际却并非如此。据我观察,不少API方案之所以陷入了泥潭,就是程序员对API理解错误,把它看成了“对外开放的函数”:某个动作可能之前需要用户鼠标点击触发,现在开个口子给程序用消息触发,这就是API了;推广开来,现在流行的API化、开放平台的潮流,无非是多开一些这样的口子而已。

据我观察,相当多的程序员是这样理解API的。这种理解不能叫错,却往往造成严重的后果。因为它的关注点更侧重“应用程序(Application Program)”,而不是“接口(Interface)”,而两者是有很大差别的:应用程序是一种具体的实现,说到应用程序往往想到的是代码,它是具体、容易理解的;而接口是对抽象行为的封装,说到接口,往往想到的是某个动作,是虚拟、不那么好理解的。此外,接口还蕴含了“解耦合”的意义:应用程序往往是知根知底的“内部人交易”,出了问题也很好变通解决,接口却要暴露给未知的外部世界,只能依靠相对固定的规范加以约束。更重要的是,接口往往会影响甚至塑造外部调用方对系统的认知,在调用方看来,系统对外提供了几个接口,可能就只有几个环节(或几个方面)。如果对接口的理解不到位,开发出来的API往往是残缺的,根据接口(Interface)的首字母I在英语中的意思,我把这类API称为“迷失自我的API”。

举个真实的例子,我们常见的表单填写功能,为了保证用户体验,往往会把整个填写分为几步依次进行。相应的,后台有方法对应每一步的处理。为了提供API,程序员直接把后台每一步的处理包装暴露出来,而没有想到应当“填写表单”是逻辑意义完整独立的操作,之前拆分开来只是为了保证直接交互的体验,结果客户端应用程序在调用时,也不得不把整张表单拆开了分次调用,这样的API既没有效率又没有准确性。

再举个例子,在某个界面上客户可以选择确定的服务,原有系统里表示服务的是枚举类型,因为都是项目内部调用,所以没有问题。提供API时,程序员直接把这些参数和类型通过WSDL暴露出去,初期用起来一切正常,不久就问题丛生:因为服务的种类经常随业务变化,枚举类型本身也会变化,内部更新并不是大问题,客户调用起来则痛苦不堪,哪怕服务的值没有变化,也必须重新编译。

以上两例,都可归类为迷失自我的API,因为都是对接口的理解不到位:第一例是没有设定合适的粒度,第二例是没有设定信息隔离的合理边界。在实际开发中,这样的例子还有很多,结果都是浪费了大量的人力物力(让API调用方跳起脚来大骂的情况也屡见不鲜)。根据我的思考,要避免这类情况,可以从以下几方面采取措施。

第一,要重视API,抽调最好的开发人员负责API。在许多团队里,开发API被视作脏活累活,交给开发能力一般甚至比较弱的人员去开发,这一点是要严格杜绝的。API的设计和开发是一项要求很高的工作,如前文所说,负责人员要理解每个API对应的逻辑意义以便合理划分粒度,还需要根据实际情况进行合理的隔离。更重要的,相对普通的函数调用,API的调试和报错都需要精心设计。我见过很多程序员随便应付错误处理甚至干脆一股脑扔给虚拟机,这种水平去设计API只会让调用方欲哭无泪,最终还可能搬起石头砸自己的脚。如果抽调了最好的开发人员负责API,哪怕内部暂时逊色一点,稍后也可以改过来,这个道理反过来则不成立——用优雅接口包装起来的龌龊实现,通常强过龌龊接口包装起来的优雅实现。

第二,自己开发的API要自己调用。软件开发行业有句话叫“吃自己的狗粮”,意思是自己做的程序自己用,才能真正知道自己做的如何,API也是如此。难用的API通常有个共同特点,就是开发API的人自己是不用的,对他们来说纯粹是摆设,所以他们无法设身处地评判API的好坏,发现有问题也没有动力去改善,即便有压力去改善,也往往难以找到合适的切入点,向合适的方向推进。实际上,目前很多项目已经实现了内部API化,自己调用自己的API已经是必须的选择,这时候开放API也变得易如反掌。我相信这是一种好的架构方式,值得推广开来。

第三,API是有章可循的,借鉴现成的成功经验会少走很多弯路。API的设计和开发虽然是一项要求很高的工作,但经验并不是要求的全部;目前已经有了很多论述API的文档资料,涵盖了从实现到架构的各个方面;业界也有许多公认的规范优秀的API,很多领域都可以找到API的榜样(FourSquare、Twitter、Facebook,都是很好的样板)。如果能多加学习,多加思考,甚至稍加思索直接照搬,都会比自己盲目设计开发要好很多(国内的一些直接照搬国外的API至少像个样子,许多“自主设计”的反而非常糟糕)。

说句玩笑话,API没有了I,就“迷失了自我”。正是众多迷失自我的所谓“API”,给广大程序员造成了无穷无尽的困扰。我衷心希望这种境况能早日得到解决。

Yurii

View Comments

  • 从RPC到REST的风格变化,也是一种思考方式的变化,强迫自己以“对外开放资源”的方式思考API,会有很多好处。

    反之,不自觉的回到Function Call的思路,难免会出问题。

    • 老庄你怎么总是能几句话点到问题的实质?这样看来我废话一堆呀……

Recent Posts

德国生活点滴:歧视比你想象的要复杂(续)

在上一篇文章里,我列举了一些种族歧视现象的亲身经历,引发了许多读者的讨论。但是让我略感遗憾的是,许多人大概没有注意文章的标题,没有觉察到关键是“比想象的要复杂”,所以直接给出了一个简单的论断。 我的本意绝不是强化已有的简单粗疏的刻板印象,而是希望让大家知道,种族歧视这回事,有许多的侧面和细节。了解这些侧面和细节,有助于我们形成更立体的认知。 于是就有了下面这些内容,希望能引发大家的思考。 一 种族歧视是一种最简单粗暴的歧视。 许多人都知道,“歧视”的英文是discriminate,准确的意思是“区别对待”。既然要区别对待,就自然首先必须有办法区分。目力所及,似乎没有人愿意“区别对待”与自己完全同样的人,而总是要先找出一点区别来,再实行区别对待。 所以,种族、口音、家庭出身、经济能力等等各种因素,都可以成为“区别”的指标,由此催生出区别对待。在这些因素当中,种族大概是最容易识别的特征——判断口音需要等对方开口,家庭出身、经济能力等等因素就更是要全面接触才可能了解。唯有种族,具体来说,绝大多数时候是相貌和肤色,是可以远远一眼就望见的。 也恰恰是因为这个原因,种族歧视特别容易引起反感。 这些年来,我得到的一条重要的生活经验是,如果你希望指出对方的问题,但又不纯粹是为了激怒对方,那么最好不要归因为一些木已成舟,对方无法改变的因素,否则对方多半会恼羞成怒。 举个例子,你觉得某人的口语表达还可以更好一点,完全可以直接给出具体的建议。但是如果从“经济不发达地区来的人就是口语差”,或者“个子矮的人就是没自信心来表达”,那几乎一定会制造矛盾。因为“口语表达”是可以改进的,加以锻炼将来肯定更好,而“不发达地区来的人”和“个子矮的人”就像烙印一样,是无法摆脱的。这种话说出来,对方哪怕有意愿改进,也会觉得无奈甚至恼怒。 种族歧视也是这样,“种族”同样是一种烙印,是无法摆脱的。所以当对某些人的判断与种族挂钩的时候,他或她必然感到无奈甚至愤怒。况且老话说“人上一百,形形色色;人上一万,千奇百怪”。哪怕是同一个种族的人,也可能在肤色、相貌之外完全找不到相同点。先入为主地用种族去对其他人下判断,无论是从情感反应上,还是从逻辑上,都是站不住脚的。 (more…)

5 days ago

德国生活点滴:歧视比你想象的要复杂

去年初的时候,小朋友冰球俱乐部来了个新教练Robo。Robo来自加拿大,总是一副很健谈很乐观的样子,而且很喜欢放音乐,把整个训练场搞得热情四射。最关键的是,小朋友们好像都很喜欢他,不但许多动作耐心示范,对每个人的指导也相当到位。而且,他的英语很好,人又很喜欢开玩笑,所以我们交谈很多,他总是跟我说:“你家的小朋友超级酷的,不要给他太大压力,只要他自己运动起来足够自在,能够持续练下去,就是最好的。” 没想到的是,到去年9月份,Robo忽然神秘失踪了,没有任何征兆,也没有任何说明,就此人间蒸发了一般。问其他的教练,也是语焉不详。小朋友训练完,偶尔会失落地跟我说“好久没看到Robo了,不知道他哪里去了。” 3月份的时候,一个偶然的机会,我又见到了Robo,虽然当时时间很紧张,只是打了个照面,但我要他留下了联系方式。 当天晚上我问他:哥们,你怎么忽然就不见了,大家都很想你啊。 过会儿我收到他的回复:我也很想念小孩子们,你儿子很酷……我现在没在那个俱乐部了,因为其他几个教练总是或明或暗地针对我,仅仅因为我的肤色,这是我受不了的。 (more…)

5 days ago

在德国, 全远程+共享空间办公,是什么体验?

注:原文发布于2023年1月16日 到1月份为止,我已经体验了几个月的全远程+共享空间办公了。有不少朋友听说之后很有兴趣,问我到底是什么感觉,所以我简单介绍下个人的体验。 背景 2019年末、2020年初开始在全球流行的Covid-19对远程办公来说,绝对是黑天鹅一般的存在。因为疫情导致的社交隔离措施,极大影响了各大公司的正常运转。 所幸,IT类公司受到的影响比较小,只要求员工“面对屏幕编程”,不必亲临现场。所以,许多IT公司也谨小慎微地开展了远程办公的试验。 从我所知道的结果来看,不少美国公司并不特别喜欢远程办公,比如Google,一旦社交隔离措施有所放松,就忙不迭要求员工回到办公室,盖因为公司认为远程办公严重影响合作效率。 与此相反,不少德国公司反倒是逐渐适应了远程办公的节奏,纷纷降低对员工“到办公室上班”的要求,许多公司甚至可以支持百分百的远程办公。 这里要提到的是,德国公司说的“远程办公”往往是货真价实的“远程”,而不是一些人理解的“家和办公室在同一个城市,只是不用去办公室”而已。 因为德国IT行业缺人严重,而且许多德国公司并没有那么“互联网”,而是依托实业开展业务,所以据我所知,目前不少公司非但没有裁员,反而都在大力招人。 (more…)

4 weeks ago

成年人找工作,不值得那么多愁善感

注:本文发布于2023年2月6日 最近硅谷几大公司都在裁员,看了些报道,被裁的员工真是不好过。损失经济来源不说,有些人还面临身份问题,这可真是屋漏偏逢连夜雨。 我也留意到,不少被裁的人会不停追问自己:为什么我会遇到这样的事情?为什么这样的不幸会降临到我头上?…… 实话说,我挺能理解这种态度。这挫折如此巨大,似乎又来得全无预兆,不由得让人对命运、对人生、对世界产生深重的怀疑。尤其是对已经走入社会,取得一定成就(如果非要抠字眼,那就用“进展”吧)的人来说,更是如此。 但是我更想说,如果被裁员了,当务之急是赶紧找到下一份工作,哪怕只是机械地行动。要知道,成年人找工作,容不下那么多愁善感。 我之所以这么说,是有切身经历为基础的。之前我讲过找德国工作的经历。最开始是信心十足的,因为虽然毕业多年,手艺没丢,基础还在,随时打开leetcode,中等难度题目基本都不在话下,不但能解对,解法也基本接近最优。既然网上都说“刷题就能找到工作”,估计自己应该没大问题。 没想到真的找起工作来,仍然充满了意想不到的挫折。如果不相信,我且举几个例子吧。 (more…)

4 weeks ago

我读《园丁与木匠》

虽然早就听说《园丁与木匠》是关于育儿的好书,但一直没开始读。最近终于翻开这本书,才发现属于“拿起就很难放下”的类型,加班加点读完,收获不少。 关于这本书的价值,已经有许多书评讨论过了,所以我想略过微言大义、长篇大论的叙述,谈谈我印象最深,也是最打动我的三点细节。 第一,儿童的学习方式 小孩子觉得拧螺丝很好玩,想自己动手拧一颗螺丝。于是,他打开了工具箱,对着琳琅满目的工具,他不知所措。一会儿摸摸钳子,一会儿试试扳手……这时候,旁边的父母应当怎么办? 在大多数情况下,父母大概会直接告诉孩子,“亲爱的,你应该用螺丝刀,来,我告诉你”。耐心一点的父母,大概会潜心观察一段孩子的举动,再设法“引导”他到正确的工具上来。在父母眼里,孩子当然不可能一开始就找对正确答案,所以做各种尝试也是情有可原。但是另一方面,也不应该“在错误的路径上摸索太久,浪费时间”,应当“迅速识别出正确的答案”。 无论父母有多少耐心,在他们眼里,孩子找到拧螺丝的工具的过程,都是个“不断接近正确答案”的过程。这个过程越短,孩子就越“聪明”,或者说“学习效率”就越高。 (more…)

4 weeks ago

再见,或许就是再也不见

陈皓(Haoel,网名“左耳朵耗子”)上周六因为突发心梗去世了,享年47岁。 我跟他虽然聊过好些次,但只是微信好友,从未见过面。回看微信记录,当年稀松平常的一声“再见”,已经成了“再也不见”。 许多人在缅怀他,许多文章提到他的时候,会用到“骨灰级程序员”、“技术大牛”这样的称呼。但如果仅仅用这两个词描述他,断然难以解释,为什么他的突然去世,会引发互联网上怀念的狂潮。 所以,我更愿意按照自己的经验,把他描绘为“有坦诚追求,兼具趣味、操守、胸怀的技术人”。恰恰是因为这样的人在这个年代太稀少,而这些品质又让众多人赏识和受益,大家才会如此地怀念他。 这个年代,做技术(仅指狭义的IT)的人很多,愿意分享的人也不在少数,其中不少还可以算世俗意义上的“成功者”。 但是,若仔细去看他们分享的内容,总感觉不够真诚。总感觉作者希望往高深了靠,目的也没有那么纯粹。你若提一些小白问题,迎来的往往是“你怎么连这都不知道?”的反问,或者“要谈这个问题,你先去看几本书再说吧”。话是这么说没错,但无数的初学者也往往因此打了退堂鼓。 但是陈皓的分享不同。我已经不止一次地看到有人提起,他分享——更准确说,是“创作”——的内容质量很高,而且总能做到“深入浅出”。哪怕是小白读者,看完也确实能有收获,如果还有兴趣,更可以跟着文末的链接,顺藤摸瓜探究更广阔的世界。 这让我想起我佩服的一位记者说的:记者写文章的最高境界,就是不表达自己的观点,因为记者的观点应当来自于他的素材。只要把这些素材摆出来,读者读完报道,观点就自然形成了。要做到这一点,需要对素材有足够的信心和把握,外加真诚和坦荡。 能做到这一点的记者,着实不多。陈皓虽然不是记者,他写的技术文章却能让读者得到类似的结论——要知道,技术讨论往往是非常容易擦枪走火的——可见他运用素材和逻辑的功力,以及更重要的,他的真诚和坦荡。 (more…)

4 weeks ago