重構改善既有程式的設計github

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

目錄 Show

Name already in use
Developer-Books/Code_Style_Guide/重构：改善既有代码的设计.pdf
book-refactoring2
资源获取
构建自己的站点/电子书
静态站点
构建环境
重构 - 改善既有代码的设计
1 重构，第一个示例
2 重构的原则
2.1 何谓重构
2.2 两顶帽子
2.3 为何重构
2.4 何时重构
2.5 重构的挑战
2.6 重构、架构和YAGNI
2.7 重构与软件开发过程
2.8 重构与性能
2.9 重构起源何处
2.10 自动化重构
3 代码的坏味道
4 构筑测试体系
4.1 自测试代码的价值
4.2 测试代码示例
4.3 第一个测试
4.4 再添加一个测试
4.5 修改测试夹具
4.6 探测边界条件
4.7 测试远不止如此
5 介绍重构名录
6 第一组重构
6.1 提炼函数
6.2 内联函数
6.3 提炼变量
6.4 内联变量
6.5 改变函数声明
6.6 封装变量
6.7 变量改名
6.8 引入参数对象
6.9 函数组合成类
6.10 函数组合成变换
6.11 拆分阶段
7.1 封装记录
7.2 封装集合
7.3 以对象取代基本类型
7.4 以查询取代临时变量
7.5 提取类
7.6 内联类
7.7 隐藏委托关系
7.8 移除中间人
7.9 替换算法
8 搬移特性
8.1 搬移函数
8.2 搬移字段
8.3 搬移语句到函数
8.4 搬移语句到调用者
8.5 以函数调用取代内联代码
8.6 移动语句
8.7 拆分循环
8.8 以管道取代循环
8.9 移除死代码
9 重新组织数据
9.1 拆分代码
9.2 字段改名
9.3 以查询取代派生变量
9.4 将引用对象改为值对象
9.5 将值对象改为引用对象
10 简化条件逻辑
10.1 分解条件表达式
10.2 合并条件表达式
10.3 卫语句取代嵌套条件表达式
10.4 以多态取代条件表达式
10.5 引入特例
10.6 引入断言
11 重构API
11.1 查询函数和修改函数分离
11.2 函数参数化
11.3 移除标记参数
11.4 保持对象完整性
11.5 以查询取代参数
11.6 以参数取代查询
11.7 移除设置函数
11.8 以工厂函数取代构造函数
11.9 以命令取代函数
11.10 以函数取代命令
12 处理继承关系
12.1 函数上移
12.2 字段上移
12.3 构造函数本体上移
12.4 函数下移
12.5 字段下移
12.6 以子类取代类型码
12.7 移除子类
12.8 提取超类
12.9 折叠继承体系
12.10 以委托取代子类
12.11 以委托取代超类

Permalink

Name already in use

Developer-Books/Code_Style_Guide/重构：改善既有代码的设计.pdf

Go to file

Go to file
Copy path
Copy permalink

Cannot retrieve contributors at this time

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

book-refactoring2

《重构改善既有代码的设计第二版》中文版

资源获取

在线阅读: https://book-refactoring2.ifmicro.com
电子书: pdf, epub, mobi

构建自己的站点/电子书

准备

请保证 构建环境 章节的要求
克隆并安装依赖

$ git clone https://github.com/MwumLi/book-refactoring2.git
$ npm i

静态站点

运行下面命令前, 请保证 构建环境 章节的要求, 并先使用 npm install 去初始化依赖

执行下面命令:

构建后的结果放在 _book/ 目录下, 你可以用来静态部署

电子书

执行下面命令, 你将得到 mobi, epub 以及 pdf 三种电子书:

注意: 构建电子书之前需要安装 calibre, 这是 gitbook 构建电子书的必须软件。

构建环境

Node.js ^10.x - ^11.x LTS 版本
gitbook ^3.x: 因为要支持中文搜索

贡献

本文还有很多文案不准确或源码格式乱的问题, 如有发现欢迎可以提 pr 进行贡献

感谢

本书源码来自 NxeedGoto/Refactoring2-zh, 由于为了构建电子书籍, 所以改造成了 gitbook 格式。

重构 - 改善既有代码的设计

1 重构，第一个示例

重构前，先检查自己是否有一套可靠的测试集。这些测试必须有自我验证能力。TDD
重构技术就是以微小的步伐修改程序。如果犯下错误，很容易便可发现它。
傻瓜都能写出计算机可以理解的代码。唯有能写出人类容易理解的代码的，才是优秀的程序员。
编程时，需要遵循营地法则：保证你离开时，代码库一定比来的时候更健康。
好代码验证的标准是人们是否能轻而易举的修改它。

2 重构的原则

2.1 何谓重构

重构：对软件内部结构的一种调整，目的是在不改变可观察行为的前提下，提高其可理解性，降低其修改成本。
重构的关键在于运用大量小且保证软件行为的步骤，一步步达到大规模的修改。
如果有人说他们的代码在重构过程中有1-2天时间不可用，基本上可以确定，他们在做的事不是重构。

2.2 两顶帽子

添加新功能，可能需要优化之前的程序结构；当功能开发好，也需要优化下程序的结构。不同的角色切换，是在添加功能过程中必不可少的步骤。

2.3 为何重构

改进软件的设计
使软件更容易理解
帮助开发者找到bug
提高编程速度

2.4 何时重构

预备性：让添加新功能更容易
帮助理解：使代码更易懂
捡垃圾式重构
有计划和见机行事的重构：肮脏的代码必须重构，但漂亮的代码也需要很多重构
长期重构
复审代码时重构
何时不应该重构：
- 只有当需要理解其工作原理时
- 如果重写比重构容易

2.5 重构的挑战

