重构读书笔记

重构读书笔记

1 重构, 第一个案例

2 重构原则

2.1 何为重构

名词形式

对软件内部结构的一种调整, 目的是在不改变软件可观察行为的前提下, 提高其可理解性, 降低修改成本.

动词形式

使用一系列重构手法, 在不改变软件可观察行为的前提下, 调整其结构.

2.2 为何重构

重构改进软件设计

重构使软件更容易理解

重构帮助找到bug

重构提高编程速度

2.3 何时重构

重构本来就不是一件应该特别拨出时间做的事情, 重构应该随时随地进行. 你不应该为重构而重构, 你之所以重构, 好似因为你想做别的什么事情, 而重构可以帮助你把那些事情做好.

三次法则

添加功能时重构

修补错误时重构

复审代码时重构

2.4 对经理怎么说

间接层的价值

允许逻辑共享

分开解释意图和实现

隔离变化

封装条件逻辑

2.5 重构的难题

2.6 重构与设计

2.7 重构与性能

2.8 重构起源何处

3 代码的坏味道

3.1 重复代码 Duplicated Code

3.2 过长的函数 Long Method

3.3 过大的类 Long Class

3.4 过长参数列 Long Parameter List

3.5 发散式变化 Divergent Change

原本有变化了只在一个类里做修改,结果类被拆分成多个了,结果在多个地方都要修改

3.6 散弹式修改 Shotgun Surgery

某种变化在多个不同的类里做修改

3.7 依恋情节 Featuer Envy

某个函数为了计算某值, 结果从其他对象里调用了几乎半打的取值函数.

3.8 数据泥团 Data Clumps

相同的三四项数据再以下情况中出现: 两个类中相同的字段, 许多函数前面中相同的函数.

3.9 基本类型偏执 Primitive Obsession

不在关联很强的小任务上用小对象, 而是用多个基本类型组合表示

3.10 switch 惊悚现身 Switch Statements

switch用多了(一旦要修改, 就必须找到所有的switch).

3.11 平行继承体系 Parllel Inheritance Hierarchies

当你为某个类增加一个子类, 必须也为另一个类相应怎加子类.

3.12 冗赘类 Lazy Class

一个没啥用的类.

3.13 夸夸其谈未来性 Speculative Generality

以各式各样的狗子和特殊情况来处理一些非必要的事情

3.14 令人迷惑的暂时字段 Temporary Field

3.15 过度耦合的消息链 Message Chains

一个对象请求一个对象,然后在向后者请求另外一个对象, 然后在请求另外一个对象…

3.16 中间人 Middle Man

某个类有一般的函数都委托给其他类.

3.17 狎昵关系 Inappropriate Intimacy

两个类过于亲密, 花太多时间去探究彼此的private.

3.18 异曲同工的类 Alternatice Classes with Different Interfaces

两个类做同一件事, 却有着不同的签名.

3.19 不完美的库类 Incomplete Library Class

库类都在的不够好, 我们又不能修改其中的类

3.20 纯数据的类 Data Class

3.21 被拒绝的遗赠 Refused Bequest

子类应该继承超类的函数和数据, 但是它又不想或不需要继承.

3.22 过多的注释 Comments

有很长的注释, 之所以存在是因为代码很糟糕

4 构筑测试体系

5 重构列表

6 重新组织函数

6.1 提炼函数 Extract Method

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

将这段代码放进一个独立函数中, 并让函数名解释该函数的用途.

6.2 内联函数 Inline Method

一个函数的本体与名称同意清楚易懂.

在函数调用点插入函数本体, 然后移除该函数.

6.3 内联临时变量 Inline Temp

你有一个临时变了, 只被一个简单表达式赋值一次, 而他妨碍了其他重构手法.

将所有对该变了的引用动作, 替换为对他赋值的那个表达式自身.

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

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

将这个临时变量的所有引用点替换为对新函数的调用. 然后新函数就可以被其他函数调用

6.5 引入解释性变量 Introduce Explaining Variable

你有一个复杂表达式. 将该表达式(或者其中一部分)的结果放进一个临时变量, 以此变量名称来解释表达式用途.

