Refactoring: Improving the Design of Existing Code

ref: 重构:改善既有代码的设计
Refactoring: Improving the Design of Existing Code

Ch 1 重构,第一个案例

重构的第一个步骤永远相同:我得为即将修改的代码建立一组可靠的测试环境。

好的测试是重构的根本。

Ch 2 重构原则

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

Ch 3 代码的坏味道

3.1 Duplicated Code 重复代码
3.2 Long Method 过程函数
更加积极的分解函数。
原则:每当感觉需要以注释来说明点什么的时候,我们就把需要说明 东西写进一个独立的函数,并以其用途命名。

函数名命名关键:在于函数“做什么”和“如何做”之间的语义距离。

3.3 Large Class 过大的类

3.4 Long Parameter List 过长的参数列

3.5 Divergent Change 发散式变化

3.6 Shotgun Surgery 散弹式修改

3.7 Feature Envy 依恋情节

3.8 Data Clumps 数据泥团

3.9 Primitive Obsession 基本类型偏执

3.10 Switch Statements Switch 语句

3.11 Parallel Inheritance Hierarchy 平行继承体系

3.12 Lazy Class 冗余类

3.13 Speculative Generality 夸夸其谈未来性

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

3.15 Message Chains 过度耦合的消息链

3.16 Middle Man 中间人

3.17 Inappropriate Intimacy 狎昵关系

3.18 Alternative Classes with Different Intefaces 异曲同工的类

  1. 19 Imcomplete Library Class 不完美的库类

3.20 Data Class 数据类

3.21 Befused Bequest 被拒绝的遗赠

3.22 Comments 过多的注释

但你感觉需要撰写注释时,请先尝试重构,试着让所有注释够变得多余。

Ch 4 构筑测试体系

每当你收到bug报告,前先写一个单元测试来暴露这个bug。

Ch 5 重构列表

Ch 6 重新组织函数

6.1 Extract Method 提炼函数
6.2 Inline Method 内联函数
一个函数的本体与名称同样清楚易懂。
6.3 Inline Temp 内联临时变量
6.4 Replace Temp with Query 以查询取代临时变量
你的程序以一个临时变量保存某一表达式的运算结果。

将表达式提炼到一个独立的函数里。

Example:

double getPrices() {
    list basePrice = quantity * itemPrice;
    double discountFactor;
    if (basePrice > 1000)
         discountFactor = 0.95;
     else 
         discountFactor = 0.98;
     return basePrice * discountFactor;
}

After refactoring:

double getPrice() {
     return basePrice() * discountFactor();
}

private double discountFactor {
     if (basePrice() > 1000)
         return 0.95;
   else 
         return 0.98;
}

private int basePrice() {
     return this.quantity * this.itemPrice;
}

6.5 Introduce Explaining Variable 引入解释性变量
你有一个复杂的表达式

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

6.6 Split Temporary Variables 分解临时变量

你的程序有某个临时变量被赋值超过一次,它既不是循环变量,也不被用与收集计算结果。

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

同一个临时变量承担两件不同的事情,会令代码阅读者糊涂。

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

代码对一个参数进行赋值

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

6.8 Replace Method with Method Object 以函数对象取代函数
你有一个大型函数,其中对局部对象的使用是你无法采用Extract Method

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

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

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

Ch 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 引入外加函数
你需要为提供服务的类增加一个函数,但你无法修改这个类。

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

Date start = new Date(priviousEnd.getYear(), previous.getMonth(), privious.getDate() + 1);

Refactoring:

Date start = nextDay(previousEnd);

private static Date nextDay(Date arg) {
    return new Date (arg.getYear(), arg.getMonth(), arg.getDate() + 1);
}

7.8 Introduce Local Extension 引入本地扩展
你需要为服务类提供一些额外函数,但你无法修改这个类。

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

Ch 8 重新组织数据

8.1 Self Encapsulate Field 自封装字段
你直接访问一个字段,但与字段之间的耦合关系逐渐变得笨拙。

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

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

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

将数据项变成对象

8.3 Change Value to Reference 将值对象改为引用对象
你从一个类衍生出许多彼此相等的实例,希望将它们替换为同一个对象。

将这个值对象变成引用对象。

8.4 Change Reference to Value
你有一个引用对象,很小且不可变,而且不易管理。

将它变为一个值对象。

