代码重构技巧

重构| 2018-01-25

本文整理于《重构改善既有代码的设计》，这本书是用java写的，整理的目的是为了自己能写出更健壮、更具扩展性的代码，为以后的编码做参考。转自余真帆的博客

重构技巧

任何不会被修改的变量都可以当做参数传入新的函数；一个变量会被修改可以把它当做返回值。

重构方法-重新组织函数

Extract Method（提炼函数）

将这段代码放进一个独立地函数中，并让函数名称解释该函数的用途。
包装函数的粒度小，复用的几率就大。
适用于：为一些代码提供一个清晰的函数名。
函数命名：以它“做什么”来命名，而不是以它“怎么做”命名。

Inline Method（内联函数）

在函数调用点插入函数本体，然后移除该函数。
适用于：原函数内部代码清晰易读，不需要提炼为一个单独的函数。

Inline Temp（内联临时变量）

将所有对该变量的引用动作，替换为对它赋值的哪个表达式自身。
适用于：只使用了一次，或许可以移除该临时变量。

Replace Temp with Query（以查询取代临时变量）

将这个表达式提炼到一个独立函数中。将这个临时变量的所有引用点替换为对新函数的调用。此后，新函数就可以被其它函数使用。
适用于：由于临时变量作用域只在函数内部，如果把临时变量替换为一个查询，那么同一个类中的所有函数都可以获取这份信息。

Introduce Explaining Variable（引入解释性变量）

将该复杂表达式（或其中一部分）的结果放进一个临时变量，以此变量名称来解释表达式用途。
适用于：用一个命名清晰的变量来代替难以理解的代码或函数。

Split Temporary Variable（分解临时变量）

针对每次赋值，创造一个独立、对应的临时变量（再多一个临时变量）。
适用于：你的程序有某个临时变量被赋值超过一次，它即不是循环变量，而不被用于收集计算结果。

Remove Assignments to Parameters（移除对参数的赋值）

以一个临时变量取代该参数的位置。
适用于：用一个临时变量（有意义的名字）保存参数。

Replace Method with Method Object（以函数对象取代函数）

将这个函数放进一个单独对象中，如此一来局部变量就成了对象内的字段。
然后你可以在同一个对象中将这个大型函数分解为多个小型函数。
适用于：你有一个大型函数，其中对局部变量的使用使你无法采用Extract Method。

Substitute Algorithm（替换算法）

将函数本体代替为另一个算法。
适用于：你想要把某个算法替换为另一个更加清晰的算法。

重构方法-在对象之间搬移特性

Move Method（搬移函数）

在该函数最常引用的类中建立一个有着类似行为的新函数。
将旧函数编程一个单纯的委托函数，或是将旧函数完全移除。
适用于：一个类有太多行为，或一个类与另一个类有太多合作而形成高度耦合。

Move Field（搬移字段）

在目标类新建一个字段，修改源字段的所有用户，令它们改用新字段。
适用于：对于一个字段，在其所驻类之外的另一个类中有更多函数使用了它。

Extract Class（提炼类）

建立一个新类，将相关的字段和函数从旧类搬移到新类。
适用于：某个类做了应该由两个类做的事。

Inline Class（将类内联化）

将这个类的所有特性搬移到另一个类中，然后移除原类。
适用于：某个类没有做太多事情。

Hide Delegate（隐藏“委托关系”）

在服务类上建立客户所需的所有函数，用以隐藏委托关系。
适用于：客户通过一个委托类来调用另一个对象。

Remove Middle Man（移除中间人）

让客户直接调用受托类。
适用于：某个类做了过多的简单委托动作。

Introduce Foreign Method（引入外加函数）

在客户类中建立一个函数，并以第一参数形式传入一个服务类实例。
适用于：你需要为提供服务的类添加一个函数，但你无法修改这个类。
外加函数终归是权益之计，尽量将其搬移到服务类中去（Introduce Local Extension）。

Introduce Local Extension（引入本地扩展）

建立一个新类，使它包含这些额外函数。让这个扩展品成为源类的子类或包装类。
适用于：你需要为服务类提供一些额外函数，但你无法修改这个类。

重构方法-重新组织数据

Self Encapsulate Field（自封装字段）

为这个字段建立取值/设置函数，并且只以这些函数来访问字段。
适用于：你直接访问一个字段，但与字段之间的耦合关系逐渐变得笨拙。

