前言
P2(页码)
什么是重构?
所谓重构( refactoring)是这样一个过程:在不改变代码外在行为的前提下,对代码做出修改,以改进程序的内部结构。重构是一种经干锤百炼形成的有条不紊的程序整理方法,可以最大限度地减少整理过程中引入错误的几率。本质上说,重构就是在代码写好之后改进它的设计。
P5
重构技术的两位最早倡导者是 Ward Cunningham和 Kent Beck。他们很早就把重构作为开发过程的一个核心成分,并且在自己的开发过程中运用它。
第1章
P7
idea:如果你发现自己需要为程序添加一个特性,而代码结构使你无法很方便地达成目的,那就先重构那个程序,使特性的添加比较容易进行,然后再添加特性。
P8
重构需要依赖可靠的测试
进行重构的时候,我们需要依赖测试,让它告诉我们是否引入了bug。好的测试是重构的根本。花时间建立一个优良的测试机制是完全值得的,因为当你修改程序时,好测试会给你必要的安全保障。
P15
更改变量名称是值得的行为吗?
绝对值得。好的代码应该清楚表达出自己的功能,变量名称是代码清晰的关键。如果为了提高代码的清晰度,需要修改某些东西的名字,那么就大胆去做吧。只要有良好的查找替换工具,更改名称并不困难。语言所提供的强类型检查以及你自己的测试机制会指出任何你遗漏的东西。
代码可读性的重要性
记住:任何一个傻瓜都能写出计算机可以理解的代码。唯有写出人类容易理解的代码,才是优秀的程序员。
第2章 重构原则
P53
何为重构?
- 重构(名词)对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低其修改成本。
- 重构(动词)使用一系列重构手法,在不改变软件可观察行为的前提下,调整其结构。
P54
重构行为有以下两个特征:
- 重构的目的是使软件更容易被理解和修改。
- 重构不会改变软件可观察的行为,重构之后软件功能如以往。
P55
为何重构?
重构是个工具,它可以(并且应该)用于以下几个目的。
-
重构改进软件设计。
如果没有重构,程序的设计会逐渐腐败变质
-
重构使软件更容易理解。
提高代码可读性
-
重构帮助找到bug。
重构后的代码,能更深入的理解代码的作为,更容易揪出bug
-
重构提高编程速度。
良好的设计是快速开发的根本
P57
三次法制:第一次做某件事时只管去做;第二次做类似的事会产生反感,但无论如何还是可以去做;第三次再做类似的事,你就应该重构。
何时重构?
- 添加功能时重构
- 修复错误时重构
- 复审代码时重构
P62
重构一般会遇到的难题:
-
数据库。重构经常出问题的一个领域就是数据库。绝大多数商用程序都与它们背后的数据库结构紧密耦合在一起,这也是数据库结构如此难以修改的原因之一。另一个原因是数据迁移( migration)。就算你非常小心地将系统分层,将数据库结构和对象模型间的依赖降至最低,但数据库结构的改变还是让你不得不迁移所有数据,这可能是件漫长而烦琐的工作
-
修改接口。如果重构手法改变了已发布接口,你必须同时维护新旧两个接口,直到所有用户都有时间对这个变化做出反应。请尽量这么做:让旧接口调用新接口。当你要修改某个函数名称时,请留下旧函数,让它调用新函数。千万不要复制函数实现,那会让你陷入重复代码的泥淖中难以自拔。
-
难以通过重构手法完成的设计改动
第3章 代码的坏味道
-
duplicated code 重复代码
需要提炼重复的代码,然后调用被提炼出来的那一段代码。
-
long method 过长的函数
拥有短函数的对象会活得比较好、比较长。
-
large class 过大的类
-
long paramater list 过长参数列
-
divergent change 发散式变化
-
shotgun suegery 霰弹式修改
-
feature envy 依恋情结
-
data clumps 数据泥团
-
primitive obsession 基本类型偏执
-
switch statements switch 惊悚现身
可以考虑用多态技术来替换switch语句。
-
parallel inheritance hierarchies 平行继承体系
-
lazy class 冗余类
-
speculative generality 夸夸其谈未来性
-
temporary field 令人迷惑的暂时字段
-
message chains 过度耦合的消息链
-
middle man 中间人
过度运用委托,某个类可能有一半的函数都委托给其他类。
-
inappropriate intimacy 狎昵关系
继承往往造成过度亲密,因为子类对超类的里哦奥杰总是超过后者的主观愿望。
-
alternative classes with different interfaces 异曲同工的类
有不同签名的两个类,做着同一件事。
-
incomplete library class 不完美的库类
-
data class 纯稚的数据类
-
refused bequest 被拒绝的遗赠
-
comments 过多的注释
代码就是最好的注释!
第6章 重新组织函数
-
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 以函数对象取代函数
将这个函数放进一个单独对象中,如此一来局部变量就成了对象内的字段。然后你可以在同一个对象中将这个大型函数分解为多个小型函数。
-
substitute algorithm 替换算法
将函数本体替换为另一个算法。
第7章 在对象之间搬移特性
-
move method 搬移函数
你的程序中,有个函数与其所驻类之外的另一个类进行更多交流:调用后者,或被后者调用。
在该函数最常引用的类中建立一个有着类似行为的新函数,将旧函数变成一个单纯的委托函数,或是将旧函数完全移除。
-
move field 搬移字段
你的程序中。某个字段被其所驻类之外的另一个类更多地用到。在目标类新建一个字段,修改源字段的所有用户,令它们改用新字段。
-
extract class 提炼类
某个类做了应该由两个类做的事。
建立一个新类,将相关的字段和函数从旧类搬移到新类。
-
inline class 将类内联化
某个类没有做太多事情。
将这个类的所有特性搬移到另一个类中,然后移除原类。 -
hide delegate 隐藏委托关系
客户通过一个委托类来调用另一个对象。
在服务类上建立客户所需的所有函数,用以隐藏委托关系。 -
remove middle man 移除中间人
某个类做了过多的简单委托动作。
让客户直接调用受托类。 -
introduce foreign method 引入外加函数
你需要为提供服务的类增加一个函数,但你无法修改这个类。
在客户类中建立一个函数,并以第一参数形式传入一个服务类实例。 -
introduce local extension 引入本地扩展
你需要为服务类提供一些额外函数,但你无法修改这个类。
建立一个新类,使它包含这些额外函数。让这个扩展品成为源类的子类或包装类。
第8章 重新组织数据
-
self encapsulate field 自封装字段
你直接访问一个字段,但与字段之间的耦合关系逐渐变得笨拙。
为这个字段建立取值设值函数,并且只以这些函数来访问字段。
-
replace data value with object 以对象取代数据值
你有一个数据项,需要与其他数据和行为一起使用才有意义。
将数据项变成对象。 -
change value to reference 将值对象改为引用对象
你从一个类衍生出许多彼此相等的实例,希望将它们替换为同一个对象。
将这个值对象变成引用对象。 -
change reference to value 将引用对象改为值对象
你有一个引用对象,很小且不可变,而且不易管理。
将它变成一个值对象。
第9章 简化条件表达式
-
Decompose Conditional(分解条件表达式)
你有一个复杂的条件( if-then-else)语句。
从if、then、else三个段落中分别提炼出独立函数。 -
Consolidate Conditional Expression(合并条件表达式)
你有一系列条件测试,都得到相同结果。
将这些测试合并为一个条件表达式,并将这个条件表达式提炼成为一个独立函数。
-
Consolidate Duplicate Conditional Fragments
(合并重复的条件片段)在条件表达式的每个分支上有着相同的一段代码。
将这段重复代码搬移到条件表达式之外。 -
Remove Control Flag(移除控制标记)
在一系列布尔表达式中,某个变量带有"控制标记"(control flag)的作用。
以 break语句或 return语句取代控制标记。 -
Replace Nested Conditional with Guard clauses
(以卫语句取代嵌套条件表达式)函数中的条件逻辑使人难以看清正常的执行路径。
使用卫语句表现所有特殊情况。 -
Replace Conditional with Polymorphism
(以多态取代条件表达式)你手上有个条件表达式,它根据对象类型的不同而选择不同的行为。
将这个条件表达式的每个分支放进一个子类内的覆写函数中,然后将原始函数声明为抽象函数。 -
Introduce Null Object(引入Null对象)
你需要再三检查某对象是否为null。
将null值替换为null对象。
-
Introduce Assertion(引入断言)
某一段代码需要对程序状态做出某种假设。
以断言明确表现这种假设。
第10章 简化函数调用
-
Rename Method(函数改名)
函数的名称未能揭示函数的用途。
修改函数名称。 -
Add Parameter(添加参数)
某个函数需要从调用端得到更多信息。
为此函数添加一个对象参数,让该对象带进函数所需信息。 -
Remove parameter(移除参数)