你代码的异味是故意的还是不小心?是故意的!

一、代码竟会有“气味”

食物在腐朽之际,会散发出异味,提示人食物现已坏掉了,需求处理。同样,假如代码中某处呈现了问题,也会有一些症状。这些症状,被称之为“代码异味”(Code smell,也译作“代码滋味”)。与食物腐败发出的滋味不同的是,代码异味并非真正的气味,而是一种“暗示”,暗示咱们代码或许有问题,提示程序员需求对项目规划进行更进一步的检查。

你代码的异味是故意的还是不小心?是故意的!

代码异味一词最初是由Kent Beck在协助Martin Fowler在编写《重构:改进既有代码的规划》一书时创造的。Martin Fowler对代码异味的界说是:代码异味是一种表象,它一般对应于系统中更深层次的问题。

代码异味的产生原因跟厨师的“清洗进程中故意保存”不一样,它更多地并非刻意为之,创造者也未必“品味”过自己所写的代码,它更多地是由于规划缺陷或不良编码习气而导致的不良代码症状。

这种异味也并非来自一种有据可查的规范,更多的是来自程序员的直觉。尤其是经历丰富和常识广博的程序员,他们无需考虑,只要经过检查代码或一段规划就能够立马对这个代码质量产生这种“感觉”,能对代码规划的优劣有一个大致的判别。这有点相似咱们英语学到一定程度后,即使不能彻底看懂文章,但凭借语感也能选出正确答案。

二、 代码异味的影响

关于代码异味的呈现咱们其实无需过度严重,由于在整个程序中代码异味是无处不在的。

一般状况下,有“异味”的代码也依旧能运行得很好。仅仅倘若重视不行,没有适当地保护或改进代码,代码质量就会下降,系统也会开端变得难以保护和扩展,同时也会添加技能债款。这就像做出有异味的九转大肠的的小胖厨师,在前期准备中对评委的主张置若罔闻,一意孤行,做出来的菜连自己都难以下咽。

所以团队应尽或许地做有质量的代码,削减乃至避免这些问题,产生高效益的效果。

三、 怎么辨别代码异味

你代码的异味是故意的还是不小心?是故意的!

代码是否存在代码异味,一般是靠程序员的片面判别,但由于语言、开发者、开发理论的不同,对代码异味的判别也会存在差异。

所以要想更精准地辨认代码异味,取得更高的代码质量,程序员需求许多的实践和经历。不过,前辈们总结的经历也能够让咱们少走一些弯路。Martin Fowler在《重构:改进既有代码的规划》一书中,列举了最常见的24种代码异味,能够协助咱们轻松辨认,便于处理和改进它们:

你代码的异味是故意的还是不小心?是故意的!

1) 过大的类(Large Class)

一个类包含许多字段、办法或许代码行,并逐渐变得臃肿。

2) 数据泥团(Data Clumps)

代码的不同部分包含了相同的变量组,且这些数据总是绑在一起呈现。

3) 过长参数列表(Long Parameter List)

指一个办法的参数超过了三个或四个。呈现这种状况一般是将几种类型的算法合并到一个办法之后。

4) 基本类型偏执(Primitive Obsession)

创立一个原始字段比创立一个全新的类要简单得多,所以关于具有意义的事务概念如钱、坐标、规模等,许多程序员不愿意进行建模,而是运用基本数据类型进行表明,从而导致代码内聚性差、可读性差。

5) 奥秘命名(Mysterious Name)

在编程中,命名是一件十分恼人的事情。一些或许只要自己看懂的命名,无疑加大了代码可读性的难度,有时乃至自己也会忘掉这些命名的意义。

6) 重复代码(Duplicated Code)

这几乎是最常见的异味。当多个程序员同时处理同一程序的不同部分时,一般会产生这种状况。

7) 过长的函数(Long Function)

依据Martin Fowler的经历,一般活得最长、最好的程序,其间的函数都比较短。函数越长,就越难理解。

8) 大局数据(Global Data)

这是一个十分可怕且冲鼻的异味代码。由于从代码库的任何一个旮旯都能够修正它,并且没有任何机制能够探测出到底是哪段代码做出了修正。大局数据造成一次又一次的诡异Bug,让咱们很难找出犯错的代码。

