重构

发表于

重构 - 改善既有代码的设计

重构原则

一、重构定义

重构（名词）：对软件内部结构的一种调整，目的是在不改变软件可观察行为的前提下，提高其可理解性，降低其修改成本。

重构（动词）：使用一系列重构首发，在不改变软件可观察行为的前提下，调整其结构

二、为何重构

  1. 重构改建软件设计（更好的结构，让软件更好维护）
  2. 重构使软件更容易理解
  3. 重构帮助找到bug（写明显没有bug的代码，而不是没有明显bug的代码）
  4. 重构提高编程速度

三、何时重构

三次法则：第一次做某件事时只管去做；第二次做类似的事会产生反感，但无论如何还是可以去做；第三次再做类似的事，你就应该重构。

  1. 添加功能时重构
  2. 修补错误时重构
  3. 复审代码时重构

代码复审有助于经验传播，更多人能够理解系统中的更多部分。结对编程就是代码复审的一种体现。

四、怎么和经理说？

  1. 质量
  2. 如果是进度驱动，不建议告诉经理！

五、重构的问题

  1. 数据结构
  2. 修改接口
  3. 难以通过重构手法完成的设计改动
  4. 何时不该重构

六、重构与设计

  1. 先设计一个足够合理的解决方案（不要过度设计）
  2. 使用重构改善设计

七、重构与性能

重构可以帮我们写出更快的软件

八、重构起源

略

代码的坏味道

‘如果尿布臭了，就换掉它。’ – 语出beck奶奶，讨论抚养小孩的哲学

  1. 重复代码
  2. 过长函数
  3. 过大的类
  4. 过长参数列
  5. 发散式变化：一个类收到多种变化影响
  6. 霰弹式修改：一种变化引发多个类相应修改
  7. 依恋情结：函数对于某个类的兴趣高过对自己所处类的兴趣
  8. 数据泥团：相同的几项数据经常多次出现
  9. 基本类型偏执：使用小对象（未理解，存疑）
  10. switch：switch太多重复，可以使用多态来替换（待验证）
  11. 平行继承体系：当你为某个类增加一个子类，必须也为另一个类相应增加一个子类。
  12. 冗余类
  13. 夸夸其谈未来性
  14. 暂时性字段
  15. 过度耦合的消息链
  16. 中间人：过度使用委托
  17. 狎昵关系
  18. 异曲同工的类
  19. 不完美的库类
  20. 纯稚的数据类
  21. 被拒绝的继承：如果子类不想或者不需要继承超类的函数和数据
  22. 过多的注释：帮我我们找到坏味道

构筑测试体系

编写优良的测试程序，可以极大的提高我的编程速度。

频繁进行测试是极限编程的重要一环

  • 单元测试：每个测试类，测试函数
  • 功能测试：测试整个系统的功能

测试是一种风险驱动的行为，测试的目的是找出现在或未来可能出现的错误。所以我不会去测试那些仅仅读或写一个字段的访问函数，因为它们太简单了，不大可能出错。测试的要诀是：测试你最担心出错的部分。

任何测试都不能证明一个程序没有bug，但并不影响「测试可以提高编程速度」。当测试数量达到一定程度时，继续增加测试带来的效益就会呈现递减态势，而非持续递增。测试要集中在可能出错的地方，观察代码，看哪里复杂；观察函数，思考哪些地方可能出错。

重构列表

重构的记录格式

  • 名称
  • 摘要
  • 动机
  • 做法
  • 范例

寻找引用点

  • 被删除的部分在继承体系中声明了不止一次
  • 编译器可能太慢
  • 编译器无法找到通过反射机制而得到的引用点

不要盲目的查找-替换，用心检查

成熟的重构手法

  1. 基本技巧：「小步前进，频繁测试」已经得到多年的实践检验。
  2. 设计模式为重构行为提供了目标

重新组织函数

Extract Method

你有一段代码可以被组织在一起并独立出来

  1. 动机

当我看到一个过长的函数或者需要注释才能让人理解用途的代码，我就会将这段代码放进一个独立函数。

如果习惯看大型函数，恐怕需要一段实践才能适应这种新风格。而且只有当你能给小型函数很好的命名时，它们才能真正起作用，所以你需要在函数名称上下点功夫。

  1. 做法

    • 创造一个新函数，根据这个函数的意图来对它命名（以它做什么来命名，而不是以它怎么做命名）：即使你想要提炼的代码非常简单，例如只是一条消息或一个函数调用，只要新函数的名称能够以更好的方式昭示代码意图，你也应该提炼它。如果你想不出来一个更有意义的名称，就别动
    • 将提炼出来的代码从源函数复制到目标函数中
    • 仔细检查提炼出的代码，看看其中是否引用了‘作用域限于源函数’的变量（包括局部变量和源函数参数）
    • 检查是否有‘仅用于被提炼代码段’的临时变量。如果有，在目标函数中将它们声明为临时变量
    • 检查被提炼的代码段，看看是否有任何局部变量的值被它改变。如果一个临时变量值被修改了，看看是否可以将被提炼代码段处理为一个查询，并将结果赋值给相关变量。如果很难这么做，或如果被修改的变量不止一个，你就不能仅仅将这段代码原封不动的提炼出来。你可能需要先使用「split temporary variable」，然后再尝试提炼。也可以使用「replace temp with query」将临时变量消灭掉。
    • 将被提炼代码段中需要读取的局部变量，当作参数传给目标函数。
    • 处理完所有的局部变量后，进行编译
    • 在源函数中，将被提炼代码替换为对目标函数的调用
    • 编译，测试

