坏味道代码总结(简版)

文章目录

  • Code smells
  • Duplicated Code
  • Long Method
  • Large Class
  • Long Parameter List
  • Divergent Change
  • Shotgun Surgery
  • Feature Envy
  • Data Clumps
  • Primitive Obsession
  • Switch Statements
  • Parallel Inheritance Hierarchies
  • Lazy Class
  • Speculative Generality
  • Temporary Field
  • Message Chains
  • Middle Man
  • Inappropriate Intimacy
  • Alternative Classes with Different Interfaces
  • Incomplete Library Class
  • Data Class
  • Refused Bequest
  • Comments

本文总结转载、参考资料: 22种代码的坏味道,一句话概括

如果一段代码是不稳定或者有一些潜在问题的,那么代码往往会包含一些明显的痕迹。
正如食物要腐坏之前,经常会发出一些异味一样。
我们管这些痕迹叫做“代码异味”。

Code smells

Duplicated Code

(重复代码)难维护。

[解决方法]:提取公共函数。

Long Method

(函数长)难理解。

[解决方法]:拆分成若干函数。

Large Class

(类大)难理解。

[解决方法]:拆分成若干类。

Long Parameter List

(参数多)难用,难理解。

[解决方法]:将参数封装成结构或者类。

Divergent Change

(万能类)发散试修改,改好多需求,都会动他。

[解决方法]:拆,将总是一起变化的东西放在一块儿。

Shotgun Surgery

(天女散花的逻辑)散弹试修改,改某个需求的时候,要改很多类。

[解决方法]:将各个修改点,集中起来,抽象成一个新类。

Feature Envy

(红杏出墙的函数)使用了大量其他类的成员 

[解决方法]:将这个函数挪到那个类里面。

Data Clumps

(数据团)常一起出现的一坨数据。

[解决方法]:他们那么有基情,就在一起吧,给他们一个新的类。

Primitive Obsession

(偏爱基本类型)热衷于使用int, long, String等基本类型。

[解决方法]:反复出现的一组参数,有关联的多个数组换成类吧。

Switch Statements

(switch语句)

[解决方法]:state/strategy 或者只是简单的多态。

Parallel Inheritance Hierarchies

(平行继承)增加A类的子类ax,B类也需要相应的增加一个bx。

[解决方法]:应该有一个类是可以去掉继承关系的。

Lazy Class

(冗赘类)如果他不干活了,炒掉他吧。

[解决方法]:把这些不再重要的类里面的逻辑,合并到相关类,删掉旧的。

Speculative Generality

(夸夸其谈未来性)

[解决方法]:删掉

Temporary Field

(临时字段)仅在特定环境下使用的变量

[解决方法]:将这些临时变量集中到一个新类中管理。

Message Chains

(消息链)过度耦合的才是坏的。

[解决方法]:拆函数或者移动函数。

Middle Man

(中介)大部分都交给中介来处理了。

[解决方法]:用继承替代委托。

Inappropriate Intimacy

(太亲密)两个类彼此使用对方的私有的东西。

[解决方法]:划清界限拆散,或合并,或改成单项联系。

Alternative Classes with Different Interfaces

(相似的类,有不同接口)

[解决方法]:重命名,移动函数,或抽象子类。

Incomplete Library Class

(不完善的类库)

[解决方法]:包一层函数或包成新的类。

Data Class

(纯数据类)类很简单,仅有公共成员变量,或简单操作函数。

[解决方法]:将相关操作封装进去,减少public成员变量。

Refused Bequest

(继承过多)父类里面方法很多,子类只用有限几个。

[解决方法]:用代理替代继承关系。

Comments

(太多注释)这里指代码太难懂了,不得不用注释解释。

[解决方法]:避免用注释解释代码,而是说明代码的目的,背景等。好代码会说话。

你可能感兴趣的:(代码质量)