重构

开篇的例子

开篇介绍了一个例子:

这是一个影片出租店用的程序,计算每一位顾客的消费金额并打印详单,操作者告诉程序:顾客租了哪些影片,租期多长,横须便根据租赁时间和影片类型计算出费用。影片分为三类:普通片,儿童片和新片。除了计算费用,还要为常客计算积分,积分会根据租片种类为新片而有不同。

建议读这本书的,一定要跟着这个例子走一下。看看大师是怎么一步步的重构的。

  • 重构的第一步永远相同,为即将修改的代码建立一组可靠的测试环境,这些测试必须有自我检验能力,好的测试时重构的根本

  • 代码块越小,代码的功能就越容易管理,代码的处理和移动也就越轻松

  • 临时变量的作用: 收集器、计数、解释、复用、元素(详见实现模式笔记)

  • 临时变量往往引发问题,它们只在所属的函数中有效,所以它们会助长冗长而复杂的函数。(它接受each.getCharge()的执行结果,然后就不再有任何改变,所以我可以运用replace temp with query把它除去)

  • 观察amountFor()时,我发现这个函数使用了来自Rental类的信息,却没有使用来自Customer类的信息(逻辑中的所有数据都来自另一个类,这时可以运用move method,将这段逻辑搬到另一个类中,逻辑要和数据在一起)。

  • 最好不要在另一个对象的属性基础上运用switch语句,如果不得不使用,也应该在对象自己的数据上使用,而不是在别人的数据上使用,原理同上条.

  • 计算费用时需要两项数据:租期长度和影片类型,为什么我选择将租期长度传给movie对象,而不是将影片类型传给rental对象呢?因为本系统可能发生的变化时加入新影片类型,这种变化带有不稳定倾向,如果影片类型有所变化,我希望尽可能控制它所造成的影响,所以选择在movie对象内计算费用。(某段逻辑需要来自不同对象的数据,那么看较易引起逻辑变化的数据来自哪个对象,就把这段逻辑放在那个对象所属的类,尽可能控制变化所造成的影响)

  • 重构时不要担心整体性能,优化时才需要担心它们。

  • 重构的一项重要技巧就是“寻找边界条件”

重构原则

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

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

  3. 两顶帽子:使用重构技术开发软件时,你把自己的时间分配成两种截然不同的行为:添加新功能,以及重构。无论何时,你应该清楚自己戴的是哪一顶帽子。

为何重构
  1. 重构改进软件设计:重构就是在整理代码,经常性的重构可以帮助代码维持自己该有的形态。

  2. 重构帮助找到bug:对代码的理解,可以帮助找到bug

  3. 重构提高编程速度:改善设计,提高可读性,减少错误,良好的设计是快速开发的根本。

何时重构
  1. 重构应该随时随地的进行。

  2. 添加功能时重构

    • 是否能对这段代码进行重构,使我能更快地理解它
    • 代码的设计无法帮助我轻松的添加我所需要的特性,如果用某种方式来设计,添加特性会简单很多,这种情况下我也会进行重构。
  3. 修补错误时重构

  4. 复审代码时重构

怎么对经理说

很多经理嘴巴上说自己“质量驱动”,其实更多是“进度驱动”,这种情况下我会给他们一个较有争议的建议:不要告诉经理(我觉得挺好),受进度驱动的经理要我尽可能快速完事,至于怎么完成,那就是我的事了,我认为最快的方式就是重构,所以我重构。

  1. 计算机科学是这样一门科学:它相信所有问题都可以通过增加一个间接层来解决。 ——Kent Beck

  2. 间接层是一柄双刃剑,每次都把一个东西分成两份,你就需要多管理一个东西。如果某个对象委托另一个对象,后者又委托另一对象,程序会愈加难以阅读。基于这个观点,你会希望尽量减少间接层。别急,伙计!间接层有它的价值:

    • 允许逻辑共享,比如说一个子函数在两个不同的地点被调用,或超类中的某个函数被所有子类共享
    • 分开解释意图和实现
    • 隔离变化
    • 封装条件逻辑
重构的难题
  1. 数据库
  2. 修改接口: 如果重构手法改变了已发布接口,你必须同时维护新旧两个接口,直到所有用户都要时间对这个变化做出反应,幸运的是,这不太困难,你通常都有办法把事情组织好,让旧接口继续工作,请尽量这么做:让旧接口调用新接口。

代码的坏味道