目的:表达式肯能非常复杂难以阅读.

这种情况下, 临时变量可以帮助你将表达式分解为比较容易管理的形式.

6.6 分解临时变量 Split Temporarry Variable

你的程序有某个零食变量被赋值超过一次,它既不是循环变量,也不被用于收集计算结果.

针对每次赋值,创造一个独立,对应的临时变量

目的:临时变量有各种不同的用途. 同一个临时变量承担两件不同的事情,会令代码阅读者糊涂

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

代码对一个参数进行赋值.

以一个临时变量取代该参数的位置.

对参数赋值的做法降低了代码的清晰度, 而且混用了按值传递和引用传递这两种参数传递方式.面对”出参数”的语言,不必遵循这条规则.

6.8 以函数对象取代函数 Replace Method with Method Object

你有一个大型函数, 其中对局部变量的使用你无法采用提炼函数.

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

7.9 替换算法 Substitute Algorithm

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

将函数本体替换为另外一个算法.

如果你发现做一件事可以又更清晰的方式,就应该以较清晰的方式取代复杂的方式.

7 在对象之间搬移特性

7.1 搬移函数 Move Method

你的程序中, 有个函数与其所驻类之外的另一个类进行更多交流:调用后者,或被后者调用.

在该函数最常引用的类中建立一个有着类似行为的新函数.将旧函数编程一个淡出的委托函数,或是将旧函数完全移除.

7.2 搬移字段 Move Field

你的程序中,某个字段被其所驻类之外的另一个更多的用到.

在目标类中新建一个字段,修改源字段的所有用户,令它们改用新字段.

7.3 提炼类 Extract Class

某个类做了应该由两个类做的事.

建立一个新类, 将相关的字段和函数从旧类搬移到新类.

7.4 将类内联化 Inline Class

某个类没有做太多事情.

将这个类的所有特性搬移到另一个类中,然后移除原类.

7.5 隐藏委托关系 Hide Delegate

客户通过一个委托类来调用另一个对象.

在服务类上建立客户所需的所有函数,用以隐藏委托关系.

7.6 移除中间人 Remove Middle Man

某个类做了过多的简单委托动作.

让客户直接调用受托类.

7.7 引入外加函数 Introduce Foreign Method

你需要为提供服务的类增加一个函数, 但你无法修改这个类.

在客户类中建立一个函数, 并以第一参数形式传入一个服务类实例.

7.8 引入本地扩展 Introduce Local Extension

你需要为服务类提供一些额外函数, 但你无法修改这个类.

建立一个新类, 使它包含这些额外函数. 让这个扩展品成为源类的子类或包装类.

8 重新组织数据

8.1 自封装字段 Self Encapsulate Field

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

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

间接访问: 子类可以通过覆写一个函数而改变获取数据的途径; 它还支持更灵活的数据管理方式, 例如延迟初始化.

直接访问: 代码比较容易阅读.

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

你有一个数据项, 需要与其他数据和行为一起使用才有意义.

将数据项变成对象.

8.3 将值对象改为引用对象

你从一个类衍生出许多彼此相等的实例, 希望将他们替换为同一个对象.

将这个值对象编程引用对象.

8.4 将引用对象改为值对象

你有一个引用对象, 很小且不可改变, 而且不易管理.

将它变成一个值对象.

8.5 以对象取代数组

你有一个数组, 其中的元素各自代表不同的东西.

以对象替换数组. 对于数组中的每个元素, 以一个字段来表示.

8.6 复制被监视数据 Duplicate Observed Data

你有一些领域数据置身于GUI控件中, 而领域函数需要访问这些数据.

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

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

两个类都需要使用对方特性, 但其间只有一条单向连接.

添加一个反向指针, 并且修改函数能够同事更新两条连接.

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

两个类之间有双向关联, 但其中一个类如今不需要另一个类的特性.

去除不必要的关联.

8.9 以字面常亮取代魔法数 Replace Magic Number with Symbolic Constant

你有一个字面数值, 带有特别含义.

创造一个常量, 根据其意义为他命名, 并将上述的字面数值替换为这个常量.

