重新组织函数
重构的基本技巧:小步前进,频繁测试
1. Extract Method(提炼函数)
Q:你有一段代码可以被组织在一起并独立出来
A:将这段代码放进一个独立函数中,并让函数名称解释该函数的用途。
函数粒度很小,则复用的机会就很大;简短而命名良好的函数将使得高层函数更像是一系列注释;细粒度函数的覆写更加容易。
函数名称与本体之间的语义距离决定了函数的长度。
做法:
- 创造一个新函数,根据函数意图来命名(做什么,而不是怎样做)
- 将提炼出的代码从源函数复制到新建的目标函数中
- 仔细检查提炼的代码,检查是否引用了局部变量或源函数参数
- 检查是否有仅用于被提炼代码段的临时变量,如果有,在新创建的目标函数中声明它们为临时变量
- 检查被提炼代码段,看看是否有任何局部变量的值被它改变,可以考虑
- 将被提炼代码段处理为一个查询函数,返回值赋给相关变量
- 使用 Split Temporary Variable,创造多个临时变量
- 使用 Replace Temp with Query,用查询函数代替临时变量
- 将需要读取的局部变量通过参数传入到目标函数
- 替换所有调用
2. Inline Method(内联函数)
Q:一个函数的本体与名称同样清除易懂
A:在函数调用点插入函数本体,然后移除该函数
间接层可能带来帮助,但非必要的间接层总是让人不舒服。
组织不合理的函数,可以先内联到一个大型函数,再迁移或者提炼。
做法:
- 检查函数是否具备多态性
- 找出所有调用点
- 调用点替换为函数本体
- 删除函数定义
3. Inline Temp(内联临时变量)
Q:你有一个临时变量,只被一个简单表达式赋值一次,而它妨碍了其它重构手法
A:将所有对该变量的引用动作,替换为对它赋值的表达式自身。
这个重构手法通常是为了其他重构手法服务,例如 Replace Temp with Query 或者 Extract Method。
做法:
- 确保表达式没有副作用
- 声明临时变量为 final 以检查其没有被再次赋值
- 找到临时变量引用点并进行表达式替换
- 删除临时变量的声明和赋值语句
4. Replace Temp with Query(以查询取代临时变量)
Q:你的程序以一个临时变量保存某一表达式的运算结果
A:将这个表达式提炼到一个独立函数中,将这个临时变量的所有引用点替换为对新函数的调用
临时变量存在的问题是它们是暂时的,而且只能在当前所属函数内使用。如果将临时变量替换为一个查询,那么同一个类所有函数都可以访问这份信息。
做法:
- 找出只被赋值一次的临时变量(如果被赋值多次,首先运用 Split Temporary Variable 分割为多个分类)
- 声明变量为 final
- 提炼等号右侧部分为一个查询函数
- 对变量实施 Inline Temp
针对于统计类型的临时变量,循环也需要带入到独立查询函数中,多个临时变量则带来多次循环。
5. Intruduce Explaining Variable(引入解释性变量)
Q:你有一个复杂的表达式
A:将该复杂表达式(或其中一部分)的结果放进一个临时变量,以此变量名称来解释表达式用途。
这一重构手法通常用于条件逻辑中,对于特别复杂特别长的判断条件表达式,可以将条件子句进行提炼,以一个良好命名的临时变量解释对应条件子句的意义。
做法:
- 声明一个 final 临时变量,将复杂表达式的一部分动作的运算结果赋值给它
- 将运算结果替换为临时变量
- 重复处理其他部分
6. Split Temporary Variable(分解临时变量)
Q:你的程序有某个临时变量被复制超过一次,而它既不是循环变量,也不被用于收集计算结果。
A:针对每次赋值,创造一个独立、对应的临时变量。
如果临时变量承担了多个责任,就应该被替换分解为多个临时变量,否则会令阅读者糊涂。
做法:
- 将新的临时变量声明为 final
- 以该临时变量第二次赋值动作为界,修改原临时变量引用为新的临时变量
- 在第二次赋值处重新声明原先那个临时变量
- 重复上述动作,每次都在声明处改名,并修改下次赋值之前的引用点
7. Remove Assignments to Parameters(移除对参数的赋值)
Q:代码对一个参数进行赋值
A:以一个临时变量取代该参数的位置
对参数赋值降低了代码清晰度,混用了按值传递与按引用传递两种参数传递方式。针对参数的赋值无法对按值传递的参数产生任何作用。
做法:
- 建立一个临时变量,把待处理的参数赋值给它
- 以对参数的赋值为界,将所有引用点进行临时变量替换
- 修改赋值语句,将其赋值给临时变量
8. Replace Method with Method Object(以函数对象取代函数)
Q:你有一个大型函数,其中对局部变量的使用使你无法采用 Extract Method
A:将这个函数放进一个单独对象中,如此一来局部变量就变成了对象内的字段,然后你可以在同一个对象中将这个大型函数分解成多个小函数。
局部变量的存在增加了函数的分解度,可以将整个函数变为一个对象,局部变量变为对象的字段,然后再进一步拆分函数。
做法:
- 建立一个新类
- 新类持有一个源对象,针对原函数中的每个临时变量和参数创建对应字段
- 建立构建函数
- 建立 compute 函数
- 复制原函数到 compute 函数中,并替换其中对源对象其他函数的调用
- 替换旧函数为新类的 compute 函数
9. Substitute Algorithm(替换算法)
Q:你想要把某个算法替换为另一个更清晰的算法
A:将函数本体替换为另一个算法。
Just replace it!