曾用名：提炼函数（Extract Method）
反向重构：内联函数（115）
```
function printOwing(invoice) {
printBanner();
let outstanding = calculateOutstanding();
//print details
console.log(`name: ${invoice.customer}`);
console.log(`amount: ${outstanding}`);
}
```
```
function printOwing(invoice) {
printBanner();
let outstanding = calculateOutstanding();
printDetails(outstanding);
function printDetails(outstanding) {
console.log(`name: ${invoice.customer}`);
console.log(`amount: ${outstanding}`);
}
}
```
### 动机
提炼函数是我最常用的重构之一。（在这儿我用了“函数/function”这个词，但换成面向对象语言中的“方法/method”，或者其他任何形式的“过程/procedure”或者“子程序/subroutine”，也同样适用。）我会浏览一段代码，理解其作用，然后将其提炼到一个独立的函数中，并以这段代码的用途为这个函数命名。
对于“何时应该把代码放进独立的函数”这个问题，我曾经听过多种不同的意见。有的观点从代码的长度考虑，认为一个函数应该能在一屏中显示。有的观点从复用的角度考虑，认为只要被用过不止一次的代码，就应该单独放进一个函数；只用过一次的代码则保持内联（inline）的状态。但我认为最合理的观点是“将意图与实现分开”：如果你需要花时间浏览一段代码才能弄清它到底在干什么，那么就应该将其提炼到一个函数中，并根据它所做的事为其命名。以后再读到这段代码时，你一眼就能看到函数的用途，大多数时候根本不需要关心函数如何达成其用途（这是函数体内干的事）。
一旦接受了这个原则，我就逐渐养成一个习惯：写非常小的函数——通常只有几行的长度。在我看来，一个函数一旦超过6行，就开始散发臭味。我甚至经常会写一些只有1行代码的函数。Kent Beck曾向我展示最初的Smalltalk系统中的一个例子，从那时起我就接受了“函数名的长度不重要”的观念。那时运行Smalltalk的计算机只有黑白屏显示器，如果你想高亮突显某些文本或图像，就需要反转视频的显示。为此，Smalltalk用于控制图像显示的类有一个叫作`highlight`的方法，其中的实现就只是调用`reverse`方法。在这个例子里，`highlight`方法的名字比实现还长，但这并不重要，因为在这个方法中，代码的意图与实现之间有着相当大的距离。
有些人担心短函数会造成大量函数调用，因而影响性能。在我尚且年轻时，有时确实会有这个问题；但如今“由于函数调用影响性能”的情况已经非常罕见了。短函数常常能让编译器的优化功能运转更良好，因为短函数可以更容易地被缓存。所以，应该始终遵循性能优化的一般指导方针，不用过早担心性能问题。
小函数得有个好名字才行，所以你必须在命名上花心思。起好名字需要练习，不过一旦你掌握了其中的技巧，就能写出很有自描述性的代码。
我经常会看见这样的情况：在一个大函数中，一段代码的顶上放着一句注释，说明这段代码要做什么。在把这段代码提炼到自己的函数中时，这样的注释往往会提示一个好名字。
### 做法
- 创造一个新函数，根据这个函数的意图来对它命名（以它“做什么”来命名，而不是以它“怎样做”命名）。
> 如果想要提炼的代码非常简单，例如只是一个函数调用，只要新函数的名称能够以更好的方式昭示代码意图，我还是会提炼它；但如果想不出一个更有意义的名称，这就是一个信号，可能我不应该提炼这块代码。不过，我不一定非得马上想出最好的名字，有时在提炼的过程中好的名字才会出现。有时我会提炼一个函数，尝试使用它，然后发现不太合适，再把它内联回去，这完全没问题。只要在这个过程中学到了东西，我的时间就没有白费。
>
> 如果编程语言支持嵌套函数，就把新函数嵌套在源函数里，这能减少后面需要处理的超出作用域的变量个数。我可以稍后再使用搬移函数（198）把它从源函数中搬移出去。
- 将待提炼的代码从源函数复制到新建的目标函数中。
- 仔细检查提炼出的代码，看看其中是否引用了作用域限于源函数、在提炼出的新函数中访问不到的变量。若是，以参数的形式将它们传递给新函数。
> 如果提炼出的新函数嵌套在源函数内部，就不存在变量作用域的问题了。
>
> 这些“作用域限于源函数”的变量通常是局部变量或者源函数的参数。最通用的做法是将它们都作为参数传递给新函数。只要没在提炼部分对这些变量赋值，处理起来就没什么难度。
>
> 如果某个变量是在提炼部分之外声明但只在提炼部分被使用，就把变量声明也搬移到提炼部分代码中去。
>
> 如果变量按值传递给提炼部分又在提炼部分被赋值，就必须多加小心。如果只有一个这样的变量，我会尝试将提炼出的新函数变成一个查询（query），用其返回值给该变量赋值。
>
> 但有时在提炼部分被赋值的局部变量太多，这时最好是先放弃提炼。这种情况下，我会考虑先使用别的重构手法，例如拆分变量（240）或者以查询取代临时变量（178），来简化变量的使用情况，然后再考虑提炼函数。
- 所有变量都处理完之后，编译。
> 如果编程语言支持编译期检查的话，在处理完所有变量之后做一次编译是很有用的，编译器经常会帮你找到没有被恰当处理的变量。
- 在源函数中，将被提炼代码段替换为对目标函数的调用。
- 测试。
- 查看其他代码是否有与被提炼的代码段相同或相似之处。如果有，考虑使用以函数调用取代内联代码（222）令其调用提炼出的新函数。
> 有些重构工具直接支持这一步。如果工具不支持，可以快速搜索一下，看看别处是否还有重复代码。
### 范例：无局部变量
在最简单的情况下，提炼函数易如反掌。请看下列函数：
```
function printOwing(invoice) {
let outstanding = 0;
console.log("***********************");
console.log("**** Customer Owes ****");
console.log("***********************");
// calculate outstanding
for (const o of invoice.orders) {
outstanding += o.amount;
}
// record due date
const today = Clock.today;
invoice.dueDate = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 30);
//print details
console.log(`name: ${invoice.customer}`);
console.log(`amount: ${outstanding}`);
console.log(`due: ${invoice.dueDate.toLocaleDateString()}`);
}
```
你可能会好奇`Clock.today`是干什么的。这是一个Clock Wrapper\[mf-cw\]，也就是封装系统时钟调用的对象。我尽量避免在代码中直接调用`Date.now()`这样的函数，因为这会导致测试行为不可预测，以及在诊断故障时难以复制出错时的情况。
我们可以轻松提炼出“打印横幅”的代码。我只需要剪切、粘贴再插入一个函数调用动作就行了：
```
function printOwing(invoice) {
let outstanding = 0;
printBanner();
// calculate outstanding
for (const o of invoice.orders) {
outstanding += o.amount;
}
// record due date
const today = Clock.today;
invoice.dueDate = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 30);
//print details
console.log(`name: ${invoice.customer}`);
console.log(`amount: ${outstanding}`);
console.log(`due: ${invoice.dueDate.toLocaleDateString()}`);
}
function printBanner() {
console.log("***********************");
console.log("**** Customer Owes ****");
console.log("***********************");
}
```
同样，我还可以把“打印详细信息”部分也提炼出来：
```
function printOwing(invoice) {
let outstanding = 0;
printBanner();
// calculate outstanding
for (const o of invoice.orders) {
outstanding += o.amount;
}
// record due date
const today = Clock.today;
invoice.dueDate = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 30);
printDetails();
function printDetails() {
console.log(`name: ${invoice.customer}`);
console.log(`amount: ${outstanding}`);
console.log(`due: ${invoice.dueDate.toLocaleDateString()}`);
}
```
看起来提炼函数是一个极其简单的重构。但很多时候，情况会变得比较复杂。
在上面的例子中，我把`printDetails`函数嵌套在`printOwing`函数内部，这样前者就能访问到`printOwing`内部定义的所有变量。如果我使用的编程语言不支持嵌套函数，就没法这样操作了，那么我就要面对“提炼出一个顶层函数”的问题。此时我必须细心处理“只存在于源函数作用域”的变量，包括源函数的参数以及源函数内部定义的临时变量。
### 范例：有局部变量
局部变量最简单的情况是：被提炼代码段只是读取这些变量的值，并不修改它们。这种情况下我可以简单地将它们当作参数传给目标函数。所以，如果我面对下列函数：
```
function printOwing(invoice) {
let outstanding = 0;
printBanner();
// calculate outstanding
for (const o of invoice.orders) {
outstanding += o.amount;
}
// record due date
const today = Clock.today;
invoice.dueDate = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 30);
//print details
console.log(`name: ${invoice.customer}`);
console.log(`amount: ${outstanding}`);
console.log(`due: ${invoice.dueDate.toLocaleDateString()}`);
```
就可以将“打印详细信息”这一部分提炼为带两个参数的函数：
```
function printOwing(invoice) {
let outstanding = 0;
printBanner();
// calculate outstanding
for (const o of invoice.orders) {
outstanding += o.amount;
}
// record due date
const today = Clock.today;
invoice.dueDate = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 30);
printDetails(invoice, outstanding);
}
function printDetails(invoice, outstanding) {
console.log(`name: ${invoice.customer}`);
console.log(`amount: ${outstanding}`);
console.log(`due: ${invoice.dueDate.toLocaleDateString()}`);
}
```
如果局部变量是一个数据结构（例如数组、记录或者对象），而被提炼代码段又修改了这个结构中的数据，也可以如法炮制。所以，“设置到期日”的逻辑也可以用同样的方式提炼出来：
```
function printOwing(invoice) {
let outstanding = 0;
printBanner();
// calculate outstanding
for (const o of invoice.orders) {
outstanding += o.amount;
}
recordDueDate(invoice);
printDetails(invoice, outstanding);
}
function recordDueDate(invoice) {
const today = Clock.today;
invoice.dueDate = new Date(today.getFullYear(), today.getMonth(), today.getDate() + 30);
}
```
### 范例：对局部变量再赋值
如果被提炼代码段对局部变量赋值，问题就变得复杂了。这里我们只讨论临时变量的问题。如果你发现源函数的参数被赋值，应该马上使用拆分变量（240）将其变成临时变量。
被赋值的临时变量也分两种情况。较简单的情况是：这个变量只在被提炼代码段中使用。若果真如此，你可以将这个临时变量的声明移到被提炼代码段中，然后一起提炼出去。如果变量的初始化和使用离得有点儿远，可以用移动语句（223）把针对这个变量的操作放到一起。
比较糟糕的情况是：被提炼代码段之外的代码也使用了这个变量。此时我需要返回修改后的值。我会用下面这个已经很眼熟的函数来展示该怎么做：
```
function printOwing(invoice) {
let outstanding = 0;
printBanner();
// calculate outstanding
for (const o of invoice.orders) {
outstanding += o.amount;
}
recordDueDate(invoice);
printDetails(invoice, outstanding);
}
```
前面的重构我都一步到位地展示了结果，因为它们都很简单。但这次我会一步一步展示“做法”里的每个步骤。
首先，把变量声明移动到使用处之前。
```
function printOwing(invoice) {
printBanner();
// calculate outstanding
let outstanding = 0;
for (const o of invoice.orders) {
outstanding += o.amount;
}
recordDueDate(invoice);
printDetails(invoice, outstanding);
}
```
然后把想要提炼的代码复制到目标函数中。
```
function printOwing(invoice) {
printBanner();
// calculate outstanding
let outstanding = 0;
for (const o of invoice.orders) {
outstanding += o.amount;
}
recordDueDate(invoice);
printDetails(invoice, outstanding);
}
function calculateOutstanding(invoice) {
let outstanding = 0;
for (const o of invoice.orders) {
outstanding += o.amount;
}
return outstanding;
}
```
由于`outstanding`变量的声明已经被搬移到提炼出的新函数中，就不需要再将其作为参数传入了。`outstanding`是提炼代码段中唯一被重新赋值的变量，所以我可以直接返回它。
我的JavaScript环境在编译期提供不了任何价值——简直还不如文本编辑器的语法分析有用，所以“做法”里的“编译”一步可以跳过了。下一件事是修改原来的代码，令其调用新函数。新函数返回了修改后的`outstanding`变量值，我需要将其存入原来的变量中。
```
function printOwing(invoice) {
printBanner();
let outstanding = calculateOutstanding(invoice);
recordDueDate(invoice);
printDetails(invoice, outstanding);
}
function calculateOutstanding(invoice) {
let outstanding = 0;
for (const o of invoice.orders) {
outstanding += o.amount;
}
return outstanding;
}
```
在收工之前，我还要修改返回值的名字，使其符合我一贯的编码风格。
```
function printOwing(invoice) {
printBanner();
const outstanding = calculateOutstanding(invoice);
recordDueDate(invoice);
printDetails(invoice, outstanding);
}
function calculateOutstanding(invoice) {
let result = 0;
for (const o of invoice.orders) {
result += o.amount;
}
return result;
}
```
我还顺手把原来的`outstanding`变量声明成`const`的，令其在初始化之后不能再次被赋值。
这时候，你可能会问：“如果需要返回的变量不止一个，又该怎么办呢？”
有几种选择。最好的选择通常是：挑选另一块代码来提炼。我比较喜欢让每个函数都只返回一个值，所以我会安排多个函数，用以返回多个值。如果真的有必要提炼一个函数并返回多个值，可以构造并返回一个记录对象—不过通常更好的办法还是回过头来重新处理局部变量，我常用的重构手法有以查询取代临时变量（178）和拆分变量（240）。
如果我想把提炼出的函数搬移到别的上下文（例如变成顶层函数），会引发一些有趣的问题。我偏好小步前进，所以我本能的做法是先提炼成嵌套函数，然后再将其移入新的上下文。但这种做法的麻烦在于处理局部变量，而这个困难无法提前发现，直到我开始最后的搬移时才突然暴露。从这个角度考虑，即便可以先提炼成嵌套函数，或许也应该至少将目标函数放在源函数的同级，这样我就能立即看出提炼的范围是否合理。
- 第1章 重构，第一个示例
- 1.1 起点
- 1.2 对此起始程序的评价
- 1.3 重构的第一步
- 1.4 分解statement函数
- 1.5 进展：大量嵌套函数
- 1.6 拆分计算阶段与格式化阶段
- 1.7 进展：分离到两个文件（和两个阶段）
- 1.8 按类型重组计算过程
- 1.9 进展：使用多态计算器来提供数据
- 1.10 结语
- 第2章 重构的原则
- 2.1 何谓重构
- 2.2 两顶帽子
- 2.3 为何重构
- 2.4 何时重构
- 2.5 重构的挑战
- 2.6 重构、架构和YAGNI
- 2.7 重构与软件开发过程
- 2.8 重构与性能
- 2.9 重构起源何处
- 2.10 自动化重构
- 2.11 延展阅读
- 第3章 代码的坏味道
- 3.1 神秘命名（Mysterious Name）
- 3.2 重复代码（Duplicated Code）
- 3.3 过长函数（Long Function）
- 3.4 过长参数列表（Long Parameter List）
- 3.5 全局数据（Global Data）
- 3.6 可变数据（Mutable Data）
- 3.7 发散式变化（Divergent Change）
- 3.8 霰弹式修改（Shotgun Surgery）
- 3.9 依恋情结（Feature Envy）
- 3.10 数据泥团（Data Clumps）
- 3.11 基本类型偏执（Primitive Obsession）
- 3.12 重复的switch （Repeated Switches）
- 3.13 循环语句（Loops）
- 3.14 冗赘的元素（Lazy Element）
- 3.15 夸夸其谈通用性（Speculative Generality）
- 3.16 临时字段（Temporary Field）
- 3.17 过长的消息链（Message Chains）
- 3.18 中间人（Middle Man）
- 3.19 内幕交易（Insider Trading）
- 3.20 过大的类（Large Class）
- 3.21 异曲同工的类（Alternative Classes with Different Interfaces）
- 3.22 纯数据类（Data Class）
- 3.23 被拒绝的遗赠（Refused Bequest）
- 3.24 注释（Comments）
- 第4章 构筑测试体系
- 4.1 自测试代码的价值
- 4.2 待测试的示例代码
- 4.3 第一个测试
- 4.4 再添加一个测试
- 4.5 修改测试夹具
- 4.6 探测边界条件
- 4.7 测试远不止如此
- 第5章 介绍重构名录
- 5.1 重构的记录格式
- 5.2 挑选重构的依据
- 第6章 第一组重构
- 6.1 提炼函数（Extract Function）
- 6.2 内联函数（Inline Function）
- 6.3 提炼变量（Extract Variable）
- 6.4 内联变量（Inline Variable）
- 6.5 改变函数声明（Change Function Declaration）
- 6.6 封装变量（Encapsulate Variable）
- 6.7 变量改名（Rename Variable）
- 6.8 引入参数对象（Introduce Parameter Object）
- 6.9 函数组合成类（Combine Functions into Class）
- 6.10 函数组合成变换（Combine Functions into Transform）
- 6.11 拆分阶段（Split Phase）
- 第7章 封装
- 7.1 封装记录（Encapsulate Record）
- 7.2 封装集合（Encapsulate Collection）
- 7.3 以对象取代基本类型（Replace Primitive with Object）
- 7.4 以查询取代临时变量（Replace Temp with Query）
- 7.5 提炼类（Extract Class）
- 7.6 内联类（Inline Class）
- 7.7 隐藏委托关系（Hide Delegate）
- 7.8 移除中间人（Remove Middle Man）
- 7.9 替换算法（Substitute Algorithm）
- 第8章 搬移特性
- 8.1 搬移函数（Move Function）
- 8.2 搬移字段（Move Field）
- 8.3 搬移语句到函数（Move Statements into Function）
- 8.4 搬移语句到调用者（Move Statements to Callers）
- 8.5 以函数调用取代内联代码（Replace Inline Code with Function Call）
- 8.6 移动语句（Slide Statements）
- 8.7 拆分循环（Split Loop）
- 8.8 以管道取代循环（Replace Loop with Pipeline）
- 8.9 移除死代码（Remove Dead Code）
- 第9章 重新组织数据
- 9.1 拆分变量（Split Variable）
- 9.2 字段改名（Rename Field）
- 9.3 以查询取代派生变量（Replace Derived Variable with Query）
- 9.4 将引用对象改为值对象（Change Reference to Value）
- 9.5 将值对象改为引用对象（Change Value to Reference）
- 第10章 简化条件逻辑
- 10.1 分解条件表达式（Decompose Conditional）
- 10.2 合并条件表达式（Consolidate Conditional Expression）
- 10.3 以卫语句取代嵌套条件表达式（Replace Nested Conditional with Guard Clauses）
- 10.4 以多态取代条件表达式（Replace Conditional with Polymorphism）
- 10.5 引入特例（Introduce Special Case）
- 10.6 引入断言（Introduce Assertion）
- 第11章 重构API
- 11.1 将查询函数和修改函数分离（Separate Query from Modifier）
- 11.2 函数参数化（Parameterize Function）
- 11.3 移除标记参数（Remove Flag Argument）
- 11.4 保持对象完整（Preserve Whole Object）
- 11.5 以查询取代参数（Replace Parameter with Query）
- 11.6 以参数取代查询（Replace Query with Parameter）
- 11.7 移除设值函数（Remove Setting Method）
- 11.8 以工厂函数取代构造函数（Replace Constructor with Factory Function）
- 11.9 以命令取代函数（Replace Function with Command）
- 11.10 以函数取代命令（Replace Command with Function）
- 第12章 处理继承关系
- 12.1 函数上移（Pull Up Method）
- 12.2 字段上移（Pull Up Field）
- 12.3 构造函数本体上移（Pull Up Constructor Body）
- 12.4 函数下移（Push Down Method）
- 12.5 字段下移（Push Down Field）
- 12.6 以子类取代类型码（Replace Type Code with Subclasses）
- 12.7 移除子类（Remove Subclass）
- 12.8 提炼超类（Extract Superclass）
- 12.9 折叠继承体系（Collapse Hierarchy）
- 12.10 以委托取代子类（Replace Subclass with Delegate）
- 12.11 以委托取代超类（Replace Superclass with Delegate）
- 参考文献
- 重构列表
- 坏味道与重构手法速查表