缓解新功能开发
- 重构的唯一目的就是让我们开发更快，用更少的工作量创造更大的价值
- 重构应该总是由经济利益驱动，而不是在于把代码库打磨得闪闪发光
分支
- 持续集成，也叫基于主干开发，避免任何分支彼此差距太大，从而降低合并的难度
测试
- 自测试代码：快速发现错误
遗留代码
- 重构可以很好地帮助我们理解遗留系统，但遗留的系统大多数是没有测试。解决办法是：没测试就加测试。书籍推荐《修改代码的艺术》

2.6 重构、架构和YAGNI

一旦代码写出来，架构就固定了，只会因为程序员的草率对待而逐渐腐败，重构可以改变这个状态
重构可以应对未来的需求变化

2.7 重构与软件开发过程

极限编程是最早的敏捷软件开发方法之一。要真正以敏捷的方式运作项目，团队成员必须在重构上有能力、有热情，他们采用的开发过程必须与常规的、持续的重构相匹配
自测试代码 -> 持续集成 -> 重构

2.8 重构与性能

除了对性能有严格要求的实时系统，其他情况下，“编写快速软件”的秘诀是：先写出可调优的代码，然后调优它以求获得足够的速度
短期看，重构可能会让软件变慢，但它的优化阶段的软件性能调优更容易，最终还是会得到好的效果

2.9 重构起源何处

优秀的程序员肯定会花一些时间来清理自己的代码，因为他们确定自己几乎无法一开始就写出整洁的代码

2.10 自动化重构

强大的IDE会让重构变得很轻松

3 代码的坏味道

神秘命名：如果想不出一个好的名字，说明背后很可能隐藏着更深的设计问题
重复代码：优化：对比差异，提取相同。
过长函数：优化：条件、循环、公共集中的过程提取处理
过长参数列表：优化：使用对象合并参数
全局数据：优化：合并数据到方法、类成员中
可变数据：优化：函数式编程、数据永不改变
发散式变化：做出的某个模块的小修改，必须修改某个类的多个函数。优化：每次只关心一个上下文，将联动的改变提取处理
霰弹式修改：每次遇到变化，都必须在很多不同的类内做出许多小修改。优化：提取公共方法
依恋情结：如果一个函数跟另一个模块中的函数或者数据交流格外频繁，远胜于在自己所处的模块内部交流
- 模块化：力求将代码分出区域，最大化区域内部的交互、最小化跨区域的交互。所谓高内聚，低耦合
数据泥团：两个类中相同的字段、许多函数签名中相同的参数。优化：提取公共字段为一个类、对象
基本类型偏执：一些基本类型无法表示一个数据的真实意义，例如电话号码、温度等。优化：使用类、对象字符串类型变量取代基本类型
重复的 switch：优化：使用策略模式、提取子类
循环语句：同过长函数
冗赘的元素：优化：内联、删除
夸夸其谈通用性：优化：内联、删除
临时字段：优化：内联、删除
过长的消息链：优化：减少委托关系
中间人：优化：用继承替代代理委托
内幕交易：优化：合并相同的联系，提取不同的成分
过大的类：优化：提取类、子类、接口
异曲同工的类：优化：提取公共类、使用子类继承
纯数据类：它们拥有一些字段，以及访问、读写这些字段的函数。优化：将相关操作封装进去，降低 public 成员变量
被拒绝的遗赠：如果子类继承超类的数据和方法，但不使用。优化：用内联数据和方法、代理委托替代继承关系
注释：当你感觉需要编写注释时，请先尝试重构，试着让所有注释变得多余

4 构筑测试体系

4.1 自测试代码的价值

程序员编写代码的时间仅占所有时间中很少的一部分，但是花费在调试上的时间是最多的。修复bug通常是比较快的，但找出bug所在却是一场噩梦
确保所有测试都是完全自动化，让他们检查自己的测试结果
一套测试就是一个强大的bug侦探器，能够大大缩减查找bug所需的时间

4.2 测试代码示例

4.3 第一个测试

总是确保测试不该通过时，会产生失败
频繁地运行测试，对于你正在处理的代码与其对应的测试至少每隔几分钟就要运行一次，每天至少运行一次所有的测试

4.4 再添加一个测试

编写为臻完善的测试并经常运行，好过对完美测试的无尽等待
保持每个测试用例独立性，避免产生共享对象。因为测试之间会通过共享产生交互，而测试的结果就会受测试运行次序的影响，导致测试结果的不确定性

例子

describe('province', () => {
  const shanghai = new Province('shanghai');
  it('shortfall', () => {
    expect(shanghai.shortfall).equal(5);
  })
})

describe('province', () => {
  let shanghai = null;
  beforeEach(() => {
    shanghai = new Province('shanghai');
  })
  it('shortfall', () => {
    expect(shanghai.shortfall).equal(5)
  })
})

4.5 修改测试夹具

配置 - 检查 - 验证
准备 - 行为 - 断言

4.6 探测边界条件

考虑可能出错的边界条件，把测试火力集中在那儿
不要因为测试无法捕捉所有的bug就不写测试，因为测试的确可以捕捉到大多数bug
任何测试都不能证明一个程序没有bug
当测试数量达到一定程度后，继续增加测试代理的边际效用会递减
应该把测试集中在可能出错的地方，观察代码，看哪儿变得复杂、哪些地方可能出错

4.7 测试远不止如此

一个架构的好坏，很大程度上要取决于它的可测试性，这是一个好的行业趋势
每当收到bug报告，请先写一个单元测试来暴露这个bug
一个测试集是否够好，最好的衡量标准其实是主观的，试问自己：如果有人在代码里引入了一个缺陷，自己有多大的自信它能被测试集发现

5 介绍重构名录

6 第一组重构

6.1 提炼函数