Replace Data Value with Object（以对象取代数据值）

将数据项变成对象。
适用于：你有一个数据项，需要与其他数据和行为一起使用才有意义。

Change Value to Reference（将值对象改为引用对象）

将这个值对象变成引用对象。
适用于：你从一个类衍生出许多彼此相等的实例，希望将它们替换为同一个对象。

Change Reference to Value（将引用对象改为值对象）

将它变成一个值对象。
适用于：你有一个引用对象，很小且不可该表，而且不易管理。

Replace Array with Object（以对象取代数组）

以对象替换数组。对于数组中的每个元素，以一个字段来表示。
适用于：你有一个数组，其中的元素各自代表不同的东西。

Duplicate Observed Data（复制“被监视数据”）

将该数据复制到一个领域对象中。建立一个Observer模式，用以同步领域对象和GUI对象内的重复数据。
MVC模型

Change Unidirectional Association to Bidirectional（将单向关联改为双向关联）

添加一个反向指针，并使修改函数能够同时更新两条连接。
适用于：两个类都需要使用对方特性，但其间只有一条单向连接。

Change Bidirectional Association to Unidirectional（将双向关联改为单向关联）

去除不必要的关联。
适用于：两个类之间有双向关联，但其中一个类如今不需要另一个类的特性。

Replace Magic Number with Symbolic Constant（以字面常量取代魔法数）

创造一个常量，根据其意义为它命名，并将上述的字面量替换为这个常量。
适用于：你有一个字面数值，带上特别含义。

Encapsulate Field（封装字段）

将它声明为private，并提供相应的访问函数get和set。
适用于：你的类中存在一个public字段。

Encapsulate Collection（封装集合）

让这个函数返回集合的一个只读副本，并在这个类中提供添加/移除集合元素的函数。
适用于：有一个函数返回一个集合。

Replace Record with Data Class（以数据类取代记录）

为该记录创建一个“哑”数据对象。
适用于：你需要面对传统编程环境中的记录结构。

Replace Type Code with Class（以类取代类型码）

以一个新的类替换该数值类型码。
适用于：类之中有一个数值类型码，但它并不影响类的行为。

Replace Type Code with Subclasses（以子类取代类型码）

以自带取代这个类型码（多态）。
适用于：你有一个不可变的类型码，它会影响类的行为。

Replace Type Code with State/Strategy（以State/Strategy取代类型码）

以状态对象取代类型码。
适用于：你有一个类型码，它会影响类的行为，但你无法通过继承手法消除它。

Replace Subclass with Fields（以字段取代子类）

修改这些函数，使它们返回超类中的某个（新增）字段，然后销毁子类。
适用于：你的各个子类的唯一差别只在“返回常量数据”的函数身上。

重构方法-简化条件表达式

Decompose Conditional（分解条件表达式）

从if、then、else三个段落中分别提炼出独立函数。
适用于：你有一个复杂的条件（if-then-else）语句。

Consolidate Conditional Expression（合并条件表达式）

将这些测试合并为一个条件表达式，并将这个表达式提炼成一个独立的函数。
适用于：你有一系列条件测试，都得到相同结果。

Consilidate Duplicate Conditional Fragments（合并重复的条件片段）

将这个端重复代码搬移到条件表达式之外。
适用于：在条件表达式的每个分支上有着相同的一段代码。

Remove Control Flag（移除控制标记）

以break语句或return语句取代控制标记。
适用于：在一系列布尔表达式中，某个变量带有“控制标记”（control flag）的作用。

Replace Nested Conditional with Guard Clauses（以卫语句取代嵌套条件表达式）

使用卫语句表现所有特殊情况（尽量不要转换成嵌套）。
适用于：函数中的条件逻辑使人难以看清正常的执行路径。

Replace Conditional with Polymorphism（以多态取代条件表达式）

将这个条件表达式的每个分支放进一个子类内的覆写函数中，然后将原始函数声明为抽象函数。
适用于：你手上有个条件表达式，它根据对象类型的不同而选择不同的行为。

Introduce Null Object（引入Null对象）

将null值替换为null对象。
适用于：你需要再三检查对象是否为null。

Introduce Assertion（引入断言）

以断言明确表现这种假设。
适用于：某一段代码需要对程序状态做出某种假设。

重构方法-简化函数调用

Rename Method（函数改名）