duplicated code (重复代码)
  1. extract method : 同一个类的两个函数含有相同的表达式

  2. pull up method : 两个互为兄弟的子类内含有相同表达式

  3. from template method : 两个互为兄弟的子类内含有相同表达式

  4. substitute algorithm : 有两个函数以不同的算法做着相同的事,可以选择其中一个较清晰的一个,将其他函数的算法替换掉

  5. extract class : 如果两个毫不相关的类出现重复代码

long method (过长函数)
  1. extract method : 百分之九十九的场合里

  2. replace temp with query :如果函数内有大量临时变量

  3. introduce parameter object :如果函数有大量的参数

  4. perserve whole object(保持对象完整) :如果函数有大量的参数

  5. replace method with method object :

  6. decompose conditional: 条件表达式是提炼的信号

  7. 循环也是提炼的信号。

Large class (过大的类)
  1. extract class:

  2. extract subclass:

  3. duplicate observed data:

long parameter list(过长参数列表)
  1. replace parameter with method:如果向已有的对象发出一条请求就可以取代一个参数

  2. preserve whole object:将来自同一个对象的一堆数据收集起来,并以该对象替换它们

  3. introduce parameter object: 如果某些收却反合理的对象归属,可以为他们制造一个“参数对象”

  4. 有时候你明显不希望造成“被调用对象”与“较大对象”之间的某种依赖关系,这时候将数据从对象中拆解出来单独作为参数也是合情合理的。

divergent change (发散式变化)
  1. extact class :如果某个类经常因为不同的原因在不同的方向上发生变化
shotgun surgey (霰弹式修改)
  1. move method、move field :如果每遇到某种变化,你都必须在许多不同的类内做出许多小修改

divergent change是指“一个类受多种变化的影响”

shotgun surgey是指“一种变化引发多个类相应修改”

feature ency (依恋情结)
  1. move method : 函数对某个类的兴趣高过对自己所处类的兴趣

  2. extract method :

data clumps (数据泥团)
  1. extract class :你常常可以在很多地方看到相同的三四项数据:两个类中相同的字段,许多函数签名中相同的参数

  2. introduce parameter object:

  3. preserve whole object :

一个好的评判办法是: 删除众多数据中的一项。这么做,其他数据并没有因而失去意义?如果他们不再有意义,这就是个明确的信号:你应该为它们产生一个新对象。(变化率)

primitive obsession(基本类型偏执)
  1. replace data value with object: 将原本单独存在的数据值替换成对象

  2. replace type code with class : 如果想要替换的数据值是类型码,而它并不影响行为

  3. replace type code with subclass: 如果你有与类型码相关的条件表达式

  4. replace type code with state/strategy: 同上

  5. extract class: 如果有一组总是被发在一起的字段

  6. introduce parameter object: 如果你在参数列表中看到基本数据

  7. replace array with object: 如果你发现自己正从数组中挑选数据

switch statements (switch 语句)
  1. extract method

  2. replace type code with subclass

  3. replace type code with state/strategy

  4. replace conditional with polymorphism

  5. replace parameter with explicit methods

  6. introduce null object

parallel inheritance hierarchies (平行继承体系)
  1. move method

  2. move field

shotgun surgery的特殊情况

lazy class (冗赘类)
  1. collapse hierarchy

  2. inline class

speculative generality (夸夸其谈未来性)
  1. collapse hirerchy

  2. iniline class

  3. remove parameter

  4. rename method

temporary field (令人迷惑的暂时字段)
  1. extract class

  2. introduce null object

message chains(过度耦合的消息链)
  1. hide delegate

  2. extract method

  3. move method

middle man (中间人)
  1. remove middle man

  2. inline method

  3. replace delegation with inheritance

inappropriate intimacy (狎昵关系)
  1. move method

  2. move field

  3. change bidirectional association to unidirectional

  4. extract class

  5. hide delegate

  6. replace inheritance with delegation

alternative classes with different interfaces
  1. rename method

  2. move method

  3. extract superclass

incomplete library (不完美的库类)
  1. move method

  2. introduce foreign method

  3. introduce local extension

data class (纯稚的数据类)
  1. encapsulate field

  2. encapsulate collection

  3. remove setting method

  4. move method

  5. extract method

  6. hide method

refused bequest (被拒绝的遗赠)
  1. push down method

  2. push down field

  3. replace inheritance with delegation

comments (过多的注释)
  1. extract method

  2. rename method

  3. introduce assertion

重构列表

Add Parameter(添加参数) 275

  1. 某个函数需要从调用端得到更多信息,为此函数添加一个对象参数,让该参数带进函数所需信息。

