开发中要尽量避免联合接口0506

这里的联合接口指的是,用两个或者多个简单接口联合使用就很容易做的事情,非要定义成一个接口来一次做完。这里先写两个例子。

例子1,有两个接口,exist判断一个文件是否存在,delete删除一个文件。开发人员希望先判断一个文件是否存在,如果存在就删掉,可以用下面的代码来做

if (exist(f)==true){
delete(f);
}

此时团队当中可能有人提出新增一个联合接口,比如说if_exist_then_delete。

例子2,有一个接口,replace将字符串中部分内容进行替换。开发人员希望连续替换,先把aa替换成bb,再把99替换成00,可以用下面的代码来做

replace(str,"aa","bb");
replace(str,"99","00");

此时团队当中可能有人提出新增一个联合接口,比如说replace_and_replace。

单个员工自己开发的模块当中,将常见的代码组合,合并成一个内部使用的函数,避免某个代码片段重复出现,提高代码整洁度,这是非常正常的事情,但是如果再两个模块之间的接口处也出现这种联合接口,那就是重要的质量问题,需要及时制止,一旦发现需要立即改正。

含义明确,简单直接的接口,从某些场景看可能稍微差点意思,但是它更容易应对大多数场景。好的接口设计应该是一组工具,单个看,每个都很简单,组合起来使用,又能做很多事情,可以支持很多场景。比如说电工手里面的工具箱,各种型号的扳手,螺丝,锤子,锯片。

联合接口本质上就是把复杂的使用接口的逻辑放在了接口定义中,随着时间推移,这样的接口既不好理解,也不好维护。一旦出现当时没有想到的场景,引发了故障,接口的实现者和使用者就会大大扯皮,互相指责对方对接口的理解有误。

从项目管理的角度上来讲,复杂的组合接口,并不是接口的实现者者闲着无聊,自作自受,更多是接口的使用者,出于自己少写代码,强势的逼迫出来的。这种工作风气也要制止。

提出新加联合接口的员工的理由一般不会是直白的说自己想少些几行代码,更多的是以效率为由,新接口可以减少调用次数,可以方便对方优化效率等等。效率优化是一个非常大的领域,但是不到万不得已,没有必要采用联合接口的方式来提高效率。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,219评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,363评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,933评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,020评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,400评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,640评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,896评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,597评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,327评论 1 244
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,581评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,072评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,399评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,054评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,849评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,672评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,585评论 2 270

推荐阅读更多精彩内容