好代码的七个先--磨刀不误砍柴工

聊完了好代码的三个标准,接下来,我们就开始从这三个标准出发,看看我们如何修炼“好代码”这门手艺。看起来写出来的代码都完成了同样的功能,但是,为什么高手写出来的代码效率和质量就会更高呢?因为高手的做事方式不一样,高手会在想清楚之后再来写代码。下面,我们就来聊聊好代码的七个先。

什么是七个先,就是七个先于实际写代码的事情,想清楚再来写代码,就能提升写代码的效率和质量。看似这样做浪费了时间,但是,磨刀不误砍柴工,这样做反而效率和质量最高。

先来看第一个先,需求先于设计。很多时候,我们还没有完全吃透需求的时候,就开始编写代码。这时候,往往编写的过程中我们才发现问题,再去修改,甚至到系统上线才发现,只能下一个版本才能修复。整体来看,这样的效率和质量都不高,所以,吃透需求应该是第一个要做的事情。

第二个先,设计先于开发。吃透了需求,马上就可以进入开发吗?也不是,因为除了业务提的功能性需求之外,我们还有一些非功能性需求要额外关注。哪些是非功能性需求呢?比如系统的性能、可用性以及可扩展性。以性能为例,我们需要预估一下有多少用户会并发访问,不同的用户数,系统的设计就是不一样的。非功能需求就要求我们要做好架构的设计。

第三个先,模块先于接口。搞定了设计,可以写代码了吗?还是不行,还得需要看一下,哪些接口是可以复用的,哪些功能可以放到一个模块里。这有点类比于我们收拾行李,用途类似的物品可以放到一起,这样收纳起来比较方便,使用的时候也方便拿取。其实这就是一种归类,人的大脑能同时记住的信息数是有限的,通过归类就可以降低我们记忆和理解的难度,让事情变得可控。

第四个先,接口先于逻辑。搞定了模块划分,就可以写代码了吗?还是不行,写代码之前还得需要先确定接口边界,程序开发是一个多工种配合的团队作战,接口就是大家的边界和合作方式,不把这个事情弄清楚,大家就没法高效的并行工作。

第五个先,注释先于代码。尤其是复杂的业务逻辑或者抽象的算法实现,最好要先通过文字形式把事情说清楚再来写代码。一方面,这是一个梳理自己思路的过程,另一方面,也能方便后期维护的同事,让他可以快速理解代码的背景。

第六个先,算法先于实现。不一样的算法,效率的差异是巨大的,所以,在写具体实现之前,要想清楚采用哪些算法,分别的优缺点是什么,算法就是时间与空间的平衡艺术。

第七个先,自测先于交付。完成了编码,我们一定要在交付给合作方之前先进行自测,Bug发现的越晚,解决他所花费的代价就越大。举个例子,如果我们在客户端功能测试的才发现的问题,每个功能都需要调用多个接口来实现,复现和定位问题都需要花掉额外的时间,还得需要多方配合才可以。所以,尽量把问题扼杀在萌芽阶段。

磨刀不误砍柴工,做事的方式不一样,带来的效率和质量就会不一样。道理很简单,但是做起来很难,很多时候,我们会因为时间的紧张,行动就会变形。就像优秀的运动员,高手在技术水平都一样的情况下,比的是谁犯的错误更少,谁的表现更稳定和高效。下面,我们会分为七个章节,具体给大家拆解这七个先应该如何做。

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

推荐阅读更多精彩内容