Change Bidirectional Association to Unidirectional(将双向关联改为单向) 200

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

Change Reference to Value(将引用对象改为实值对象) 183

  1. 你有一个引用对象,很小且不可变,而且不易管理,将它变成一个值对象。

Change Unidirectional Association to Bidirectional(将单向关联改为双向) 197

  1. 两个类都需要使用对方特性,但其间只有一条单向连接,添加一个反向指针,并使修改函数能够同时更新两条连接。

Change Value to Reference(将实值对象改为引用对象) 179

  1. 你从一个类衍生出许多彼此相等的实例,希望将它们替换为同一个对象,将这个值对象变成引用对象

Collapse Hierarchy(折叠继承体系) 344

  1. 超类和子类之前无太大区别,将它们合为一体。

Consolidate Conditional Expression(合并条件式) 240

  1. 你有一系列条件测试,都得到相同结果,将这些测试合并为一个条件表达式,并将这个条件表达式提炼为一个独立函数。

Consolidate Duplicate Conditional Fragments(合并重复的条件片段) 243

  1. 在条件表达式的每个分支上有着相同的一段代码,将这些重复代码搬移到条件表达式之外。
  2. 我们也可以使用同样的手法来对待异常

Convert Procedural Design to Objects(将过程化设计转化为对象设计) 368

  1. 你手上有一些传统过程化风格的代码,将数据记录变成对象,将大块的行为分为小块,并将行为移入相关对象之中。

Decompose Conditional(分解条件式) 238

  1. 你有一个复杂的条件语句,从if、then、else三个段落分别提炼出独立函数

Duplicate Observed Data(复制「被监视数据」) 189

  1. 你有一些领域数据置身于gui控件中,而领域函数需要访问这些数据。将该数据复制到一个领域对象中。建立一个Observer模式,用于同步领域对象和GUI对象内的重复数据。

Encapsulate Collection(封装群集) 208

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

Encapsulate Downcast(封装「向下转型」动作) 308

  1. 某个函数返回的对象,需要由函数调用者执行向下转型(downcast),将向下转型动作移到函数中。

Encapsulate Field(封装字段) 206

  1. 你的类中存在一个public字段,将它声明为private,并提供相应的访问函数。

Extract Class (提炼类) 149

  1. 某个类做了应该由两个类做的事,建立一个新类,将相关的字段和函数从旧类搬移到新类

Extract Hierarchy(提炼继承体系) 375

  1. 你有某个类做了太多工作,其中一部分工作是以大量条件表达式完成的,建立继承体系,以一个子类表示一种特殊情况。

Extract Interface(提炼接口) 341

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

Extract Method(提炼函数) 110

  1. 无局部变量
  2. 有局部变量,包括传入原函数的参数和源函数所声明的临时变量
    • 局部变量只是读取这些变量,并不修改它们
    • 源函数的参数被赋值
    • 临时变量只在被提炼代码中使用
    • 被提炼代码段之外的代码也使用了这个变量

例子:

简单工厂:当我发现一个类的实例化逻辑除了new Instance(), 还有一些别的动作,那我会用extract method,提出一个方法,当多个类都会实例化这个类,那么还会运用extract class,置于提到类本身或者再专门搞个工厂类。(他们都是想通的)

Extract Subclass(提炼子类) 330

  1. 类中的某些特性只被某些(而非全部)实例用到,新建一个子类,将上面所说的那有部分特性移到子类中。

Extract Superclass(提炼超类) 336

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

Form Template Method(塑造模板函数) 345

  1. 你有一些子类,其中相应的某些函数以相同顺序执行类似的操作,但各个操作的细节上有所不同,将这些操作分别放进独立函数中,并保持它们都有相同的签名,于是原函数也就变得相同了,然后将原函数上移至超类。

Hide Delegate(隐藏「委托关系」) 157

  1. 客户通过一个委托类来调用另一个对象,在服务类上建立客户所需的所有函数,用以隐藏委托关系
    • 如果某个客户通过服务对象的字段得到另一个对象,然后调用后者的函数,那么客户就必须知晓这一层委托关系。万一委托关系发生变化,客户也得相应变化,将委托关系隐藏起来,从而去除这种依赖。这么一来即便将来发生委托关系上的变化,变化也将被限制在服务对象中,不会波及客户。

Hide Method(隐藏某个函数) 303

  1. 有一个函数,从来没有被其他任何类用到,将这个函数修改为private

Inline Class(将类内联化) 154

  1. 某个类没有做太多事情,将这个类的所有特性搬移到另一个类里,然后移除原类。