对立：内联函数
目的：将意图与实现分开。意图 == 主干；实现 == 分支的实现
场景：如果需要花时间浏览一段代码才能弄清它到底干什么，那么就应该将其提炼到一个函数中，并根据它所做的事为其命名。以后再读到这段代码时，可以一眼就能知道函数的用途，大多数根本不需要关心函数如何实现。

例子：

function printOwing(invoice){
  printBanner();
  const outstanding = calculateOutstanding();      
  // print details
  console.info('name:', invoice.name);
  console.info('amount:', outstanding);
}

function printOwing(invoice){
  printBanner();
  const outstanding = calculateOutstanding();
  printDetails(outstanding, invoice);
  function printDetails(outstanding, invoice) {
    console.info('name:', invoice.name);
    console.info('amount:', outstanding);
  }
}

6.2 内联函数

对立：提炼函数
目的：去除不必要间接层/委托层，降低系统复杂度
场景：
- 一堆不合理的函数，可以将其内联到一个大型函数中，再重新提炼到小函数中
- 代码太多间接层，使系统中的所有函数都似乎只是对另一个函数简单的委托

例子：

function getRating(driver){
    return moreThanFiveDeliveries(driver) ? 2 : 1;
}

function moreThanFiveDeliveries(driver){
  return driver.deliveries > 5;
}

function getRating(driver){
  return driver.deliveries > 5 ? 2 : 1;
}

6.3 提炼变量

对立：内联变量
目的：将复杂的表达式使用变量说明

例子：

return order.quantity * order.itemPrice - Math.max(0, order.quantity - 500) * order.itemPrice * 0.05 + Math.min(order.quantity * order.itemPrice * 0.1, 100);

const basePrice = order.quantity * order.itemPrice;
const quantityDiscount =  Math.max(0, order.quantity - 500) * order.itemPrice * 0.05;
const shipping = Math.min(basePrice * 0.1, 100);
return basePrice - quantityDiscount + shipping;

6.4 内联变量

对立：提炼变量
目的：去除不必要变量
场景：表达式比变量更有表现力

例子：

const basePrice = order.basePrice;
return basePrice > 25;

return order.basePrice > 25;

6.5 改变函数声明

目的：好名字能让人一眼看出函数的用途，而不必看代码实现
使用：
- 先写一句注释描述这个函数的用途，再把这句注释变成函数的名字
例子：

6.6 封装变量

目的：
- 重构数据转移为重构函数，更易于处理
- 监控数据的变化
场景：如果数据的可访问范围大

例子：

let defaultOwner = {};
export function defaultOwner(){
  return defaultOwner;
}
export function getDefaultOwner(arg){
  defaultOwner = arg;
}

6.7 变量改名

目的：好名字可让上下文更清晰

例子：

const a = height * width;

const area = height * width;

6.8 引入参数对象

目的：组织数据结构，让数据项之间的关系更清晰，参数列表也能缩短
场景：一个函数接受多个参数

例子：

function invoice(startDate, endDate){}
function received(starDate, endDate){}

function invoice(dateRange){}
function received(dateRanges){}

6.9 函数组合成类

目的：
- 对象内部调用这些函数可以少传参数，从而简化函数调用，而且一个对象可更方便传递给系统的其他部分
- 客户端修改对象的核心数据，通过计算得出的派生数据会自动与核心数据保存一致
场景：如果一组函数形影不离地操作同一块数据（通常是将这块数据作为参数传递给函数）

例子：

function base(reading){}
function taxableCharge(reading){}
function calcBaseCharge(reading){}

class Reading{
  base(){}
  taxableCharge(){}
  calcBaseCharge(){}
}

6.10 函数组合成变换

目的：
- 增强数据，将数据逻辑统一在一个地方处理
- 高内聚
场景：需要把数据放到另一个程序中运行，计算出各种派生信息

例子：

function base(reading){}
function taxableCharge(reading){}

import { cloneDeep } from 'lodash';
function enrichReading(arg){
  const reading = cloneDeep(arg);
  reading.baseCharge = base(reading);
  reading.taxableCharge = taxableCharge(reading);
  return reading;
}

6.11 拆分阶段

目的：保证单一原则，一段代码只做一件事
场景：如果一段代码同时处理两件或者更多不同的事情

例子：

const orderArr = orderStr.split(/\s+/);
const productPrice = priceList(order[0].split('-')[1]);
const orderPrice = parseInt(orderArr[1]) * productPrice;

const orderRecord = parseOrder(order);
const orderPrice = price(orderRecord, priceList);

function parseOrder(str){
  const values = str.split(/\s+/);
  return {
    priceId: values[0].split('-')[1],
    quantity: parseInt(values[1]) 
  };
}

function price(order, priceList){
  return order.quantity * priceList[order.productId];
}

7 封装

7.1 封装记录

目的：
- 对象可以隐藏结构的细节
- 有助于字段改名
场景：对于可变数据

例子：

const organization = {name: 'John', country: 'GB'};

class Organization{
  constructor(data){
    this._name = data.name;
    this._country = data.country;
  }
  get name(){
    return this._name;
  }
  set name(arg){
    this._name = arg;
  } 
  get country(){
    return this._country;
  }
  set country(arg){
    this._country = arg;
  }
}

7.2 封装集合

目的：控制外界对类中集合的访问权，避免集合被直接修改
场景：类中集合为可变数据

例子：

class Person{
  get courses(){
    return this._courses;
  }
  set courses(list){
    this._course = list;
  }
}

class Person{
  get course(){
    return this._courses.slice();
  }
  addCourse(course){}
  removeCourse(course){}
}

7.3 以对象取代基本类型

目的：扩展或者增强数据的行为
场景：如果数据项需要更多的含义或者行为时

例子：

orders.filter(o => 'high' === o.priority || 'rush' === o.priority);

orders.filter(o => o.priority.higherThan(new Priority('normal')));
function Priority(){}

7.4 以查询取代临时变量