8.10 封装字段 Encapsulate Field

你的类中存在一个public字段.

将它声明为private, 并且提供相应的访问函数.

8.11 封装集合 Encapsulate

有个函数返回一个集合.

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

8.12 以数据类型取代记录 Replace Record wiht Data Class

你需要面对传统编程环境中的记录结构.

为该记录创建一个”哑”数据对象(属性都是私有,只有get和set方法).

8.13 以类取代类型码 Replace Type Code wiht Class

类之中有一个数值类型码, 但它并不影响类的行为.

以一个类替换该数值的类型码.

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

你有一个不可变的类型码, 它会影响类的行为.

以子类取代这个类型码.

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

你有一个类型码, 它会影响类的行为, 但你无法通过继承手法消除它.

以状态对象取代类型码.

8.16 以字段取代子类 Replace Subclass with Fields

你的各个子类的唯一差别只在”返回常量数据”的函数身上.

修改这些函数, 使它们返回超累中的某个(新增)字段, 然后销毁子类.

9 简化条件表达式

9.1 分解条件表达式 Decompose Conditional

你有一个复杂的条件(if-then-else)语句.

从if, then, else三个段落中分别提出独立函数.

9.2 合并条件表达式 Consolidate Conditional Expression

你有一些列条件测试, 都得到相同结果.

将这些测试合并为一个条件表达式, 并将这个条件表达式提炼成为一个独立函数.

9.3 合并重复的条件片段 Consolidate Duplicate Conditional Fragments

在条件表达式的每个分支上有着相同的一段代码.

将这段重复的代码搬移到条件表达式之外.

9.4 移除控制标记 Remove Control Flag

在一系列布尔表达式中, 某个变量带有”控制标记”(control flag)的作用.

以break语句或return语句去到控制标记.

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

函数中的条件逻辑使人难以看清正常情况的执行路径.

使用卫语句表现所有特殊情况.

条件表达式通常有两种表现形式.

* 所有分支都属于正常行为.

* 条件表达式提供的答案中只有一种是正常行为, 其他都是不常见的情况.

这两类条件表达式都有不同的用途,这一点应该通过代码表达出来.

* 如果两条分支都是正常行为, 用形如if…else…的条件表达式

* 如果某个条件极其罕见, 就应该单独检查该条件, 并在该条件为真时立刻从函数中返回.这样的单独检查被成为”卫语句”(guard clauses)

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

你手上有个条件表达式, 它根据对象类型的不同而选择不用的行为.

将这个条件表达式的每个分支放进一个子类的覆写函数中,然后将原始函数申明为抽象函数.

9.7 引入Null对象 Introduce Null Object

你需要再三检查某对象是否为null.

将null值替换为null对象.

可以用多态让null对象做出一些我们期望的响应.

9.8 引入断言 Introduce Assertion

莫一段代码需要对程序状态做出某种假设.

以断言明确表现这种假设.

10 简化函数调用

10.1 函数改名 Rename Method

函数的名称未能揭示函数的用途.

修改函数名称.

10.2 添加参数 Add Parameter

某个函数需要从调用端得到更多信息.

为此函数添加一个对象参数, 让该对象带进函数所需信息.

10.3 移除参数 Remove Parameter

函数本体不再需要某个参数.

将该参数去除.

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

某个函数既返回对象状态值, 又修改对象状态.

建立两个不同的函数, 其中一个负责查询, 另一个负责修改.

10.5 令函数携带参数 Parameterize Method

若干函数做了类似的工作, 但在函数本体中却包含了不同的值.

建立单一函数, 以参数表达那些不同的值.

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

你有一个函数, 其中完全取决于参数值而采取不同行为.

针对该参数的每一个可能值, 建立一个独立函数.

10.7 保持对象完整 Preserver Whole object

你从某个对象中去除若干值, 将他们作为某一次函数调用时的参数.

改为传递整个对象.

10.8 以函数取代参数 Replace Parameter with methods

对象调用某个函数, 并将所得结果作为参数, 传递给另一个函数. 而接受该参数的函数本身也能够调用前一个函数.

