《重构—改善既有代码的设计》笔记
为什么要重构
- 改进软件设计，消除重复代码
- 保持代码易读、易修改
- 提高编程速度(良好设计师维持软件开发速度的根本)
- 发现BUG
什么时候重构
- 事不过三，三则重构(三次法则)
- 添加功能时一并重构
- 修改错误时一并重构
- 复审代码时一并重构
- 问题代码
- 重复的代码
- 过长函数
- 过大类
- 过长参数列表
- 发散式变化
- 霰弹式修改
- 依恋情节
- 数据泥团
- 基本型别偏执
- switch惊悚现身
- 冗赘类
- 夸夸其谈未来性
- 令人迷惑的暂时值域
- 过度耦合的消息链
- 中间转手人
- 狎昵关系
- 异曲同工的类
- 不完美的程序库类
- 纯稚的数据类
- 被拒绝的遗赠
- 过多的注释
重构的难题
- 数据库
- 修改接口
- 难以通过重构手法完成的设计改动
何时不该重构
- 既有代码实在太混乱，重构它还不如新写一个来得简单。
- 在项目最后期限，应该避免重构
重构的节奏
测试、小修改、测试、小修改、测试、小修改……
重构第一步
为即将修改的代码建立一个可靠的测试环境
经典句子
Any fool can write code that a computer can understand. Good programmers write code that humans can understand.——Martin Fowler
任何一个傻瓜都能写出计算机可以理解的代码。唯有写出人类容易理解的代码，才是优秀的代码。 ——Martin Fowler
I'm not a great programmer; I'm just a good programmer with great habits.——Kent Beck
我不是个伟大的程序员，我只是一个有着一些优秀习惯的好程序员。 ——Kent Beck
重构花名册—重新组织你的函数
提炼函数(Extract Method)
- 概要：你有一段代码可以被组织在一起并独立出来。将这段代码放进一个独立函数中，并让函数名称解释该函数的用途。
内联函数(Inline Method)
- 概要：一个函数，其方法体应该与其名称同样清楚易懂。在函数调用点插入函数本体，然后移除该函数。
内联临时变量(Inline Temp)
- 概要：你有一个临时变量，只被一个简单表达式赋值一次，而它妨碍了其他重构手法。将所有对该变量的引用动作，替换为对它赋值的那个表达式自身。
查询替换临时变量(Replace Temp with Query)
- 概要：你的程序以一个临时变量保存某一表达式的运算结果。将这个表达式提炼到一个独立的函数中。将这个临时变量的所有被引用点替换为对新函数的调用。新函数可以被其他的函数使用。
Replace Temp with Query往往是你运用Extract Method之前必不可少的一个步骤。局部变量会使代码难以被提炼，所以你应用尽可能把它们替换为查询式。
引入解释性变量(Introduce Explaining Variable)
- 概要：你有一个复杂的表达式。将该复杂表达式(或其中一部分)的结果放进一个临时变量，以此变量名称来解释表达式用途。
剖解临时变量(Split Temporary Variable)
- 概要：你的程序有某个临时变量被赋值过一次，它既不是循环变量，也不是一个集用临时变量。针对每次赋值，创造一个独立、对应的临时变量。
移除参数的赋值(Remove Assignments 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)
- 概要：你需要为服务类提供一些额外函数，但你无法修改这个类。建立一个新类，使它包含这些额外函数。让这个扩展品成为源类的子类或包装类。
重构花名册—重新组织数据
自封装值域(Self Encapsulate Field)
- 概要：你直接访问一个值域，但与值域之间的耦合关系逐渐变得笨拙。为这个值域建立取值/设值函数，并且只以这些函数来访问值域。
以对象取代数据值(Replace Data Value with Object)
- 概要：你有一个数据项，需要与其他数据和行为一起使用才有意义。将数据项变成对象。
将值对象改为引用对象(Change Value to Reference)
- 概要：你从一个类衍生出许多彼此相等的实例，希望将它们替换为同一个对象。将这个值对象变成引用对象。
将引用对象改为值对象(Change Reference to Value)
- 概要：你有一个引用对象，很小且不可变，而且不易管理。将它变成一个值对象。
以对象取代数组(Replace Array with Object)
- 概要：你有一个数组，其中的元素各自代表不同的东西。以对象替换数组，对于数组中的每个元素，以一个值域来表示。
复制“被监视数据”(Duplicate Observed Data)
- 概要：你有一些领域数据置身GUI控件中，而领域函数需要访问这些数据。将该数据复制到一个领域对象中。建立一个Observe模式，用以同步领域对象和GUI对象内的重复数据。
将单向关联改为双向关联(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 Subclass)
- 概要：你又一个不可变的类型码，它会影响类的行为。以子类取代这个类型码。
以State/Strategy取代类型码(Replace Type Code with State/Strategy)
- 概要：你有一个类型码，它会影响类的行为，但你无法通过继承手法消除它。以状态对象取代类型码。
以值域取代子类(Replace Subclass with Fields)
- 概要：你的各个子类的唯一差别只在“返回常量数据”的函数身上。修改这些函数，使他么返回超类中的某个（新增）字段，然后销毁子类
重构花名册—简化条件表达式
分解条件表达式(Decompose Conditional)
- 概要：你有一个复杂的条件（if-then-else）语句。从if、then、else三分段落中分别提炼出独立函数。
合并条件表达式(Consolidate Conditional Expression)
- 概要：你有一系列条件测试，都得到相同结果。将这些测试合并为一个条件表达式，并将这个条件表达式提炼成为一个独立函数。
合并重复的条件片段(Consolidate Duplicate Conditional Fragments)
- 概要：在条件表达式的每个分支上有着相同的一段代码。将这段重复的代码搬移到条件表达式之外。
移除控制标记(Remove Control Flag)
- 概要：在一系列布尔表达式中，某个变量带有“控制标记”的作用。以break语句或return语句取代控制标记。
以卫语句取代嵌套条件表达式(Replace nested Conditional with Guard Clauses)
- 概要：函数中的条件逻辑使人难以看清正常的执行路径。使用卫语句表现所有的特殊情况。
以多态取代条件表达式(Replace Conditional with Polymorphism)
- 概要：你手上有个条件表达式，它根据对象类型的不同选择不同的行为。将这个条件表达式的每个分支放进一个子类内的覆写函数中，然后将原始函数声明为抽象函数。
引入Null对象(Introduce Null Object)
- 概要：你需要再三检查某对象是否为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)
- 概要：你希望在创建对象时不仅仅是做简单的构建动作。将构建函数替换为工厂函数。
封装向下转型(Encapsulate 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)
- 概要：某个继承体系同时承担两项责任。建立两个继承体系，并通过委托关系让其中一个可以调用另一个。
将过程化设计转化为对象设计(Convert Procedural Design to Objects)
- 概要：你手上有一些传统过程化风格的代码。将数据记录变成对象，将行为分成，并将行为移入相关对象之中。
将领域和表述/显示分离(Separate Domain from Presentation)
- 概要：某些GUI类之中包含了领域逻辑。将领域逻辑分离出来，为它们建立独立的领域类。
提炼继承体系(Extract Hierarchy)
- 概要：你有某个类做了太多工作，其中一部分工作是以大量条件表达式完成的。建立继承体系，以一个子类表示一种特殊情况。