目的：
- 新函数与原函数之间的边界更清晰
- 便于代码抽离
- 利于函数复用
场景：那些值被计算一次且之后不再被修改的变量

例子：

class Price{
  getPrice(){
    const basePrice = this._quantity * this._itemPrice;
    return basePrice > 1000 ? basePrice * 0.95 : basePrice * 0.98;
  }
}

class Price{
  get basePrice(){ 
    return this._quantity * this._itemPrice;
  }
  getPrice(){
    return this.basePrice > 1000 ? this.basePrice * 0.95 : this.basePrice * 0.98;
  }
}

7.5 提取类

对立：内联类
目的：将大类分成小类
场景：维护一个大量函数和数据的类

例子：

class Person{
  get officeAreaCode(){
    return this._officeAreaCode;
  }
  get officeNumber(){
    return this._officeNumber;
  }
}

class Person{
  constructor(telephoneNumber){
    this._telephoneNumber = telephoneNumber;
  }
  get officeAreaCode(){
    return this._telephoneNumber.areaCode;
  }
  get officeNumber(){
    return this._telephoneNumber.number;
  }
}
class TelephoneNumber{
  get areaCode(){
    return this._areaCode;
  }
  get number(){
    return this._number;
  }
}

7.6 内联类

对立：提炼类
目的：减少不必要的类
场景：
- 如果一个类不再承担足够的责任
- 重新分类两个类的不同职责

例子：

class Person{
  constructor(telephoneNumber){
    this._telephoneNumber = telephoneNumber;
  }
  get officeAreaCode(){
    return this._telephoneNumber.areaCode;
  }
  get officeNumber(){
    return this._telephoneNumber.number;
  }
}
class TelephoneNumber{
  get areaCode(){
    return this._areaCode;
  }
  get number(){
    return this._number;
  }
}

class Person{
  get officeAreaCode(){
    return this._officeAreaCode;
  }
  get officeNumber(){
    return this._officeNumber;
  }
}

7.7 隐藏委托关系

对立：移除中间人
目的：每个模块尽可能减少了解系统的其他部分，把部分依赖关系隐藏起来，减少调用者双方了解更多细节
场景：如果被调方接口频繁修改时

例子：

class Person{
  constructor(name){
    this._name = name;
  }
  get name(){
    return this._name;
  }
  get department(){
    return this._department;
  }
  set department(name){
    this._department = name;
  }
}
class Department{
  construtor(department){
    this._department = department;
  }
  get manager(){
    if(this._department === 'xx'){
      return 'xx manager';
    } 
    return 'default manager'; 
  }
}
const person = new Person('John');
person.department = new Department('human resource');
const manager = person.department.manager;

class Person{
  constructor(name){
    this._name = name;
  }
  get name(){
    return this._name;
  }
  get department(){
    return this._department;
  }
  set department(name){
    this._department = name;
  }
  get manager(){
    return this._department.manager;
  }
}
class Department{
  construtor(department){
    this._department = department;
  }
  get manager(){
    if(this._department === 'xx'){
      return 'xx manager';
    } 
    return 'default manager'; 
  }
}
const person = new Person('John');
person.department = new Department('human resource');
const manager = person.manager;

7.8 移除中间人

对立：隐藏委托关系
目的：减少不不必要的委托
场景：如果过多的转发函数没有让程序本身提升的扩展性，就应删除部分委托

例子：与之相反隐藏委托关系

const person = new Person('John');
person.department = new Department('human resource');
const manager = person.manager;

const person = new Person('John');
person.department = new Department('human resource');
const manager = person.department.manager;

7.9 替换算法

目的：用简单算法处理
场景：随着对业务不断深入，发觉有更简单的算法实现

例子：

function foundPerson(people){
  for(let i = 0; i < people.length; i++){
    if(people[i] === 'John'){
      return 'John';
    }
    if(people[i] === 'Maria'){
      return 'Maria';
    }
    if(people[i] === 'Mike'){
      return 'Mike';
    }
  }
  return '';
}

function foundPerson(people){
  const candidate = ['John', 'Maria', 'Mike'];
  return people.find(p => candidate.includes(p)) || '';
}

8 搬移特性

8.1 搬移函数

目的：减少对不常用函数的外部依赖，增加常用函数的内部依赖，高内聚
场景：如果一个方法频繁调用别处的一个函数，并且被频繁调用的函数在该上下文关系不大时

例子：

class Account{
  get overdraftCharge(){}
}

class AccountType{
  get overdraftCharge(){}
}

将内聚放在一个类中，改名；变量为名词；方法为动词。

8.2 搬移字段

目的：高内聚，将不属于当前类的属性搬到另一个类中
场景：如果修改一条记录时，总是需要同时改动另一个记录

例子：

class Customer{
  constructor(plan, discountRate){
    this._plan = plan;
    this._discountRate = discountRate;
  }
  get plan(){
    return this._plan;
  }
  get discountRate(){
    return this._discountRate;
  }
}
const john = new Customer('John');
console.info(john.plan);
console.info(john.discountRate);

class Customer{
  constructor(plan){
    this._plan = plan;
  }
  get plan(){
    return this._plan;
  }
  get discountRate(){
    return this.plan.discountRate;
  }
}
const john = new Customer({
  name: 'John',
  discountRate: 0.25
});
console.info(john.plan);
console.info(john.discountRate);

8.3 搬移语句到函数

对立：搬移语句到调用者
目的：消除重复，提取公共内容，即表现一致的行为
场景：发现调用某个函数时，总有一些相同的代码也需要每次执行

例子：

function getResult(person) {
  let result = [];
  result.push(`<p>title: ${person.photo.title}</p>`);
  result = result.concat(photoData(person.photo));
  function photoData(photo){
    return [
      `<p>location: ${photo.location}</p>`,
      `<p>date: ${photo.date}</p>`
    ];
  }
  return result;
};
getResult({photo: {title: 'title', location: 'New York', data: '01/16/2022'}});

