俊超说 | DRY,不要重复你自己

系统中的每一项知识都必须具有单一、无歧义、权威的表示。

                                               --- DRY原则


黑牛和白牛有一天,一位记者来到了一块牧场,看见了一位农夫在喂牛。记者便上去搭讪道:“请问您每天给你的牛喂些什么呢?” 农夫说:“你问的是黑牛还是白牛?” 
记者:“黑牛”
农夫:“玉米和小麦” 
记者:“那白牛呢?” 
农夫:“玉米和小麦” 
记者有点迷糊了... 记者又问:“您每天给它们喂多少斤啊?” 
农夫:“你问的是黑牛还是白牛?” 
记者:“黑牛” 
农夫:“5斤”
记者:“那白牛呢?” 
农夫:“5斤”
记者有点不耐烦,便质疑的问道:“为什么同样的答案你却偏偏要让问我两次?” 
农夫淡淡地说道:“因为黑牛是我的” 
记者:“那白牛呢?”
农夫:“也是我的”

《伏尔加河上的纤夫》 俄国批判现实主义画家 伊里亚·叶菲莫维奇·列宾 1870年-1873年

本期“黑牛和白牛”的故事做启发,一起聊聊软件工程中重复的问题。无论你承不承认,在你所在的项目中也或多或少存在重复的痕迹。作为程序员,我们每天都在不停的进行着项目功能开发迭代,这个过程中伴随着环境的变化,也需要对原有的逻辑进行维护或增强特性。

当我们维护时,我们不得不找到并改变应用中的知识表示-那些嵌在系统中的代码逻辑块。问题是,在我们开发的规范、过程和程序中很容易重复表述知识。这个时候就是我们之前说的“破窗”,也就是重复的开始。
 那么重复是怎么发生的呢?我们列举以下几点和相关建议:1. 强加的重复(imposed duplication)。    这种情况往往是系统中我们没有更好的选择-环境似乎要求重复。
    a.重复的代码结构:可以使用过滤器或者代码生成器,减少重复的工作内容。
    b.代码中的文档:要把低级的知识放在代码中,它属于那里。把注释保留给高级的说明。
    c.文档与代码:考虑使用工具,同步代码和文档的同步。如接口文档工具swagger。2. 无意的重复(imnadvertent duplication)。    那些我们在开发中没有意识到的重复信息。    可能是在无意的设计中造成的。比如经常会要用缓存的方式来避免一些繁琐的操作时。这时候要我们要做的是使影响局部化,不要把重复暴露给外界。
3. 无耐性的重复(impatient duplication)。    ctrl+V,ctrl+C. 这个熟悉的操作,这样的开发节奏似乎更快些。    每个项目都有时间压力,这也是我们走捷径的内在驱动。相同逻辑的代码拷贝后做些改动。然后跑通逻辑。搞定!(这样真的可以吗?)。有时候“欲速则不达”,这个时候需要把一些细节明确,以避免一个小小的失误然后回来在找bug用多半个小时。
4. 开发者之间的重复(interdveloper duplication)。    同一团队或者不同团队中开发的时候重复了相同的信息,功能模块,方法或逻辑等。    最不好察觉和维护的重复就是开发者之间的重复。这个重复是从整个功能开始的,会给后期维护或者升级带来较大的难度。

那“知其所以然”后,我们能有哪些避免重复的方法呢?

1. 定期进行代码review。 把公用类和方法定期优化同步 ,减少重复造轮子。

2. 团队协作之间主动交流。对已经有类似的方法先考虑是否可以重用。

3. 沉淀公共知识的统一管理和同步。比如像之前我在启明星辰做的通用知识文档。


简而言之,目标就是“在系统中避免重复造轮子,让复用变得容易”。


草莓时刻:

1. 在你所在的团队项目代码中,找下存在哪种重复的情况并试着做点改变。

2. 和团队中的小伙伴相互代码review.(开放心态目的是学习和成长)。


俊超说,每天说点程序员的事。

欢迎留言交流。

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

推荐阅读更多精彩内容