修改函数的名称。
适用于：函数的名称未能解释函数的用途。
函数命名，参考“做什么”而不是“怎么做”。

Add Parameter（添加参数）

为此函数添加一个对象参数，让该对象带进函数所需信息。
适用于：某个函数需要从调用端得到更对信息。
这样做有一个好处，不用关心参数的位置。

Remove Parameter（移除参数）

将该参数去除。
适用于：函数本体不再需要某个参数。

Separate Query from Modifier（将查询函数和修改函数分离）

建立两个不同的函数，其中一个负责查询，另一个负责修改。
适用于：某个函数既返回对象状态值，又修改对象状态。

Parameterize Method（令函数携带参数）

建立单一函数，以参数表达那些不同的值。
适用于：若干函数做了类似的工作，但在函数本体中却包含了不同的值。

Replace Parameter with Explicit Methods（以明确函数取代参数）

针对该参数的每一个可能值，建立一个独立函数。
适用于：你有一个函数，其中完全取决于参数值而不采取不同行为。

Preserve Whole Object（保持对象完整）

改为传递整个对象（传递整个对象，不要值传递对象的某些属性）。
适用于：你从某个对象中取出若干值，将它们作为某一次函数调用时的参数。

Replace Parameter with Methods（以函数取代参数）

让参数接受者去除该项参数，并直接调用前一个函数。
适用于：对象调用某一个函数，并将所得结果作为参数，传递给另一个函数。
而接受参数的函数本身也能够用前一个函数。

Introduce Parameter Object（引入参数对象）

以一个对象取代这些参数。
适用于：某些参数总是很自然地同时出现。

Remove Setting Method（移除设置函数）

去掉该字段的所有设值函数。
适用于：类中的某个字段应该在对象创建时被设值，然后不再改变。

Hide Method（隐藏函数）

将这个函数修改为private。
适用于：有一个函数，从来没有被其他任何类用到。

Replace Constructor with Factory Method（以工厂函数取代构造函数）

将构造函数替换为工厂函数。
适用于：你希望在创建对象时不仅仅时做简单的建构动作。

Enucapsulate Downcast（封装向下转型）

将向下转型动作移到函数中。
适用于：某个函数返回的对象，需要由函数调用者执行向下转型（downcast）。

Replace Error Code with Exception（异常取代错误代码）

改用异常。
适用于：某个函数返回一个特定的代码，用以表示某种错误情况。

Replace Exception with Test（以测试取代异常）

修改调用者，使它在调用函数之前先做检查。
适用于：面对一个调用这可以预先检查的条件，你抛出了一个异常。

重构方法-处理概括关系（继承关系）

Pull Up Field（字段上移）

将该字段移至超类。
适用于：两个子类都拥有相同的字段。

Pull Up Method（函数上移）

将函数移至超类。
适用于：有些函数，在各个子类中产生完全相同的结果。

Pull Up Constructor Body（构造函数本体上移）

在超类中新建一个构造函数，并在子类构造函数中调用它。
适用于：你在各个子类中拥有一些构造函数，它们的本体机会完全一致。

Push Down Method（函数下移）

将这个函数移到相关的那些子类去。
适用于：超类中的某个函数只与部分（而非全部）子类有关。

Push Down Field（字段下移）

将这个字段移到需要它的那些子类去。
适用于：超类中的某个字段只被部分（而非全部）子类用到。

Extract Subclass（提炼子类）

新建一个子类，将上面所说的那一部分特性移到子类中。
适用于：类中的某些特性只被某些（而非全部）实例用到。

Extract Superclass（提炼超类）

为这两个类建立建立一个超类，将相同特性移至超类。
适用于：这两个类有相似特性。

Extract Interface（提炼接口）

将相同的子集提炼到一个独立接口中。
适用于：若干客户适用类接口中的同一子集，或者两个类的接口有部分相同。

Collapse Hierarchy（折叠继承体系）

将它们合为一体。
适用于：超类和子类之间无太大区别。

Form Template Method（塑造模板函数）

将这些操作分别放进独立函数中，并保持它们都有相同的签名，于是原函数也就变得相同了。然后将原函数上移至超类。
适用于：你有一些子类，其中相应的某些函数以相同顺序执行类似的操作，但各个操作的细节有所不同。

Replace Inheritance with Delegation（以委托取代继承）

在子类中新建一个字段用以保存超类；调整子类函数，令它改而委托超类；然后去掉两者之间的继承关系。
适用于：某个子类只适用超类接口中的一部分，或是根本不需要继承而来的数据。