function getResult(person) {
  function photoData(photo){
    return [
      `<p>title: ${photo.title}</p>`,
      `<p>location: ${photo.location}</p>`,
      `<p>date: ${photo.date}</p>`
    ];
  }
  return [].concat(photoData(person.photo));
};
getResult({photo: {title: 'title', location: 'New York', data: '01/16/2022'}});

8.4 搬移语句到调用者

对立：搬移语句到函数
目的：将可变的行为搬移到调用者内部
场景：以往多个地方公共的行为，如今需要在某些调用点表现不同的行为，并且调用点与调用者之间的边界差别不大。如果差别较大的，只能重新设计

例子：

function demoWrapper(outStream, person){
  emitPhotoData(outStream, person.photo);
  function emitPhotoData(outStream, photo){
    outStream.write(`<p>title: ${photo.title}</p>`);
    outStream.write(`<p>title: ${photo.location}</p>`);
  }
}

const person = {photo: {title: 'title', location: 'New York'}};
demoWrapper(document, person);

function demoWrapper(outStream, person){
  emitPhotoData(outStream, person.photo);
  outStream.write(`<p>title: ${person.photo.title}</p>`);
  function emitPhotoData(outStream, photo){
    outStream.write(`<p>title: ${photo.location}</p>`);
  }
}

const person = {photo: {title: 'title', location: 'New York'}};
demoWrapper(document, person);

8.5 以函数调用取代内联代码

目的：消除重复
场景：如果一些内联代码做的事情是已有函数可以做到的

例子：

function demoWrapper(states){
  let hasMa = false;
  for(const i of states){
    if(i === 'MA'){
      hasMa = true;
    }
  }
  return hasMa;
}
demoWrapper(['MA','AL']);

function demoWrapper(states){
  return states.includes('MA');
}
demoWrapper(['MA','AL']);

8.6 移动语句

目的：高内聚内部代码
场景：如果有几行代码取用了同一个数据结构，那么最好让它们在一起

例子：

const retrievePricingPlan = () => ({unit: () => 0.25});
const retrieveOrder = () => ({name: 'abc'});
const pricePlan = retrievePricingPlan();
const order = retrieveOrder();
let charge;
const chargePerUnit = pricePlan.unit();

const retrievePricingPlan = () => ({unit: () => 0.25});
const pricePlan = retrievePricingPlan();
const chargePerUnit = pricePlan.unit();
const retrieveOrder = () => ({name: 'abc'});
const order = retrieveOrder();
let charge;

8.7 拆分循环

目的：保持循环内部只做一件事
场景：如果循环内部身兼多职

例子：

const people = [{age: 20, salary: 20000}, {age: 22, salary: 30000}];
let totalAge = 0;
let totalSalary = 0;
for(const p of people){
  totalAge += p.age;
  totalSalary += p.salary;
}
const averageAge = totalAge / people.length;

const people = [{age: 20, salary: 20000}, {age: 22, salary: 30000}];
let totalAge = 0;
for(const p of people){
  totalAge += p.age;
}
let totalSalary = 0;
for(const p of people){
  totalSalary += p.salary;
}
const averageAge = totalAge / people.length;

先进行重构，在进行性能优化。将代码变得清晰，对后期的扩展、优化，都极其方便

8.8 以管道取代循环

目的：提高代码可读性
场景：如果代码的逻辑可以通过内置方法处理

例子：

const names = [];
const values = [{job: 'programmer', name: 'John'}, {job: 'financer', name: 'Kaly'}];
for(const i of values){
  if(i.job === 'programmer'){
    names.push(i.name);
  }
}
console.info(names);

const values = [{job: 'programmer', name: 'John'}, {job: 'financer', name: 'Kaly'}];
const names = values
  .filter(i => i.job === 'programmer')
  .map(i => i.name);
console.info(names);

8.9 移除死代码

目的：移除无用代码

9 重新组织数据

9.1 拆分代码

目的：每个变量只承担一个责任，同一个变量承担两件不同的事情，会令代码阅读者糊涂
场景：大多数情况下变量只赋值一次，除了：循环变量（例如：for(let i =0; i < 5; i++) 中的i），收集结果变量

例子：

let height = 10; 
let width = 20;
let temp = 2 * (height + width);
temp = height * width;

const height = 10; 
const width = 20;
const perimeter = 2 * (height * width);
const area = height * width;

变量声明可以刚开始声明为 const，如果发觉需要重复赋值，再改为 let

9.2 字段改名

目的：好的名字可以帮助阅读者更易理解

例子：

class Organization{
  get name(){}
}

class Organization{
  get title(){}
}

9.3 以查询取代派生变量

目的：减少方法中的副作用，单一原则
场景：对数据的修改常常导致代码的各个部分以丑陋的形式互相耦合：在一处修改数据，却在另一处造成难以发现的破坏

例子：

class ProductPlan{
  constructor(num){
    this._product = num;
  }
  get product(){
    return this._product;
  }
  applyAdjustment(num){
    this._accumulator.push(num);
    this._product += num;
  }
  showProductList(){
    console.info(this._accumulator);
  }
}

class Product{
  constructor(num){
    this._initialProduct = num;
    this._accumulator = [];
  }
  get productTotal(){
    return this._initialProduct + this.productCalculator;
  }
  get productCalculator(){
    return this._accumulator.reduce((sum, cur) => sum + cur, 0);
  }
  applyAdjustment(num){
    this._accumulator.push(num);
  }
  showProductList(){
    console.info(this._accumulator);
  }
}

9.4 将引用对象改为值对象

对立：将值对象改为引用对象
目的：值对象的不可变性处理起来更容易，可以任意的传递，防止被外部修改
场景：如果不需要改变值的引用关系，每个值是不可变的