Inline Method(将函数内联化) 117

  1. 一个函数的本体与名称同样清楚易懂,在函数调用点插入函数本体,然后移除该函数

Inline Temp(将临时变量内联化) 119

  1. 临时变量只被一个简单表达式赋值一次,而它妨碍了其他重构手法,将所有对该变量的引用动作,替换为对它赋值的那个表达式自身

Introduce Assertion(引入断言) 267

  1. 某一段代码需要对程序状态做出某种假设,以断言明确表现这种假设。

Introduce Explaining Variable(引入解释性变量) 124

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

Introduce Foreign Method(引入外加函数) 162

  1. 你需要为提供服务的类增加一个函数,但你无法修改这个类,在客户类中建立一个函数,并以第一参数形式传入一个服务类实例。

Introduce local Extension(引入本地扩展) 164

  1. 你需要为服务类提供一些额外函数,但你无法修改这个类,建立一个新类,使它包含这些额外函数。让这个扩展品成为源类的子类或者包装类。

Introduce Null Object(引入 Null 对象) 260

  1. 你需要再三检查某对象是否为null,将null值替换为null对象。

Introduce Parameter Object(引入参数对象) 295

  1. 某些参数总是很自然地同时出现,以一个对象取代这些参数。

Move Field(搬移值域) 146

  1. 在你的程序中,某个字段被其所驻类之外的另一个类更多的用到,在目标类新建一个字段,修改源字段的所有用户,令它们改用新字段。

Move Method(搬移函数) 142

  1. 你的程序中,有个函数与其所驻类之外的另一个类进行更多交流:调用后者,或被后者调用,在该函数最常引用的类中建立一个有着类似行为的新函数,将旧函数变成一个单纯的委托函数,或是将旧函数完全移除。

Parameterize Method(令函数携带参数) 283

  1. 若干函数做了类似的工作,但在函数本体中却包含了不同的值,建立单一函数,以参数表达那些不同的值

Preserve Whole Object(保持对象完整) 288

  1. 你从某个对象中取出若干值,将它们作为某一次函数调用时的参数改为传递整个对象。
  2. 不过事情总有两面,如果你传的是数值,被调用函数就只依赖于这些数值,而不依赖它们所属的对象。但如果你传递的是整个对象,被调用函数所在的对象就需要依赖参数对象。如果这回是你的依赖结构恶化,那么就不该使用perserve whole object。

Pull Up Constructor Body(构造函数本体㆖移) 325

  1. 你再各个子类中拥有一些构造函数,它们的本体几乎完全一致,在超类中新建一个构造函数,并在子类构造函数中调用它。

Pull Up Field(值域㆖拉) 320

  1. 两个子类拥有相同的字段,将该字段移至超类。

Pull Up Method(函数㆖拉) 322

  1. 有些函数,在各个子类中产生完全相同的结果,将该函数移至超类。

Push Down Field(值域㆘移) 329

  1. 超类中的某个字段只被部分(而非全部)子类用到,将这个字段移到需要它的那些子类去。

Push Down Method(函数㆘移) 328

  1. 超类中的某个函数只与部分(而非全部)子类有关,将这个函数移到相关的那些子类去

Remove Assignments to Parameters(移除对参数的赋值动作) 131

  1. 代码对一个参数进行赋值,以一个临时变量取代该参数的位置(如果你把一个名为foo的对象作为参数传给了某个函数,那么对“参数赋值”意味着改变foo,使它引用另一个对象,如果你在“被传入对象”身上进行什么操作,那没问题)

Remove Control Flag(移除控制标记) 245

  1. 在一系列布尔表达式中,某个变量带有”控制标记”的作用,以break语句或return语句取代控制标记。

Remove Middle Man(移除㆗间㆟) 160

  1. 某个类做了过多的简单委托动作,让客户直接调用受托类

Remove Parameter(移除参数) 277

  1. 函数本体不需要某个参数,将该参数去除

Remove Setting Method(移除设值函数) 300

  1. 类中的某个字段应该在对象创建时被设值,然后就不再改变,去掉该字段的所有设值函数。

Rename Method(重新命名函数) 273

  1. 函数的名称未能揭示函数的用途,修改函数名称。

Replace Array with Object(以对象取代数组) 186

  1. 你有一个数组,其中的元素各自代表不同的东西,以对象替换数组。对于数组中的每个元素,以一个字段表示。

