http://hi.baidu.com/diboo19/blog/item/1cdfb789ff5ec7b70f244443.html
Code Smell中文译名一般为“代码异味”,或“代码味道”,它是提示代码中某个地方存在错误的一个暗示,开发人员可以通过这种smell(异味)在代码中追捕到问题。
在计算机编程社区中,code smell代表了任何标志着事物变坏的征兆。它常常标志代码应该被refactored或者全部的设计都应该被reviewed。这个短语出现在WardsWiki上,它是被Kent Beck杜撰出来的。在refactoring兴起之后,这个短语的使用率骤增。
判断是否存在code smell经常是主观判断,并且随着语言、开发者、开发理论的不同而存在差异。
经验丰富和知识渊博的开发人员通过对优秀设计有一种“感觉”,他们已经达到一种称之为“无意识能力(UnconsciousCompetence)”的状态。也就是说,他们无需思考,只要通过查看代码或一段设计就可以立马对这个项目的代码质量有一种“感觉”,能够对代码设计的优劣有一个大致的判断。
但大家需要注意,code smell只是一种“暗示”,而非一种“确定”。将某些事物称之为“code smell”并未是一种攻击;它只是一种提示:开发人员需要对项目设计进行更进一步的查看。因此,code smell更多是“直觉的,本能的”。
code smell一般包括:
1.Duplicated Code
代码重复几乎是最常见的异味了。他也是Refactoring 的主要目标之一。代码重复往往来自于copy-and-paste 的编程风格。与他相对应OAOO 是一个好系统的重要标志。
2.Long method
它是传统结构化的“遗毒”。一个方法应当具有自我独立的意图,不要把几个意图放在一起,我的《大类和长方法》一文中有详细描述。
3.Large Class
大类就是你把太多的责任交给了一个类。这里的规则是One Class One。
4.Divergent Change
一个类里面的内容变化率不同。某些状态一个小时变一次,某些则几个月一年才变一次;某些状态因为这方面的原因发生变化,而另一些则因为其他方面的原因变一次。面向对象的抽象就是把相对不变的和相对变化相隔离。把问题变化的一方面和另一方面相隔离。这使得这些相对不变的可以重用。问题变化的每个方面都可以单独重用。这种相异变化的共存使得重用非常困难。
5.Shotgun Surgery
这正好和上面相反。对系统一个地方的改变涉及到其他许多地方的相关改变。这些变化率和变化内容相似的状态和行为通常应当放在同一个类中。
6.Feature Envy
对象的目的就是封装状态以及与这些状态紧密相关的行为。如果一个类的方法频繁用get 方法存取其他类的状态进行计算,那么你要考虑把行为移到涉及状态数目最多的那个类。
7.Data Clumps
某些数据通常像孩子一样成群玩耍:一起出现在很多类的成员变量中,一起出现在许多方法的参数中……,这些数据或许应该自己独立形成对象。
8.Primitive Obsession
面向对象的新手通常习惯使用几个原始类型的数据来表示一个概念。譬如对于范围,他们会使用两个数字。对于Money,他们会用一个浮点数来表示。因为你没有使用对象来表达问题中存在的概念,这使得代码变的难以理解,解决问题的难度大大增加。好的习惯是扩充语言所能提供原始类型,用小对象来表示范围、金额、转化率、邮政编码等等。
9.Switch Statement
基于常量的开关语句是OO 的大敌,你应当把他变为子类、state 或strategy。
10. Parallel Inheritance Hierarchies
并行的继承层次是shotgun surgery 的特殊情况。因为当你改变一个层次中的某一个类时,你必须同时改变另外一个层次的并行子类。
11. Lazy Class
一个干活不多的类。类的维护需要额外的开销,如果一个类承担了太少的责任,应当消除它。
12. Speculative Generality
一个类实现了从未用到的功能和通用性。通常这样的类或方法唯一的用户是test case。不要犹豫,删除它。
13. Temporary Field
一个对象的属性可能只在某些情况下才有意义。这样的代码将难以理解。专门建立一个对象来持有这样的孤儿属性,把只和他相关的行为移到该类。最常见的是一个特定的算法需要某些只有该算法才有用的变量。
14. Message Chain
消息链发生于当一个客户向一个对象要求另一个对象,然后客户又向这另一对象要求另一个对象,再向这另一个对象要求另一个对象,如此如此。这时,你需要隐藏分派。
15. Middle Man
对象的基本特性之一就是封装,而你经常会通过分派去实现封装。但是这一步不能走得太远,如果你发现一个类接口的一大半方法都在做分派,你可能需要移去这个中间人。
16. Inappropriate Intimacy
某些类相互之间太亲密,它们花费了太多的时间去砖研别人的私有部分。对人类而言,我们也许不应该太假正经,但我们应当让自己的类严格遵守禁欲主义。
17. Alternative Classes with Different Interfaces
做相同事情的方法有不同的函数signature,一致把它们往类层次上移,直至协议一致。
18. Incomplete Library Class
要建立一个好的类库非常困难。我们大量的程序工作都基于类库实现。然而,如此广泛而又相异的目标对库构建者提出了苛刻的要求。库构建者也不是万能的。有时候我们会发现库类无法实现我们需要的功能。而直接对库类的修改有非常困难。这时候就需要用各种手段进行Refactoring。
19. Data Class
对象包括状态和行为。如果一个类只有状态没有行为,那么肯定有什么地方出问题了。
20. Refused Bequest
超类传下来很多行为和状态,而子类只是用了其中的很小一部分。这通常意味着你的类层次有问题。
21. Comments
经常觉得要写很多注释表示你的代码难以理解。如果这种感觉太多,表示你需要Refactoring。
分享到:
相关推荐
自动代码气味检测器自动代码气味检测器是IntelliJ IDEA插件,致力于自动检测和纠正Java代码中的代码气味。下载及安装可以按照以下步骤直接在IntelliJ IDEA中下载该插件: 按Ctrl + Alt + S或选择文件| 设置(适用于...
代码味道重构练习 此存储库中的每个分支都有给定语言的练习。 原始源材料(在java分支中)是来自(C) Jason Gorman。 有关 TDD 和重构代码异味,请查看。
检测JavaScript类的内聚耦合Code Smell.pdf
code_smell_extractor_ci 代码气味提取器在github上的项目安装要做Git: : PMD: : 系统开发Linux运行程序您必须在linux上,并且必须修改src / main / java / utilities / Utility.java中的变量: PATH_PMD =“ [您...
这是一个Visual Studio Code扩展,用于检测python代码中的不安全编码做法。 这些不安全的编码做法也称为安全气味。 这些气味可能为软件系统的利用留出空间,并导致安全漏洞。 为了帮助从业者,已经开发了此工具以在...
detekt ...Meet detekt, a static code analysis tool for the Kotlin programming language. It operates on the abstract syntax tree provided by the Kotlin compiler. ...Code Smell baseline and igno
这个项目是一个基于Java的检测器,可以检测Fowler等人的五个。 (1999) 的代码不良气味:数据块、开关语句、推测一般性、消息链和中间人,来自 Java 源代码。
代码气味 该存储库演示了常见的代码气味,以及每种工具如何帮助消除它们。 ESLint ESLint可以找到甚至解决许多JavaScript问题。 要显示警告和错误: yarn eslint examples/0-lint-errors.js 要自动修复某些问题...
论文《A Textual-based Technique for Smell Detection》pdf全
to detect the "smell" of bad code, readers get to the heart of the book, its catalog of over 70 "refactorings"--tips for better and simpler class design. Each tip is illustrated with "before" and ...
分享了气味剂算法源代码及其原文,更多算法可进入空间查看
【智能优化算法-气味代理优化算法】基于气味代理优化算法求解单目标优化问题附matlab代码(SAO,Smell Agent Optimization)标准.zip
1.版本:matlab2014/2019a/2021a ...3.代码特点:参数化编程、参数可方便更改、代码编程思路清晰、注释明细。 4.适用对象:计算机,电子信息工程、数学等专业的大学生课程设计、期末大作业和毕业设计。
SonarQube的代码气味插件的Code Smells插件使开发人员可以手动(即在代码审查期间)报告SonarQube未发现的问题,但在评估项目的技术债务时应考虑这些问题。 如果您需要更多信息,请阅读,并查看插件允许您报告的的...
fluent udf 多孔介质模型,用来解决多孔介质模拟的模型建立
沪教版一年级英语下册(牛津版) Unit 3 Taste and smell 第1课时 教案 教学设计 .pdf
学习气味-入门套件 :flexed_biceps: 挑战页面: : :speaking_head: 讨论论坛: : :trophy: 页首横幅: : :laptop: 安装git clone ... 这将为您提供类似于以下内容的文件夹结构: .├── data│ ├── test.csv│ ...
长剑“B'smell” 3D 模型(低多边形)/ 免费低多边形长剑“B'smell”模型。。低多边形 模型全部展开并被贴上纹理,可用的纹理格式为 PNG,包括 1k、2k 和 4k 版本。纹理、材料和网格都有适当的名称。模型已完全贴上...
该软件包定义了严格的eslint配置,以防止代码异味并促进可维护的编码实践。 它结合了eslint,typescript-eslint,unicorn和sonarjs的推荐设置,并进一步启用了更多规则。 安装 在安装之前,请确保您的项目有eslint...
程序员常刷题 ##1。 源代码布局 使用UTF-8作为源文件编码。 每个缩进级别使用两个空格,没有制表符。 不留下任何类型的尾随空格。 不要在文件底部留空行。...smell ######################################