例子：

class Person{
  constructor(){
    this._telephoneNum = new TelephoneNumber(); 
  }
  get officeAreaCode(){
    return this._telephoneNum.areaCode;
  }
  set officeAreaCode(code){
    this._telephoneNum.areaCode = code;
  }
  get officeNumber(){
    return this._telephoneNum.number;
  }
  set officeNumber(number){
    this._telephoneNum.number = number;
  }
}
class TelephoneNumber{
  get areaCode(){
    return this._areaCode; 
  }
  set areaCode(code){
    this._areaCode = code; 
  }
  get number(){
    return this._number; 
  }
  set number(number){
    this._number = number; 
  }
}

class Person{
  get officeAreaCode(){
    return this._telephoneNum.areaCode;
  }
  set officeAreaCode(code){
    this._telephoneNum = new TelephoneNumber(code, this.officeNumber);
  }
  get officeNumber(){
    return this._telephoneNum.number;
  }
  set officeNumber(number){
    this._telephoneNum = new TelephoneNumber(this.officeAreaCode, number);
  }
}
class TelephoneNumber{
  constructor(areCode, number){
    this._areaCode = areaCode;
    this._number = number;
  }
  get areaCode(){
    return this._areaCode; 
  }
  set areaCode(code){
    this._areaCode = code; 
  }
  get number(){
    return this._number; 
  }
  set number(number){
    this._number = number; 
  }
}

9.5 将值对象改为引用对象

目的：保持数据共享
场景：如果数据结构中包含多个记录，而这些记录都有关联到同一个逻辑的数据结构，例如一个数据的改动，需要共享到整个数据集

例子：

class Customer{
  constructor(id){
    this._id = id;
  }
  get id(){
    return this._id;
  }
}
class Order{
  constructor(data){
    this._number = data.number;
    this._customer = new Customer(data.customer);
  }
  get customer(){
    return this._customer;
  }
}
const order = new Order({
  number: 100,
  customer: '001'
});

class Customer{
  constructor(id){
    this._id = id;
  }
  get id(){
    return this._id;
  }
}
class Order{
  constructor(data){
    this._number = data.number;
    this._customer = repo.registerCustomer(data.customer);
  }
  get customer(){
    return this._customer;
  }
}
const repo = {
  repoData: {
      customers: new Map()
  },
  registerCustomer(id){
    if(!this.repoData.customers.has(id)){
      this.repoData.customers.set(id, new Customer(id));
    }
    return this.repoData.customers.get(id);
  }
}
new Order({
  number: 100,
  customer: '001'
});
console.info(repo.repoData.customers.get('001'));
new Order({
  number: 100,
  customer: '002'
});
console.info(repo.repoData.customers.get('002'));

10 简化条件逻辑

10.1 分解条件表达式

目的：简化条件，易于理解代码逻辑
场景：当检查处理逻辑复杂时

例子：

function demoWrapper(date, plan, quantity){
  let charge;
  if(!date.isBefore(plan.summerStart) && !date.isAfter(plan.summerEnd)){
    charge = quantity * plan.summerRate;
  }else{
    charge = quantity * plan.regularRate + plan.regularServiceCharge;
  }
  return charge;
}

function demoWrapper(date, plan, quantity){
  function isSummer(){
    return !date.isBefore(plan.summerStart) && !date.isAfter(plan.summerEnd);
  }
  function summerCharge(){
    return quantity * plan.summerRate;
  }
  function regularCharge(){
    return quantity * plan.regularRate + plan.regularServiceCharge;
  }
  return isSummer() ? summerCharge() : regularCharge();
}

10.2 合并条件表达式

目的：统一处理条件语句
场景：当检查条件各不相同，最终行为一致时

例子：

function demoWrapper(age, experience, isPassTest){
  if(age < 18) return 'younger';
  if(experience < 5) return 'younger';
  if(!isPassTest) return 'younger';
}

function demoWrapper(age, experience, isPassTest){
  if(isYounger(age, experience, isPassTest)) return 'younger';
  function isYounger(age, experience, isPassTest){
    return age<18 || experience < 5 || !isPassTest;
  }
}

10.3 卫语句取代嵌套条件表达式

目的：减少逻辑的复杂度
场景：当出现需要单独检查某个特定条件时

例子：

function getPayment(isRead, isSeparated, isRetired){
  let result;
  if(isRead){
    result = deadAmount();
  }else{
    if(isSeparated){
      result = separatedAmount();
    }else{
      if(isRetired){
        result = retiredAmount();
      }else{
        result = normalAmount();
      }
    }
  }
}
function deadAmount() {
  return 'deadAmount';
}
function separatedAmount() {
  return 'separatedAmount';
}
function retiredAmount() {
  return 'retiredAmount';
}
function normalAmount() {
  return 'normalAmount';
}

function getPayment(isRead, isSeparated, isRetired){
  if(isRead) return deadAmount();
  if(isSeparated) return separatedAmount();
  if(isRetired) return retiredAmount();
  return normalAmount();
}
function deadAmount() {
  return 'deadAmount';
}
function separatedAmount() {
  return 'separatedAmount';
}
function retiredAmount() {
  return 'retiredAmount';
}
function normalAmount() {
  return 'normalAmount';
}

10.4 以多态取代条件表达式

目的：增强扩展性，减少逻辑的复杂度
场景：当多个逻辑处理情况

例子：

function getBird(){
  return {
    type: 'EuropeanSwallow'
  }
}
const bird = getBird();
switch(bird.type){
  case 'EuropeanSwallow':
    return 'EuropeanSwallow';
  case 'AfricanSwallow':
    return 'AfricanSwallow';
  default:
    return 'unknown';
}