9) 可变数据(Mutable Data)

假如可变数据的变量的效果域越大, 越简单呈现问题。变量是能够更改的,但咱们或许不知道是哪里改动了它。

10) 发散式改动(Divergent Change)

是指一个类受到多种改动的影响。

11) 霰弹式修正(Shotgun Surgery)

是指一种改动引发多个类相应修正。

12) 依恋情结(Feature Envy)

一个类运用另一个类的内部字段和办法的数据多于它自己的数据。

你代码的异味是故意的还是不小心?是故意的!

13) 重复的switch(Repeated Switch)

在不同的地方重复运用switch逻辑。这带来的问题便是当咱们想要添加一个选择分支时,就必须找到一切的switch,并逐个更新。

14) 循环句子(Loops)

在编程语言中,循环一直是程序规划的中心要素。在《重构》中,Martin Fowler认为它是一种代码异味,由于他们觉得如今的循环现已有点过期了。他们提出“以管道替代循环”,这样能够协助咱们更快看清被处理的元素以及处理它们的动作。

15) 冗赘的元素(Lazy Element)

这是几乎无用的组件。咱们在规划代码时有时为了未来的功能规划出“准备”代码,但实际上从未完成;又或许这个类本来有用但随着重构,越来越小,最终只剩下一个函数。无论哪种,它们都是冗赘无用的。

16) 估测的通用性(Speculative Generality)

是指为了“以防万一”,支持预期的未来功能,但这些功能并未被完成,这些类、办法、字段或参数也从未被运用,成果导致代码变得难以理解和支持。

17) 暂时字段(Temporary Field)

创立暂时字段以用于需求许多输入的算法。但这些字段仅在算法中运用,其余时刻不运用。

18) 过长的音讯链(Message Chains)

当客户端恳求另一个目标,该目标又恳求另一个目标,依此类推时,就会呈现过长的音讯链。这些链意味着客户端依赖于类结构的导航。一旦产生更改,客户端也要跟着修正。

19) 中间人(Middle Man)

指一个类只履行一个动作,但将作业托付给另一个类,这种托付归于过度托付。该类也或许仅仅一个空壳,只负责托付且只要一件事。

20) 内情买卖(Insider Trading)

指模块之间许多地交流数据,添加模块之间的耦合。

21) 殊途同归的类(Alternative Classes with Different Interface)

是指两个类履行了相同的功能但具有不同的办法名称。

22) 纯数据类(Data Class)

指包含字段和拜访它们的粗略办法(getter 和 setter)的类。这些仅仅其他类运用的数据容器。这些类不包含任何附加功能,并且不能独立操作它们具有的数据。

23) 被回绝的遗赠(Refused Bequest)

指假如子类复用了超类的行为,但又不愿意支持超类的接口的状况。

24) 注释(Comments)

程序员将其作为一种“除臭剂”运用状况下的行为。比方:一段代码有着长长的注释,但这段长注释的存在是由于代码很糟糕。

四、 怎么对代码“除臭”

你代码的异味是故意的还是不小心?是故意的!

1)重构

上述代码异味没有优先级一说,所以关于程序员而言,只能依托直觉和经历去决议是否需求重构。

重构,一言以蔽之,便是在不改动外部行为的前提下,有条不紊地改进代码。是完成敏捷性的最重要的技能要素之一。是程序员依据已辨认出的气味然后将代码分红更小的部分的进程,再决议要么删去它们,要么用更好的代码替换它们,如此循环重复这个进程,直到异味消失,这样或许会进步代码质量并让代码变得更具简单性、灵活性和可理解性。

2)运用代码检测工具

你代码的异味是故意的还是不小心?是故意的!

辨认和消除代码异味是一个令人厌烦且不确定的进程,并且也不或许手动查找到和删去掉一切异味,尤其是面对一个有着上千行异味的代码的时分。所以运用一些代码检测工具能够辅助咱们进行快速许多地检查,协助咱们节省时刻来做更为重要的作业,比方能专注于代码高层面的规划原则问题。

好了,关于代码异味的常识,算是讲了个清楚,那么让咱们相约下一次代码评定吧!

你代码的异味是故意的还是不小心?是故意的!