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。
分享到:
相关推荐
在软件开发中,"代码味道"(Code Smell)是指那些表明代码可能存在潜在问题的特征或模式。这些不一定是错误,但它们可能会降低代码的可读性、可维护性和效率,因此需要进行重构。"code-smell-refactoring"项目是一个...
味的定义可以看出,代码异味(Code Smell)是软件开发中的一种不良编程习惯或设计问题,它降低了软件的可读性、可维护性和可靠性。Fowler 提出了22种常见的代码异味,包括数据类、大类、长方法、特征依恋等。针对...
自动代码气味检测器自动代码气味检测器是IntelliJ IDEA插件,致力于自动检测和纠正Java代码中的代码气味。下载及安装可以按照以下步骤直接在IntelliJ IDEA中下载该插件: 按Ctrl + Alt + S或选择文件| 设置(适用于...
SonarQube是一款强大的静态代码分析工具,用于检测软件中的bug、漏洞和异味(Code Smell)。通过分析项目源代码,SonarQube能够帮助开发者找出潜在的问题,并提供修复建议,以提高代码质量和可维护性。以下是...
TACO(Textual Analysis for Code Smell Detection)是一种新颖的技术,它采用文本分析手段来检测不同性质和不同粒度级别的代码异味。研究人员在10个开源项目上运行了TACO,并将其性能与仅基于代码组件结构信息的...
CodePro Analytix不仅限于生成测试类,它还提供了多种代码分析工具,能够对代码进行静态分析,找出潜在的bug、代码异味(code smell)和性能问题。这些功能有助于提高代码质量,减少维护成本。例如,插件可以检查未...
这是一个Visual Studio Code扩展,用于检测python代码中的不安全编码做法。 这些不安全的编码做法也称为安全气味。 这些气味可能为软件系统的利用留出空间,并导致安全漏洞。 为了帮助从业者,已经开发了此工具以在...
1. **代码异味(Code Smell)**:代码异味是软件开发中的一个术语,表示代码可能存在潜在问题,如冗余代码、复杂逻辑、过度耦合等。D2Smells工具通过分析源代码来检测这些现象,以提升代码的可读性和可维护性。 2. ...
通过定期进行代码统计和分析,可以发现潜在的代码异味(code smell),并及时进行重构,以保持代码的可读性和可维护性。 总之,QT代码统计器是QT开发环境中一个实用的辅助工具,它通过提供详细的代码统计信息,帮助...
4. **代码异味(Code Smell)**:书中提出了“代码异味”的概念,指的是那些表明代码可能存在问题的迹象,如过长的函数、重复的代码、复杂的条件表达式等。识别并消除这些异味是重构过程的关键部分。 5. **自动化...
马丁·福勒指出,重构不应只在代码出现问题时才进行,而应在日常开发中持续进行,以防止代码异味(Code Smell)积累。他还讨论了如何说服团队成员接受重构,以及如何在项目管理中考虑到重构的时间和成本。 总之,...
重构的主要目标是消除代码异味(Code Smell),这些异味可能是冗余代码、复杂的条件逻辑、重复的代码块或者是难以理解的命名。通过识别并解决这些问题,重构有助于提高代码的可读性和可维护性,使得团队协作更加高效...
SonarQube服务器负责接收和处理来自SonarScanner的数据,生成详细的报告,显示代码质量指标,包括代码复杂性、重复代码、潜在的bug、代码异味(code smell)等。同时,它也提供了强大的权限管理、项目管理和报告功能...
3. **代码异味(Code Smell)与代码卫生**:"Code Smell"是指代码中可能隐藏问题的迹象。`if`语句链在`dayOfYear()`函数中就是一个例子,这表明代码可能需要重构。代码卫生指的是保持代码的整洁和可读性,避免冗余和...
10. **代码质量管理**:统计源代码量也是代码质量管理的一部分,可以用来评估代码复杂度,找出潜在的代码异味(code smell),并进行重构,以提高代码质量和可维护性。 以上就是关于“统计源代码量源码”程序的一些...
5. **代码质量**:检查代码是否遵循编码规范,是否存在潜在的代码异味(Code Smell)或已知的错误模式,这些都可以影响代码的价值。 6. **单元测试**:评估代码的测试覆盖率,高覆盖率通常意味着更好的软件质量。 ...
Sonar是一款强大的静态代码分析工具,它能够帮助开发者发现代码中的潜在问题,如bug、代码异味(code smell)以及安全漏洞等。通过Sonar的使用,开发者可以在编码阶段就能对代码质量进行把控,从而提高软件的整体...
6. 代码异味(Code Smell):书中提到了许多代码异味,它们是代码质量下降的信号,如重复代码、过长方法、过大的类等。识别并消除这些异味是重构的重要任务。 7. 团队协作与重构:在团队开发中,重构需要与其他开发...
它可以帮助开发者发现潜在的错误、代码异味(code smell)、冗余以及不符合编程规范的部分。K8标签可能是指Kubernetes的缩写,这是一个流行的容器编排系统,用于管理云原生应用的部署和运行。 本文将深入探讨代码...
6. **代码异味(Code Smell)**:代码异味是指代码中可能存在问题或需要改进的迹象。识别并消除这些异味是重构工作的起点,如过长的函数、重复代码、复杂的条件表达式等。 7. **设计模式与重构**:设计模式是解决...