class EuropeanSwallow{
  get name(){
    return 'EuropeanSwallow';
  }
}
class AfricanSwallow{
  get name(){
    return 'AfricanSwallow';
  }
}

10.5 引入特例

目的：提供复用性以及统一性
场景：如果某部分逻辑都在检查某个特殊值，并且处理的逻辑也都相同

例子：

let customer = getCustomer();
if(customer === 'unknown'){
  customerName = 'occupant';
}
function getCustomer(){ return 'normal'; }

class UnknownCustomer{
  get name(){
    return 'occupant';
  }
}

10.6 引入断言

目的：保障传入值是可预测的，预习发现测试的BUG

例子：

const discountRate = getDiscountRate();
let base = 10;
if(discountRate){
  base = base - discountRate * base;
}
function getDiscountRate(){ return 0.25;}

let base = 10;
const discountRate = getDiscountRate();
asset(discountRate > 0);
if(discountRate){
  base = base - discountRate * base;
}
function getDiscountRate(){ return 0.25;}

11 重构API

11.1 查询函数和修改函数分离

目的：减少函数副作用 == 任何有返回值的函数，都要减少它的副作用
场景：当函数中又有查询，又有命令

例子：

function getTotalOutStandingAndSendBill(customer){
  const result = customer.invoice.reduce((total, cur)=> cur.amount + total, 0);
  sendBill(result);
  return result;
}
function sendBill(){}

function getTotalStanding(customer){
  return customer.invoice.reduce((total, cur)=> cur.amount + total, 0);
}
function sendBill(){}
function handler(){
  const totalOutstanding = getTotalStanding();
  sendBill(totalOutstanding);
}

11.2 函数参数化

目的：增强函数的功能
场景：如果发现多个函数逻辑相似，只有某1-2个字面量不同

例子：

function tenPercentRaise(person){
  person.salary = person.salary.multiply(1.1);
}
function fivePercentRaise(person){
  person.salary = person.salary.multiply(0.05);
}

function raise(person, factor){
  person.salary = person.salary.multiply(factor);
}

11.3 移除标记参数

目的：代码更清晰，减少函数的复杂度。去除flag - 一般为true/false
场景：如果参数值影响函数内部的控制流

例子：

function takeOrder(order){
  const date = getOrderDate(order, true);
}
function takeAnotherOrder(order){
  const date = getOrderDate(order, false);
}
function getOrderDate(order, isExpire){
  return isExpire ? '02/01/2022' : '02/01/2023';
}

function takeOrder(order){
  const date = getExpireOrder(order);
}
function takeAnotherOrder(order){
  const date = getNormalOrder(order);
}
function getExpireOrder(order){
  return order.date + 5;
}
function getNormalOrder(order){
  return order.date;
}

11.4 保持对象完整性

目的：缩短参数列表，参数配置灵活
场景：如果传入多个参数传值

例子：

const temperature = { low: 10, high: 30 };
const { low, high } = temperature;
if(isValidTemperature(low, high)){
  console.info('valid');
};
function isValidTemperature(low, high){
  return low > 0 && high < 100 && high > low;
}

const temperature = { low: 10, high: 30 };
if(isValidTemperature(temperature)){
  console.info('valid');
};
function isValidTemperature({ low, high }){
  return low > 0 && high < 100 && high > low;
}

11.5 以查询取代参数

对立：以参数取代查询
目的：减少传参，从而减少调用者的成本
场景：如果传入多个参数，并且从一个参数推导出另一个参数

例子：

const employee = {grade: 'A', name: 'John'};
availableVacation(employee, employee.grade);
function availableVacation(employee, grade){
  console.info(grade);
}

const employee = {grade: 'A', name: 'John'};
availableVacation(employee);
function availableVacation(employee){
  const { grade } = employee;
  console.info(grade);
}

11.6 以参数取代查询

对立：以查询取代参数
目的：减少函数的副作用，以及引用关系，保持函数的纯净度
场景：如果函数引用了一个全局变量，或者引用想移除的元素

例子：

const weather = {curTemperature: 20, unit: 'fahrenheit'};
const plan = {desc: 'go swimming'};
targetTemperature(plan);
getWeatherUnit();
function targetTemperature(plan){
  const { curTemperature } = weather;
  console.info(plan.desc);
}

function getWeatherUnit(){
  return weather.unit;
}

const weather = {curTemperature: 20, unit: 'fahrenheit'};
const plan = {desc: 'go swimming'};
targetTemperature(plan, weather);
getWeatherUnit(weather);

function targetTemperature(plan, weather){
  const { curTemperature } = weather;
  console.info(plan.desc);
}

function getWeatherUnit(weather){
  return weather.unit;
}

11.7 移除设置函数

目的：防止某字段被修改
场景：当不希望某个字段被修改时

例子：

class Person{
  get id(){}
  set id(name){}
}

class Person{
  get id(){}
}

11.8 以工厂函数取代构造函数

目的：增加灵活性
场景：不存在继承关系时

例子：

const leadEngineer = new Employee('name','E');
class Employee{}

const leadEngineer = createEngineer('name');
function createEngineer(){}

11.9 以命令取代函数

对立：以函数取代命令
目的：命令对象提供更大的灵活性，并且还可以支持撤销、生命周期的管理等附加操作
场景：当普通函数无法提供强有力灵活性

例子：

function score(candidate, medicalExam){
  const whiteList = ['Haven', 'Kaly'];
  let result = 0;
  if(medicalExam.isPass){
    result += 10;
  }else{
    result -= 20;
  }
  if(whiteList.includes(candidate.name)){
    result += 20;
  }
  return result;
}

class Scorer{
  constructor(candidate, medicalExam){
    this._candidate = candidate;
    this._medicalExam = medicalExam;
  }
  execute(){
    const whiteList = ['Haven', 'Kaly'];
    let result = 0;
    if(this._medicalExam.isPass){
      result += 10;
    }else{
      result -= 20;
    }
    if(whiteList.includes(this._candidate.name)){
      result += 20;
    }
    return result;
  }
}