临时变量往往为数众多，甚至会使提炼工作举步维艰。这种情况，我会尝试先用「replace temp with query」减少临时变量。如果即使这么做了提炼依旧困难重重，我就会动用「replace method with method object」，这个重构方法不在乎代码中有多少临时变量，也不在乎你如何使用它们。

Inline Method

一个函数本体与名称同样清楚易懂，在函数调用点插入函数本体，然后移除该函数

1
2
3
4
5
6
int getRating(){
    return (moreThanFiveLateDeliveries()) ? 2 : 1;
}
boolean moreThanFiveLateDeliveries() {
    return _numberOfLateDeliveries > 5;
}

改造后

1
2
3
int getRating() {
    return (_numberOfLateDeliveries > 5) ? 2 : 1;
}

  1. 动机
    • 本书经常以简短的函数表现动作意图，这样会使代码更清晰易读。但有时候你会遇到某些函数，其内部代码和函数名称同样清晰可读。如果这样，你就应该去掉这个函数。
    • 另一种需要使用「inline method」的情况是：你手上有一群组织不甚合理的小型函数。实施「Replace Method with Method Object」之前就这么做，往往可以取得不错的结果。
  2. 做法
    • 检查函数，确定它不具多态性
    • 找出这个函数的所有被调用点
    • 将这个函数的所有被调用点替换为函数本体
    • 编译，测试
    • 删除该函数的定义

Inline Temp

你有一个临时变量，只被一个简单表达式赋值一次，而它妨碍了其他重构首发。将所有对该变量的引用动作，替换为对它赋值的那个表达式自身。

Replace Temp with Query

你的程序以一个临时变量保存某一表达式的运算结果。

Introduce Explaining Variable

你有一个复杂的表达式。将该复杂表达式（或其中一部分）的结果放进一个临时变量，以此变量名称来解释表达式用途。

Split Temporary Variable

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

Remove Assignments to Parameters

代码对一个参数进行赋值，以一个临时变量取代该参数的位置。

Replace Method with Method Object

将这个函数放进一个单独对象中，如此依赖局部变量就成了对象内的字段。然后你可以在同一个对象中将这个大型函数分解为多个小型函数。

Substitute Algorithm

你想要把某个算法替换为另一个更清晰的算法。

在对象之间搬移特性

类往往会因为承担过多的责任而变得臃肿不堪。这种情况下，我会使用「Extract Class」将一部分责任分离出去。如果一个类变得太“不负责任”，我会使用「Inline Class」将它融入另一个类。如果一个类使用了另一个类，运用「Hide Delegate」将这种关系隐藏起来通常是有帮助的。有时候隐藏委托类会导致拥有者的接口经常变化，此时需要使用「Remove Middle Man」。

本章最后两项重构–「Indroduce Foreign Method」和「Introduce Local Extension」比较特殊。只有当我不能访问某个类的源码，却又想把其他责任移进这个不可修改的类时，我才会使用这两个重构首发。

Move Method

你的程序中，有个函数与其所驻类之外的另一个类进行更多交流：调用后者，或被后者调用。在该函数最常引用的类中建立一个有着类似行为的新函数。将就函数变成一个单纯的委托函数，或是将就函数完全移除。

Move Field

你的程序中，某个字段被其所驻类之外的另一个类更多地用到。在目标类新建一个字段，修改源字段的所有用户，令他们该用新字段。

Extract Class

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

Inline Class

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

Hide Delegate

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

Remove Middle Man

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

重构的意义在于：你永远不必说对不起 —— 只要把出问题的地方修补好就行了

Introduce Foreign Method

你需要为服务的类增加一个函数，但你无法修改这个类，在客户类中建立一个函数，并以第一参数形式传入一个服务类实例。

重复代码是软件万恶之源

Introduce Local Extension

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

还是子类吧，包装类要累死人

要遵循原则：函数和数据应该被统一封装。

重新组织数据

Self Encapsulate Field

你直接访问一个字段，但与字段之间的耦合关系逐渐变得笨拙。

为这个字段建立取值/设值函数，并且只以这些函数来访问字段

Replace Data Value with Object

以偶一个数据项，需要与其他数据和行为一起使用才有意义

Change Value to Reference

你从一个类中衍生出许多彼此相等的实例，希望将它们替换为同一个对象。

将引用对象改为值对象

