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

德国育儿经验:家长需要和儿童谈论”空气动力学“吗?

家长应当和儿童,尤其是低龄儿童谈论“空气动力学”吗? 我的答案曾经是非常肯定的:不应当。不要说儿童,就是成年人也不见得理解这些抽象的概念,与儿童谈论这些名词,只会让人望而生畏。身为父母,我们应当做的是,以孩子能理解的、感兴趣的方式谈论相关的具体问题,但绝对不要提这些大词。 不过世界的奇妙就在于,父母对教育并没有绝对的权威,总是需要根据实际情况来修正自己的观点。在“空气动力学”的问题上,我就吃到了教训。 那是一个下午,家里小朋友在iPad上看完他最喜欢的Blippi(这个节目我之前介绍过,对80后父母来说,Blippi可以理解为“带你见识各种新鲜玩意的董浩叔叔”),忽然抬起头来问我:“爸爸,你知道什么是aerodynamics吗?” “什么?你问我知不知道什么是aerodynamics?”我的下巴都要掉下来了。“空气动力学”这种词还是上中学时,身为军迷的我们在《航空知识》上知道的。再往后英语好一些,能看原版科普视频了,才知道“空气动力学”的原文就是aerodynamics。可是,我家这个还没上小学的家伙,竟然就能真诚地瞪大眼睛,一本正经地问我“知不知道什么是aerodynamics”。 (more…)

3 months ago

忆孟繁超老师:他从来没有给我上过一堂正式的课,但我永远都是他的学生。

我本来是不应该认识孟老师的。 2001年,我在寝室夜谈里第一次听到孟老师的名字。当时有同学说“公共选修课的《法学概论》讲得真好,那个老师叫孟繁超”,开始我不怎么在意,慢慢才发现这么说的人还不少。那个年月网上的资料正丰富,出版管制也不那么严格,刚进大学不久的我正自由自在地看得过瘾,心想“大学里的法学概论讲再好,能讲些什么,还不是教科书上老一套”,所以这种课,不听也罢。 但生活就在这么奇妙。那年冬天,有天中午我吃过饭正准备午睡,忽然有人敲门问“计算机系有位叫余晟的同学在这里吗?” 大中午的谁会来找我?我正好奇这个问题,门一推开就有同学喊“孟老师,孟老师来了”。 那是我第一次见到孟老师,中年人,国字脸,身材高大,打扮很精神,披在身后的深色大衣让我一下子想起电影里的斗篷。他笑眯眯地说“你是余晟?听同学说你搞电脑很厉害,我家的电脑坏了,想请你去看看。” (more…)

3 months ago

“历史照进现实”,这似乎不太现实

中国人大概都对历史有一些特别的偏好。对我们普通人来说,历史首先是文化的象征,一个人“懂历史”,基本等于这个人“有文化”;历史也是民族自豪感的来源,哪怕考古上仍然存在争议,但是“五千年文明”的说法是普通人都耳熟能详的。 不过等我长大之后才发现,这种偏好大概还有更深层次的原因,那就是历史看起来有种道德的意味,因为我们从小就熟悉“以史为鉴”的智慧,也熟悉各种“历史的选择”:每当我们对现实感到失望、困惑的时候,我们经常去历史——而不是先贤的智慧中——中寻找解答。找到曾经发生的类似的故事,就可以预言未来的结局。 于是乎,失望也好、困惑也罢,总归会有光明的未来,历史总会给我们支撑的信念。 我曾经很相信,熟谙历史是种智慧,而且是深层次的智慧。但是看得越多、经历得越多,我就越觉得,这很难称之为“智慧”。 为什么? (more…)

3 months ago

无人出租车,是技术进步的一粒灰,还是普通人头上的一座山?

“无人出租车要来了”。以百度“萝卜快跑”为代表的无人出租车,眼看就要在国内多个城市成规模运营。 熟悉IT的人都知道,IT的独特优势就在于“大规模扩展时边际成本极低”。在软件时代,微软开发的Windows,多卖一份的成本只是多刻录一张光盘而已。在无人驾驶时代,从10辆车到10万辆车的成本,也遵循同样的规律。换句话说,一旦模式“跑通”了,就可以迅速大规模铺开。无人出租车的大规模应用,也是“指日可待”了。 只不过,新技术这一次似乎没有那么激动人心,反而引起了很多争议——无人驾驶出租车大规模推广,会不会影响广大出租车、网约车车主的收入甚至生计?如果是,这样的技术进步,真的是我们所需要、所期待的吗?对于这个问题,不同的人有相差迥异的答案。 按照我的观察,许多人对此是相当乐观的。理由在于,“技术的每一次飞跃发展,虽然有阵痛,最终都创造了更多的新岗位”。既如此,无人出租车短期“看似”抢了许多人的饭碗,但也只是短期的“阵痛”而已。看看历史,纺织机的发明,蒸汽机的改良,汽车的诞生,无不证明了“阵痛说”的正确性。 坦白说,这种观点我是怀疑的。 (more…)

3 months ago

回国感受:松弛一点,愉快一点

因为小朋友放暑假,近期带小朋友回国待了几个礼拜。最深的感受就是标题所说的:松弛一点,愉快一点。 我第一次突出意识到这点,是在上海下飞机乘地铁。当时我们乘的直梯就要关门,远远看见有个年轻小伙子跑过来,我连忙按住开门按钮,并招呼他”别着急,慢慢来“,等他进了轿厢才关门。本来我以为大家起码会打个招呼,露个笑脸,因为我已经习惯如此,但完全出乎我意料的是,他进来之后对我们完全视若不见,自顾自掏出手机,盯着看得入迷。 我继而发现,不管是在电梯里,站台上,还是车厢里,虽然四下里都是广播”请扶好站稳,抓好扶手,不要看手机“,但是似乎人人都盯着自己的手机。年轻人在打手机游戏,年纪大一点的在滑各种小视频,还有不少人在聊天软件里打字如飞……对着屏幕的表情都很生动,可是一旦抬起头来,似乎马上又换了个人。 后来又有一次,我乘地铁的时候,因为比较拥挤,一个小伙子倒退时踩了我一脚,他大概意识到了,很快把脚挪开,脸上闪过一丝不安,马上又恢复正常,我也没有计较。不幸的是,过了十来分钟,他又踩了我一脚,同样是先有一点不安,很快又恢复正常。 这次我忍不了了,于是我开口告诉他:“小伙子,你已经踩了我两脚了。” (more…)

3 months ago

First name, last name, middle name,浅谈外国人名

前几天,国内朋友发来一条消息,原来是乌克兰F-16坠落,飞行员丧生的新闻。我本来以为他要讨论此事的真假和原委,他真正的问题却完全出乎我的意料: 新闻里说,飞行员叫阿列克谢·“月鱼”·梅斯,对应原文是Alexei “Moonfish” Mes,为什么会有人把“月鱼”写在自己的名字里,而且还打引号。 之前看新闻,乌克兰还有一个著名的飞行员叫安德烈·“果汁”·皮尔希科夫(Andrii “Juice” Pishchykov),怎么“果汁”也是正式的名字? 未必Moonfish和Juice之类,还有什么特别的含义吗?…… 这堆问题看的我有点想笑,因为自己以前也很苦恼外国人的名字,只有在国外长期生活,才逐渐搞清楚这其中的名堂。所以,除了解答朋友的问题,我也把自己的解释写下来,搞清楚两个最不容易理解的点,就不会对外国人名有那么多问题了。 (more…)

3 months ago