8.5 Replace Array with Object
你有一个数据组,其中的元素各自代表不同的东西。

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

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

  1. 11 Encapsulate Collection
    有一个函数返回一个集合。

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

集合的取值函数不应该返回集合本身,因为这会让用户得以修改结合内容而集合拥有却一无所知。

8.12 Replace Record with Data Class 以数据类取代记录
你需要面对传统编程环境中的记录结构。

为该结构建立一个哑数据对象

8.13 Replace Type Code with Class

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

以一个新的类替代该数值类型码。

More Important:
任何switch语句都应该运用Replace Conditional with Polymorphism去掉

8.14 Replace Type Code with Subclasses

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

以子类取代这个类型码。

这种表达式可能有两种表现形式:switch语句或者if-then-else结构,不论哪种形式,它们都是检查类型码值,并根据不同的值执行不同的动作。

  • 如果宿主类有了子类,就需要使用Replace Type Code with State/Strategy

  • Replace Type Code with Subclasses 的好处在于:它把“对不同行为的了解”从类用户那儿转移到了类自身。如果需要再加入新的行为变化,只需要添加一个类就行了。如果没有多态机制,就必须找到所有条件表达式,并逐一修改它们。因此,如果未来还有可能加入新行为,这项重构将特别有价值。

8.15 Replace Type Code with State/Strategy

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

以状态对象取代类型码。

8.16 Replace Subclasses with Fields

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

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

Ch 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 移除控制标记

在一系列布尔表达式,某个变量带有控制标记

以break语句或return语句取代控制标记。

9.5 Replace Nested Conditional with Guard Clauses
在函数中的条件逻辑使人难以看清正常的执行路径。

使用卫语句表现所有的特殊情形。

如果某个条件极其罕见,就应该单独检测该条件,并在该条件为真时立刻从函数返回。这样的单独检测常常被称为:卫语句(Guard Clauses)

9.6 Replace Conditional with Polymorphism
你手上有个条件表达式,他根据对象类型的不同而选择不同的行为。

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

9.7 Introduce Null Object
你需要再三检查某个对象是否为null

将null值替换为null对象。

9.8 Introduce Assertion
某段代码需要对程序状态做出某种假设。

以断言明确表达这种假设。

Ch 10 简化函数调用

  1. 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 Method

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

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

10.7 Preserve Whole Object
你从某个对象中去除若干之,将他们作为某一次函数调用时的参数。

改为传递整个对象。

10.8 Replace Parameter with methods 以函数代替参数
对象调用哪个某个哈数,并将所得结果作为参数,传递给另一个函数,而接受该参数的函数本身也能调用前一个函数。

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

10.9 Introduce Parameter Object
某些参数总是很自然的同时出现。

以一个对象取代这些参数。

10.10 Remove Setting Method
类中的某个字段应该在对象创建爱你是被设值,然后不再改变。

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

10.11 Hide Method
有一个函数,从来没有被任何类用到。

将这个函数修改为private

1012 Replace Constructor with Factory Method

  • 最显而易见的动机:
    在派生子类的过程中以工厂函数取代类型码。

10.13 Encapsulate Downcast 封装向下转型
某个函数返回的对象,需要都函数调用者执行向下转型。

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

10.14 Replace Error Code with Exception

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

改为异常。

  1. 15 Replace Exception with Test
    面对一个调用者可以预先检查的条件,你抛出了一个异常。

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

Ch 11 处理概括关系

概括关系,Generalization,继承关系

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 Subclasses
类中某些特性只被某些实例用到

新建一个子类将上面所说的那一部分特性移到子类中。

11.7 Extract Superclass
两个类有相似的特性

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

11.8 Extract Interface

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

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

11.9 Collapse Hierarchy
超类和子类没有太大区别。

将它们合为一体。

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

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

  • 继承是避免重复行为的强大工具。

11.11 Replace Inheritance with Delegation
某个子类只能使用超类接口中的一部分,或是根本不需要继承而来的数据。

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

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

让委托类继承受托类。

Ch 12 大型重构

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

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

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

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

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

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

12.3 Separate Domain from Presentation
某些类GUI类包含了领域逻辑。

江铃域逻辑风里出来,为他们建立独立的领域类。

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

建立继承体系,一一个子类展示一种特殊情况。

Ch 13 重构,复用与现实

你可能感兴趣的:(Refactoring: Improving the Design of Existing Code)