Replace Conditional with Polymorphism(以多态取代条件式) 255

  1. 你手上有个条件表达式,它根据对象类型的不同而选择不同的行为,将这个条件表达式的每个分支放进一个子类内的覆写函数中,然后将原始函数声明为抽象函数。

Replace Constructor with Factory Method(以工厂函数取代构造函数) 304

  1. 你希望在创建对象时不仅仅是简单的建构动作,将构造函数替换为工厂函数。

Replace Data Value with Object(以对象取代数据值) 175

  1. 你有一个数据项,需要与其他数据和行为一起使用才有意义,将数据项变成对象。

Replace Delegation with Inheritance(以继承取代委托) 355

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

Replace Error Code with Exception(以异常取代错误码) 310

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

Replace Exception with Test(以测试取代异常) 315

  1. 面对一个调用者可以预先检查的条件,你抛出一个异常,修改调用者,使它在调用函数之前先做检查。

Replace Inheritance with Delegation(以委托取代继承) 352

  1. 某个子类只使用超类接口中的一部分,或者根本不需要继承而来的数据,在子类中新建一个字段用以保存超类,调整子类函数,令它改而委托超类,然后去掉两者之间的继承关系。

Replace Magic Number with Symbolic Constant(以字面常量取代魔法数) 204

Replace Method with Method Object(以函数对象取代函数) 135

  1. 你有一个大型函数,其中对局部变量的使用使你无法采用extract method,将这个函数放进一个单独对象中,如此一来局部变量就成了对象内的字段,然后你可以在同一个对象中将这个大型函数分解为多个小型函数。

Replace Nested Conditional with Guard Clauses(以卫语句取代嵌套条件式) 250

  1. 函数中的条件逻辑使人难以看清正常的执行路径,使用卫语句表现所有特殊情况。
  2. 常常可以将条件表达式反转,从而实现replace netsted conditional with guard clauses

Replace Parameter with Explicit Methods(以明确函数取代参数) 285

  1. 你有一个函数,其中完全取决于参数值而采取不同行为,针对该参数的每一个可能值,建立一个独立函数。

Replace Parameter with Method(以函数取代参数) 292

  1. 对象调用某个函数,并将所得结果作为参数,传递给另一个函数,而接受该参数的额函数本身也能够调用前一个函数,让参数接受者去除该项参数,并直接调用前一个函数。

Replace Record with Data Class(以数据类取代记录) 217

  1. 你需要面对传统编程环境中的记录结构。为该记录创建一个“哑”数据对象。

Replace Subclass with Fields(以值域取代子类) 232

  1. 你的各个子类的唯一差别只在“返回常量数据”的函数身上,修改这些函数,使他们返回超类中的某个(新增)字段,然后销毁子类。

Replace Temp With Query(以查询取代临时变量) 120

  1. 你的程序以一个临时变量保存某一表达式的运算结果,将这个表达式提炼到一个独立函数中,将这个临时变量的所有引用点替换为对新函数的调用,此后,新函数就可以被其他函数使用

Replace Type Code with Class(以类取代型别码) 218

  1. 类之中有一个数值类型码,但它并不影响类的行为,以一个新的类替换该数值类型码。

Replace Type Code with State/Strategy(以 State/Strategy 取代型别码) 227

  1. 你有一个类型码,它会影响类的行为,但你无法通过继承手法消除它,以状态对象取代类型码。

Replace Type Code with Subclasses(以子类取代型别码) 223

  1. 你有一个不可变的类型码,它会影响类的行为,以子类取代这个类型码。

Self Encapsulate Field(自封装值域) 171

  1. 你直接访问一个字段,但与字段之间的耦合关系逐渐变得笨拙,为这个字段建立取值/设置函数,并且只以这些函数来访问字段。

Separate Domain from Presentation(将领域和表述/显示分离) 370

  1. 某些GUI类之中包含了领域逻辑,将领域逻辑分离出来,为它们建立独立的领域类。

Separate Query from Modifier(将查询函数和修改函数分离) 279

  1. 某个函数既返回对象状态值,又修改对象状态,建立两个不同的函数,其中一个负责查询,另一个负责修改。

Split Temporary Variable(剖解临时变量) 128

  1. 你的程序有个临时变量被赋值超过一次,它既不是循环变量,也不被用于收集计算结果,针对每次赋值,创造一个独立,对应的临时变量

Substitute Algorithm(替换你的算法) 139

  1. 你想要把某个算法替换为另一个更清晰的算法,将函数本体替换为另一个算法

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

  1. 某个继承体系同时承担两项责任,建立两个继承体系,并通过委托关系让其中一个可以调用另一个

重构