重构的记录格式
介绍重构时,我采用一种标准格式。每个重构手法都有如下五个部分。
- 首先是名称(name )。建造一个重构词汇表,名称是很重要的。这个名称也就是我将在本书其他地方使用的名称。
- 名称之后是一个简短概要(summary)。简单介绍此一重构手法的适用情景,以及它所做的事情。这部分可以帮助你更快找到你所需要的重构手法。
- 动机(motivation) 为你介绍“为什么需要这个重构”和 “什么情况下不该使用这个重构”。
- 做法 (mechanics) 简明扼要地一步-步介绍如何进行此一重构。
- 范例 (examples) 以一个十分简单的例子说明此重构手法如何运作。
“概要”包括三个部分:
- 一句话介绍这个重构能够帮助解决的问题:
- 一段简短陈述,介绍你应该做的事;
- 一幅速写图,简单展现重构前后示例:有时候我展示代码,有时候我展示UML图。总之,哪种形式能更好呈现该重构的本质,我就使用哪种形式。
撰写 “做法”的时候,我尽量将重构的每个步骤都写得简短。我强调安全的重构方式,所以应该采用非常小的步骤,并且在每个步骤之后进行测试。
“范例”像是简单而有趣的教科书。我使用这些范例是为了帮助解释重构的基本要素,最大限度地避免其他枝节,所以我希望你能原谅其中的简化下作(它们当然不是优秀商用对象设计的适当例子)。不过我敢肯定,你一定能在你手上那些更复杂的情况中使用它们。某些十分简单的重构干脆没有范例,因为我觉得为它们加上一个范例不会有多大意义。