Replace Delegation with Inheritance（以继承取代委托）

让委托类继承受托类。
适用于：你在两个类之间委托关系，并经常为整个接口编写许多极简单的委托函数。

重构方法-大型重构

Tease Apart Inheritance（梳理并分解继承体系）

建立两个继承体系，并通过委托关系让其中一个可以调用另一个。
适用于：某个继承体系同时承担两项责任。

ConvertProcedural Design to Objects（将过程化设计转化为对象设计）

将数据记录变成对象，将大块的行为分成小块，并将行为移入相关对象之中。
适用于：你手上有一些传统过程化风格的代码。

Separate Domain from Presentation（将领域和表述/显示分离）

将领域逻辑分离出来，为它们建立独立地领域类。
适用于：某些GUI类之中包含了领域逻辑。

Extract Hierarchy（提炼继承体系）

建立继承体系，以一个子类表示一种特殊情况。
适用于：你有某个类做了太多工作，其中一部分工作是以大量表达式完成的。

代码的坏味道–及解决方案

Duplicated Code（重复代码）

Extract Method（提炼函数）
Pull Up Method（函数上移到超类）
Form Template Method（塑造模板函数）
Substitute Algorithm（替换算法）
Extract Class（提炼类）

Long Method（过长函数）

Extract Method（提炼函数）
Replace Temp with Query（以查询取代临时变量）
Introduce Parameter Object（引入参数对象）
Preserve Whole Object（保持对象完整）
Replace Method with Method Object（以函数对象取代函数）
Decompose Conditional（分解条件表达式）

Large Class（过大的类）

Extract Class（提炼类）
Extract Subclass（提炼子类）
Extract Interface（提炼接口）
Duplicate Observed Data（复制“被监视数据”）

Long Parameter List（过长参数列）

Replace Parameter with Method（用函数替换参数）
Preserve Whole Object（保持对象完整）
Introduce Parameter Object（引入参数对象）

Divergent Change（发散式变化）

Extract Class（提炼类）

Shotgun Surgery（霰xian弹式修改）

Move Method（移动函数）
Move Field（移动字段）
Inline Class（内联类）

Feature Envy（依恋情结）

Move Method（移动函数）
Extract Method（提炼方法）

Data Clumps（数据泥团）

Extract Class（提炼类）
Introduce Parameter Object（引入参数对象）
Preserve Whole Object（保持整个对象）

Primitive Obsession（基本类型偏执）

Replace Data Value with Object（用对象替换数据值）
Replace Type Code with Class（用类替换类型代码）
Extract Class（提炼类）
Introduce Parameter Object（引入参数对象）
Replace Array with Object（用对象代替数组）

Switch Statements（switch 惊悚现身）

Extract Method（提炼函数）
Move Method（移动函数）
Replace Type Code with Subclass（以子类替换类型代码）
Replace Type Code with State/Strategy（以State/Strategy取代类型码）
Replace Conditional with Polymorphism（以多态取代条件表达式）
Replace Parameter with Explicit Methods（以明确函数取代参数）
Introduce Null Object（引入null对象）

Parallel Inheritance Hierarchies（平行继承体系）

Move Method（移动函数）
Move Field（移动字段）

Lazy Class（冗赘类）

Collapse Hierarchy（折叠继承体系）
Inline Class（内联类）

Speculative Generality（夸夸其谈未来性）

Collapse Hierarchy（折叠继承体系）
Inline Class（内联类）
Remove Parameter（移除参数）
Rename Method（移除函数）

Temporary Field（令人迷惑的暂时字段）

Extract Class（提炼类）
Introduce Null Object（引入Null对象）

Message Chains（过渡耦合的消息链）

Hide Delegate（隐藏“委托关系”）
Extract Method（提炼函数）
Move Method（移动函数）

Middle Man（中间人）

Remove Middle Man（中间人）
Inline Method（内联方法）
Replace Delegation with Inheritance（以继承取代委托）

Inappropriate Intimacy（狎昵关系）–两个类过于亲密

Move Method（移动函数）
Move Field（移动字段）
Change Bidirectional Association to Unidirectional（将双向关联改为单向关联）
Extract Class（提炼类）
Hide Delegate（隐藏“委托关系”）
Replace Inheritance with Delegation（以委托取代继承）