你有一个引用对象，很小且不可变，而且不易管理，将它变成一个值对象

Replace Array with Object

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

Duplicate Observerd Data

你有一些领域数据置身于GUI控件中，而领域函数需要访问这些数据。将该数据复制到一个领域对象中。建立一个Observer模式，用以同步领域对象和GUI对象内的重复数据。

一个分层良好的系统，应该将处理用户界面和处理业务逻辑代码分开。经典的MVC模式

这个没有理解

Change Unidirectional Association to Bidirectional

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

相当于双向绑定，可以带来方便，也有可能带来混乱。

Change Bidirectional Association to Unidirectional

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

Replace Magic Number with Symbolic Constant

创造一个常量，根据其意义为它命名，并将上面的数值替换为这个常量

Encapsulate Field

如果你的类存在一个public字段，将它声明为private，并提供相应的访问函数

Encapsulate Collection

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

Replace Record with Data Class

你需要面对传统编程环境中的记录结构，为该记录创建一个哑数据对象

Replace Type Code with Class

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

Replace Type code with Subclasses

你有一个不可变的类型码，它会影响类的行为。以子类取代这个类型码。

Replace Subclass with Fields

你的各个子类的唯一差别只在‘返回常量’的函数上，修改这些函数，使他们返回超类中某个（新增）字段，然后销毁子类

简化条件表达式

Decompose Conditional

你有一个复杂的条件语句。从if-then-else中分别提炼独立函数

Consolidate Conditional Expression

你有一系列条件测试，都得到一样的结果。将这些测试合并为一个条件表达式，并将这个表达式抽出来一个独立函数

Consolidate Duplicate Conditional Fragments

在条件表达式上的每一个分支有着相同的一段代码。将这段重复的代码挪到条件表达式外。

Remove Control Flag

在一系列布尔表达式中，某个变量带有‘控制标记‘的作用。以break或者continue去掉控制标记

Replace Nested Conditional with Guard Clause

函数中的条件逻辑使人难以看清正常的执行逻辑，使用卫语句表现所有的情况

Replace Conditional with Polymorsphim

你手上有多个条件表达式，它根据对象的不同而选择不同的行为。将这个条件表达式的每一个分支都放进一个子类的覆写函数里，然后将原本的函数声明为抽象函数

Introduce Null Object

你需要再三检查某对象是否为null，将null值替换null对象

Introduce Assertion

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

简化函数调用

Rename Method

生活就是如此。你常常无法第一次就给函数起一个好名称。这时候你可能会想：就这样将就着吧，毕竟只是一个名称而已。当心！这是恶魔的召唤，是通向混乱之路，千万不要被它诱惑！如果你看到一个函数名称不能很好的表达它的用途，应该马上加以修改。记住，你的代码首先是为人写的，其次才是为计算机写的。而人需要良好名称的函数。想象过去曾经浪费的无数时间吧。如果给每个函数都起一个良好的名称，也许你可以节约好多时间。起一个好名称并不容易，需要经验；要想成为一个编程高手，起名的水平是至关重要的。

Add Parameter

如果有其他选择，尽量不要用这个方案，因为过长的参数列不是好事，往往是代码的坏味道。超过3个很多人已经不耐烦了。

Remove Parameter

程序员可能经常添加参数，却往往不愿意去掉它们。他们打的如意算盘是：无论如何，多余的参数不会引起任何问题，而且以后还可能用上它。

这也是恶魔的诱惑，一定要把它从脑子里赶出去！参数代表着函数所需的信息，不同的参数值有不同的意义。函数的调用者必须为每一个参数操心该传什么东西进去。如果你不去掉多余参数，就是让你的每一位用户多费一份心。是很不划算的，更何况，“去掉参数”是非常简单的一项重构。

Separate Query from Modifier

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

Parameterize method

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

Replace Parameter with Explicit Methods

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

和上面的方法恰恰相反，如果某个参数有多种可能的值，而函数内又以条件表达式检查这些参数值，并根据不同的参数值做出不同的行为，那么就应该使用本项重构。

Preserve Whole Object

你从某个对象中取出若干值，将它们作为某一次函数调用时的参数。改为传递整个对象

Replace Parameter with Methods

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

Indroduce Parameter Object

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

Remove Setting Method

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

Hide Method

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

Replace Constructor with Factory Method

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

Encapsulate Downcast

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

Replace Error Code with Exception

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

许多程序都使用特殊输出来表示错误，Unix系统和C-based系统的传统方式就是以返回值表示子程序的成功或失败。java有一种更好的错误处理方式，异常。这种方式之所以更好，因为它清楚地将“普通程序”和“错误处理”分开了，这使得程序更容易理解 —— 我希望你如今已经坚信：代码的可理解性应该是我们虔诚追求的目标。

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

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

Convert Procedural Design to Objects

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

Separate Domain from Presentation

某些GUI类之中包含了领域逻辑。将领域逻辑分离出来，为他们建立独立的领域类。

Extract Hierarchy

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