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

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

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

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

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

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

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

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

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

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

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

推荐阅读更多精彩内容