11.10 以函数取代命令

对立：以命令取代函数
目的：函数简单化
场景：大多数情况下，只想调用一个函数，完成自己的工作，不需要函数那么复杂

例子：

class ChargeCalculator{
  constructor(customer, usage){
    this._customer = customer;
    this._usage = usage;
  }
  execute(){
    return this._customer.rate * this._usage;
  }
}

function charge(customer, usage){
  return customer.rate * usage;
}

12 处理继承关系

继承体系里上下调整：函数上移、字段上移、构造函数本体上移、函数下移、字段下移
继承体系添加新类或者删除旧类：移除子类、提取超类、折叠继承体系
一个字段仅用于类型码使用：以子类取代类型码
如果本来使用集成的场景变得不再适合：以委托取代子类、以委托取代超类

12.1 函数上移

对立：函数下移
目的：提高复用性，减少重复
场景：当函数被大部分部分子类用到时

例子：

class Employee{}
class Salesman extends Employee{
  get name(){}
}
class Engineer extends Employee{
  get name(){}
}

class Employee{
  get name(){}
}
class Salesman extends Employee{}
class Engineer extends Employee{}

12.2 字段上移

移构造函数本体上移

12.3 构造函数本体上移

目的：提高复用性
场景：当多个子类有公共字段

例子：

class Party{}
class Employee extends Party{
  constructor(id){
    this._id = id;
  }
}
class Salesman extends Employee{
  constructor(id, name){
    this._id = id;
    this._name = name;
  }
}

class Party{
  constructor(id){
    this._id = id;
  }
}
class Employee extends Party{
  constructor(id){
    super(id);
  }
}
class Salesman extends Employee{
  constructor(id, name){
    super(id);
    this._name = name;
  }
}

12.4 函数下移

对立：函数上移
目的：内聚子类的方法
场景：当函数被小部分子类用到时

例子：

 class Employee{
 	get quota(){}
 }
 class Salesman extends Employee{}
 class Engineer extends Employee{}

 class Employee{}
 class Salesman extends Employee{
 	get quota(){}
 }
 class Engineer extends Employee{}

12.5 字段下移

对立：字段上移
目的：内聚子类的字段
场景：当字段被小部分子类用到时

例子：

class Employee{
  constructor(quote){
    this._quote = quote;
  }
}
class Salesman extends Employee{
  constructor(quote){
    super(quote);
  }
}
class Engineer extends Employee{}

class Employee{}
class Salesman extends Employee{
  constructor(quote){
    this._quote = quote;
  }
}
class Engineer extends Employee{}

12.6 以子类取代类型码

对立：移除子类
目的：更明确地表达数据与类型之间的关系，增强子类的扩展性
场景：当不同的状态码表现不同的行为时

例子：

function createEmployee(name, type){
  return new Employee(name, type);
}
class Engineer{}

function createEmployee(name, type){
  const employeeTypes = (name) =>{
    return{
      engineer: new Engineer(name),
      salesman: new Salesman(name)
    }
  }
  return employeeTypes(name)[type];
}
class Engineer{}
class Salesman{}

12.7 移除子类

对立：以子类取代类型码
目的：减少系统复杂度
场景：当子类的用处太少时，当子类简单

例子：

class Person{
  get genderCode(){
    return 'X';
  }
}
class Male extends Person{
  get genderCode(){
    return 'M';
  }
}
class Female extends Person {
  get genderCode(){
    return 'F';
  }
}

class Person{
  constructor(genderCode){
    this._genderCode = genderCode;
  }
  get genderCode(){
    return this._genderCode;
  }
}

12.8 提取超类

目的：把重复的行为收拢起来
场景：当多个子类的方法基本一致时

例子：

class Department{
  get totalAnnualCost(){}
  get name(){}
}
class Employee{
  get annualCost(){}
  get name(){}
  get id(){}
}

class Party{
  get totalAnnualCost(){}
  get name(){}
}
class Department extends Party{
  get primaryCost(){}
}
class Employee extends Party{
  get id(){}
}

12.9 折叠继承体系

目的：合并子类，减少不必要的子类，降低系统复杂度
场景：当超类与子类没有多大差别

例子：

class Employee{
  getSalary(){} 
}
class Sales extends Employee{}

class Employee{
  getSalary(){}
}

12.10 以委托取代子类

目的：增强类的扩展性
场景：当子类可能存在多种类型上的变化

例子

class Booking{
  constructor(show, date){
    this._show = show;
    this._date = date;
  }
}

class PremiumBooking extends Booking{
  constructor(show, date, extras){
    super(show, date);
    this._extras = extras;
  }
}

class Booking{
  constructor(show, date){
    this._show = show;
    this._date = date;
    this._premium = null;
  }
  bePremium(extras){
    this._premium = new PremiumBookingDelegate(this, extras);
  }
}

class PremiumBookingDelegate{
  constructor(root, extras){
    this._root = root;
    this._extras = extras;
  }
}

12.11 以委托取代超类

目的：增强类的扩展性
场景：当超类的部分方法不适用于子类，不清晰的继承关系

例子：

class List{}
class Stack extends List{}

class List{}
class Stack{
  constructor(){
    this._list = new List();
  }
}

超类的所有方法都适用于子类，子类的所有实例都是超类的实例 => 使用继承

如果发现继承有问题（扩展困难），再使用以委托取代超类

重构改善既有代码的设计pdf 重构改善既有代码的设计pdf github 重构改善既有代码的设计第二版pdf 重构改善既有代码的设计pdf下载重构改善既有代码的设计源码重构改善既有代码的设计javascript 重构第2版全彩精装版pdf