第1章 重构,第一个案例
1.1 起点
当你发现自己需要为程序添加一个特性,而代码结构使你无法很方便第达成目的,那就先重构那个程序,使特性的添加比较容易进行,然后再添加特性
1.2 重构的第一步
为即将修改的代码建立一组可靠的测试环境。
1.3 分解并重组
将长长的函数切开,并将较小块的代码移至更合适的类。
1.4 运用多态取代条件逻辑
最好不要在另一个对象的属性基础上运用switch语句,如果不得不使用,也应该在对象自己的数据上使用,而不是在别人的数据上使用。
第2章 重构原则
2.1 何谓重构
- 名词定义:对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低其修改成本。
- 动词定义:还用一系列重构手法,在不改变软件可观察行为的前提下,调整期结构
2.2 为何重构
- 重构改变软件结构,消除重复代码。
- 重构让软件更容易理解
- 重构帮助找到bug
- 重构提高编程速度
2.3 何时重构
- 三次:
- 第一次做某件事时只管去做;
- 第二次做类似事情的时候回产生反感,但无论如何还是可以去做
- 第三次再做类似的事,你就应该重构;
事不过三,三则重构
- 修补错误时重构
- 复审代码时重构
2.4 怎么跟经理说
不要跟经理说,哈哈哈哈,我能说是我老大让我来看的这本书吗
2.5 重构的难题
- 数据库
- 修改接口
- 难以通过重构手法完成的设计改动
重构与设计
重构与设计互补
重构与性能
标准:
- 时间预算
- 持续关注
第3章 代码的坏味道
- 重复代码
- 过长函数
- 过大的类
- 过长的参数列
- 发散式变化:一个类只应该有一个修改的原因
- 霰弹式修改:如果每遇到某种变化,你都必须在许多不同的类内做出许多小修改。
- 依恋情结:某个函数为了计算某个值,从另一个对象那儿调用了几乎半打的取值函数
- 数据泥团:两个类中相同的字段,许多函数签名中相同的参数
- 基础类型偏执:做了不必要的封装
- switch的问题
- 平行继承体系
- 冗赘类:没有太大的利用价值
- 夸夸其谈未来性:过度设计
- 令人迷惑的暂时字段:
- 过度耦合的消息链
- 中间人:某个类接口有一半的函数都委托给其他类
- 狎昵关系:两个类过于亲密
- 异曲同工的类
- 不完美的库类
- 纯稚的数据类:只有成员变量而没有函数
- 被拒绝的遗赠:子类应该继承父类的函数和数据,但如果他们不想要或者不需要。
- 过多的注释
第4章 构筑测试体系
4.1 自测试代码的价值
每个类都应该有用于测试的main();
Junit测试框架
频繁地进行测试,每次编译请把测试也考虑进去——每天至少执行每个测试一次。
第5章 重构列表
5.1 重构的记录格式
五个部分:
- 名称:构建一个重构词汇表
- 简短概要:简单介绍此一重构手法的适用场景
- 动机:为什么要重构
- 做法
- 范例
5.2 寻找引用点
一个适当的文本查找工具
第6章 重新组织函数
6.1 提炼函数
- 名称:提炼函数
- 概要:将这段代码放进一个独立函数中,并让函数名称解释该函数的用法。
- 动机:粒度越小,复用机会越大。
6.2 内联函数
- 名称:内联函数
- 概要:在函数调用点插入函数本体,然后移除该函数。
6.3 内联临时变量
- 名称:内联临时变量
- 概要:你有一个临时变量,只被一个简单表达式赋值一次,而它妨碍了其他重构手法,将所有对该变量的引用动作,替换为对它赋值的那个表达式自身。
6.4 以查询取代临时变量
- 名称:以查询取代临时变量
- 概要:你的程序以一个临时变量保存某一表达式的运算结果。将这个表达式提炼到一个独立函数中,将这个临时变量的所有引用点替换为对新函数的调用,此后,新函数就可被其他函数使用。
6.5 引入解释性变量
- 名称:引入解释性变量
- 概要:你有一个复杂的表达式。将该复杂表达式的结果放进一个临时变量,以此变量名称来解释表达式用途。
6.6 分解临时变量
- 名称:分解临时变量
- 概要:你的程序有某个临时变量被赋值超过一次,它既不是循环变量,也不被用于收集计算结果。针对每次赋值,创造一个独立,对应的临时变量
6.7 移除对参数的赋值
- 名称:移除对参数的赋值
- 概要:代码对一个参数进行赋值,以一个临时变量取代该参数的位置
6.8 以函数对象取代函数
- 名称:以函数对象取代函数
- 概要:你有一个大型函数,其中对局部变量的使用使你无法抽取函数,将这个函数放进一个独立对象中,如此一来局部变量就成了对象内的字段,然后你可以在同一个对象中将这个大型函数分解为多个小型函数。
6.9 替换算法
- 名称:替换算法
- 概要:你想要把某个算法替换为另一个清晰的算法,将函数本体替换为另一个算法。
第7章 在对象之间搬移特性
7.1 搬移函数
- 名称:搬移函数
- 概述:有个函数与其所驻类之外的另一个类进行更多交流;调用后者,或者被后者调用。在该函数最常引用的类中建立一个有着类似行为的新函数。将旧函数变成一个单纯的委托函数,或是将旧函数完全移除。
7.2 搬移字段
- 名称:搬移字段
- 概述:在你的程序中,某个字段被其所驻类之外的另一类更多地用到。**在目标类新建一个字段,修改原字段的所有用户,令它们改用新字段。
7.2 提炼类
- 名称:提炼类
- 概述:某个类做了应该由两个类做的事。建立一个新类,将相关的字段和函数从旧类搬移到新类
7.4 将类内联化
- 名称:将类内联化
- 概述:某个类没有做太多事情,将这个类的所有特性搬移到另一个类中,然后移除原类。
7.5 隐藏委托关系
客户通过一个委托类来调用另一个对象。 在服务类上建立客户所需的所有函数,用以隐藏委托关系
7.6 移除中间人
某个类做了过多的简单委托动作 ** 让客户直接调用受托类**
7.7 引入外加函数
你需要为提供服务的类增加一个函数,但你无法修改这个类 在客户类中建立一个函数,并以第一参数形式传入一个服务类实例
7.8 引入本地扩展
你需要为服务类提供一些额外函数,但你无法修改这个类 **建立一个新类,使它包含这些额外函数,让这个扩展品成为源类的子类或者包装类。
第8章 重新组织数据
8.1 自封装字段
你直接访问一个字段,但与字段之间的耦合关系逐渐变得笨拙 ** 为这个字段建立取值/设值函数,并且只以这些函数来访问字段。**
8.2 以对象取代数据值
你有一个数据项,需要与其他数据和行为一起使用才有意义 将数据项变为对象
8.3 将数值对象改为引用对象
你从一个类衍生出许多彼此相等的实例,希望将他们替换为同一个对象; 将这个值对象变成引用对象
8.4 将引用对象改为值对象
你有一个引用对象,很小且不可变,而且不易管理 将它变为一个值对象
8.5 以对象取代数组
你有一个数组,其中的元素各自代表不同的东西 以对象替换数组,对于数组中的每个元素,以一个字段来表示
8.6 复制被监视数据
你有一些领域数据置身于GUI控件中,而领域函数需要访问这些数据 将该数据复制到一个领域对象中。建立一个Observer模式,用以同步领域对象和GUI对象内的重复数据
8.7 将单向关联改为双向关联
两个类都需要使用对方特性,但其间只有一条单向连接。 添加一个反向指针,并使修改函数能够同时更新两条连接。
8.8 将双向关联改为单向关联
两个类之间有双向关联,但其中一个类如今不再需要另一个类的特性。 去除不必要的关联
8.9 以字面常量取代魔法数
你有一个字面数值,带有特别含义 创造一个常量,根据其意义为它命名,并将上述的字面数值替换为这个常量。
8.10 封装字段
你的类中存在一个public字段 将它声明为private,并提供相应的访问函数
8.11 封装集合
有一个函数返回一个集合 让这个函数返回该集合的一个只读副本,并在这个类中提供添加/移除集合的函数
8.12 以数据类取代记录
你需要面对传统编程环境中的记录结构 为该记录创建一个哑数据对象
8.13 以类取代类型码
类之中有一个数值类型码,但它并不影响类的行为 以一个新类替换该数值类型码
8.14 以子类取代类型码
你有一个不可变的类型码,它会影响类的行为 以子类取代这个类型码
8.15 以State/Strategy取代类型码
你有一个类型码,它会影响类的行为,但你无法通过继承手法去消除它。以状态对象取代类型码
8.16 以字段取代子类
你的各个子类的唯一差别只在“返回常量数据”的函数身上 ** 修改这些函数,使他们返回超类中的某个新增字段,然后销毁子类。**
第9章 简化条件表达式
9.1 分解条件表达式
你有一个复杂的条件(if-then-else)语句 从if,then,else三个段落中分别提炼出独立函数
9.2 合并条件表达式
你有一系列条件测试,都得到相同结果 将这些测试合并为一个条件表达式,并将这个条件表达式提炼成为一个独立函数
9.3 合并重复的条件片段
在条件表达式的每个分支上有着相同的一段代码 将这段重复代码搬移到条件表达式之外
9.4 移除控制标记
在一系列布尔表达式中,某个变量带有“控制标记”的作用 以break语句或者return语句取代控制标记
9.5 以卫语句取代嵌套条件表达式
函数中的条件逻辑晒人难以看清正常的执行路径 给某一条分支以特别的重视,如果使用if-then-else结构,你对if分支和else分支的重视是同等的。
9.6 以多态取代条件表达式
有一个表达式,它根据对象类型的不同而选择不同的行为 将这个条件表达式的每个分支放进一个子类内的覆盖函数中,然后将原始函数声明为抽象函数
9.7 引入NULL对象
如果你需要再三检查某个对象是否为null 将null值替换为null对象
9.8 引入断言
某一段代码需要对程序状态做出某种假设 以断言表达这种假设
第10章 简化函数调用
10.1 函数改名
函数的名称未能揭示函数的用途
修改函数名称
10.2 添加参数
某个函数需要从调用短得到更多信息 为此函数添加一个对象参数,让该对象带进函数所需信息
10.3 移除参数
函数本体不再需要某个参数 将该参数去除
10.4 将查询函数和修改函数分离
某个函数既返回对象状态值,又修改对象状态 建立两个不同的函数,其中一个负责查询,另外一个负责修改
10.5 令函数携带参数
若干函数做了类似的工作,但在函数本体中却包含了不同的值 建立单一函数,以参数表达那些不同的值。
10.6 以明确函数取代参数
你有一个函数,其中完全取决于参数值而采取不同的行为 针对该参数的每一个可能值,建立一个独立函数
10.7 保持对象完整
你从某个对象中取出若干值,将它们作为某一次函数调用时的参数 改为传递整个对象
10.8 以函数取代参数
对象调用某个函数,并将所得结果作为参数,传递给另一个函数,而接受该参数的函数本身也能够调用前一个函数。 让参数接受去除该项参数,并直接调用前一个函数
10.9 引入参数对象
某些参数总是很自然地同时出现 以一个对象取代这些参数
10.10 移除设值函数
类中的某个字段应该在对象创建时被设值,然后不再改变。 去掉该字段的所有设值函数
10.11 隐藏函数
有一个函数,从来没有被其他类用到 将这个函数修改为private
10.12 以工厂方法取代构造函数
希望在创建对象时不仅仅是做简单的建构动作 将构造函数替换为工厂方法
10.13 封装向下转型
某个函数返回的对象,需要由函数调用者执行向下转型 将向下转型动作移到函数中
10.14 以异常取代错误码
某个函数返回一个特定的代码,用以表示某种错误情况 改用异常
10.15 以测试取代异常
面对一个调用者可以预先检查的条件,你抛出了一个异常 修改调用者,使它在调用暗黑少女胡之前先做检查
第11章 处理继承关系
11.1 字段上移
当两个字段拥有相同的字段时,将该字段移至超类。
11.2 函数上移
有些函数,在各个子类中产生完全相同的结果 将该函数移至超类
11.3 构造函数本体上移
你在各个子类中拥有一些构造函数,他们的本体几乎完全一致 在超类中新建一个构造函数,并在子类构造函数中调用它
11.4 函数下移
超类中的某个函数只与部分子类有关 将这个函数移到相关的那些子类去
11.5 字段下移
超类中的某个字段只被部分子类用到 将这个字段移到需要他的那些子类去
11.6 提炼子类
类中的某些特性只被某些实例用到 新建一个子类,将上面所说的那一部分特性移至子类中
11.7 提炼超类
两个类有相似特性 为这两个类建立一个超类,将相同特性移至超类
11.8 提炼接口
若干客户使用类接口中的同一子集,或者两个类的接口有部分相同。 将相同的子集提炼到一个独立的接口中
11.9 折叠继承体系
超类和子类之间无太大区别 将它们合为一体
11.10 塑造模板函数
你有一些子类,其中相应的某些函数以相同的顺序执行类似的操作,但各个操作的细节上有所不同。 将这些操作分别放进独立函数中,并保持它们都有相同的签名,于是原函数也就变得相同了,然后将原函数上移至超类
11.11 以委托取代继承
你在两个类之间使用委托关系,并经常为整个接口编写许多极简单的委托函数 让委托类继承受托类
11.12 以继承取代委托
第12章 大型重构
12.1 梳理并分解继承体系
某个继承体系同时承担这两项责任 建立两个继承体系,并通过委托关系让其中一个可以调用另一个
12.2 将过程化设计转化为对象设计
你手上有一些传统过程化风格的代码 将数据记录变成对象,将大块的行为分成小块,并将行为移入相关对象之中。
12.3 将领域和表述/显示分离
某些GUI类之中包含了领域逻辑 将领域逻辑分离出来,为它们建立独立的领域类
12.4 提炼继承体系
你有某个类做了太多工作,其中一部分工作是以大量条件表达式完成的 建立继承体系,以一个子类表示一种特殊情况