让参数接受者去除该项参数, 并直接调用前一个函数.

10.9 引入参数对象 Introduce Parameter Object

某些参数总是很自然地同时出现.

以一个对象去到这些参数.

10.10 移除设值函数 Remove Setting Method

类中的某个字段应该在对象创建的时候被设值, 然后就不在改变.

去掉该字段的所有的设值函数.

10.11 隐藏函数 Hide method

有一个函数, 从来没有被其他任何类用到.

将这个函数修改为private.

10.12 以工厂函数取代构造函数 Replace Constructor with Factory method

你希望创建对象时不仅仅是做简单的构建的动作.

将构造函数替换为工厂函数

10.13 封装向下转型 Encapsulate Downcast

某个函数返回的对象, 需要由函数调用者执行向下转型(downcast).

将向下转型动作移动到函数中.

10.14 以异常取代错误码 Replace Error Code with Exception

某个函数返回一个特定的代码. 用以表示某种错误情况.

改用异常.

10.15 以测试取代异常 Replace Exception with Test

面对一个调用者可以预先检查的条件, 你抛出了一个异常.

修改调用者, 使它在调用函数之前先做检查.

11 处理概括关系

11.1 字段上移 Pull Up Field

两个子类拥有相同的字段.

将该字段移至超类.

* 去除了重复的数据声明

* 使你可以将使用的行为从子类移至超类, 去除重复的行为

11.2 函数上移 Pull Up Method

有些函数,在各个子类中产生完全相同的结果.

将该函数移至超类.

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

你在各个子类中拥有一些构造函数, 他们的本体几乎完全一致.

在超类中新建一个构造函数, 并在子类构造函数中调用他们.

11.4 函数下移 Push Down Method

超类中的某个函数只与部分(而非全部)子类有关.

将这个函数移到相关的那些子类去.

11.5 字段下移 Push Down Field

超类中的某个字段只被部分(而非全部)子类用到.

将这个字段移到需要他的子类去.

11.6 提炼子类 Extract Subclass

类中的某些特性只是被某些(而非全部)实例用到.

新建一个子类, 将上面所说的那一部分特性移到子类去.

11.7 提炼超类 Extract Superclass

两个类有相似的特性.

为这两个类建立一个超类, 将相同特性移至超类.

11.8 提炼接口 Extract Interface

若干客户使用类接口中的一同一个子集, 或者两个类的接口有部分相同.

将相同的子集提炼到一个独立接口中.

11.9 折叠继承体系 Collapse Hierarchy

超类和子类之间无太大区别.

将它们合为一体.

11.10 塑造模板函数 From Template Method

你有一些子类, 其中相应的某些函数以相同顺序执行类似的操作, 但各个操作的细节上有所不同.

将这些操作分别放进独立函数中, 并保持它们都有相同的签名, 于是原函数也就变得相同了. 然后将原函数上移至超类.

11.11 以委托取代继承 Replace Inheritance with Delegation

某个子类只使用超类接口中的一部分, 或是根本不需要继承而来的数据.

在子类中新建一个字段用以保存超类; 调整子类函数, 令它改而委托超类; 然后去掉两者之间的关系.

11.12 以继承取代委托 Replace Delegation with Inheritance

你在两个类之间使用委托关系, 并经常为整个接口编写许多极简单的委托函数.

让委托类继承受托类

12 大型重构

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

某个继承体系同时承担两项责任.

建立两个继承体系, 并通过委托关系让其中一个可以调用另一个.

12.2 将过程化设计转换为对象设计 Convert Procedural Desingn to Objects

你手上有一些传统过程化风格的代码.

将数据记录变成对象, 将大块的行为分成小块, 并将行为移入相关对象之中.

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

某些GUI类之中包含了领域逻辑.

将领域逻辑分离出来, 为它们建立独立的领域类.

12.4 提炼继承体系 Extract Hierarchy

你有某个类做了太多工作, 其中一部分工作时以大量条件表达式完成的.

建立继承体系, 以一个子类表示一种特殊情况.

13 重构, 复用与现实

14 重构工具

15 总结