《重构: 改善即有代码的设计》读书笔记

192 阅读20分钟

WechatIMG417.jpg

一、概述

1.1 重构的定义

重构是指对在不改变软件可观察行为的前提下,对软件内部结构的一种调整

1.2 重构的重要性

1.2.1 为什么需要重构

  1. 难以阅读的程序,难以修改;
  2. 逻辑重复的程序,难以修改;
  3. 添加新的功能时需要修改已有的代码逻辑,难以修改
  4. 复杂的条件逻辑程序,难易修改

1.2.2 重构可以解决哪些问题

  1. 提高代码质量: 同构重构,我们可以激昂原本复杂、混乱的代码变为简洁、清晰的代码,提高代码的可读性和可维护性
  2. 降低维护成本: 随着项目的发展,代码库会日渐变得庞大和复杂,如果没有适时进行重构,代码的维护成本将变得越来越高,甚至导致项目无法继续进行
  3. 提高开发效率: 重构不仅可以改善即有代码的质量,还可以帮助我们更好地设计新功鞥。通过重构,我们可以将一些通用的、重复的代码提取出来,形成可复用的模块,从而减少重复工作量,提高开发效率
  4. 适应变化: 通过重构,我们可以使代码结构更加灵活,更容易适应变化。当需求发生变化的时候,我们只需要修改少许的代码就可以实现需求,而不用重构整个代码库
  5. 技术债务管理: 随着技术的不断发展和更新,旧的代码可能会逐渐变得过时和不再适用。通过重构,我们可以逐步淘汰这些过时的代码,引入新的技术和方法,从而避免技术债务不断积累

1.2.3 重构目标

  1. 容易阅读
  2. 所有重复逻辑都能被提取出来,复用
  3. 新的改动不会导致危险行为

二、 重构的时机

2.1 重构信号

  1. 添加新功能时:在添加新功能的过程中,如果发现现有代码的设计或结构不利于新功能的实现,或者会使新功能的实现变得复杂,那么可以考虑进行重构。重构后的代码应该使新功能的添加更加简单、直接和清晰。
  2. 修补错误时:在修复代码中的错误时,如果发现错误产生的原因是由于代码设计或结构的问题,那么可以考虑在修复错误的同时进行重构,以改善代码的设计和结构,防止类似错误的再次发生。
  3. 代码复审时:在进行代码复审的过程中,如果发现代码存在设计或结构上的问题,如代码重复、逻辑混乱、可读性差等,那么可以考虑进行重构以改善这些问题

2.2 什么时候不该重构

  1. 当代码不能正常运行时不该进行重构,代码不能正常运行时的首要任务是解决问题
  2. 项目进度较赶时

三、 重构手法

3.1 常见的代码结构问题

  1. 重复代码
  2. 过长函数
  3. 过大类
  4. 过长参数列表
  5. 发散式变化: 如果一个类经常因为多种不同的原因而发生变化,那么可能意味着这个类承担了过多的职责
    • 这种情况下,可以考虑将类的不同职责分离到不同的类中,以减少类的重复性
// 一个Person 类起初只有 name、age、address 等基本信息,随着时间的推移,可能需要在这个类中添加更多新的东西,如添加电话号码、电子邮件定制、社交媒体账号等
// 这些修改和扩展可能会导致 Person 类的代码结构变得庞大和复杂,其中包含大量的属性和方法,这些属性和方法之间存在复杂的依赖关系
class Person{
	constructor(name, age, address){
		this.name = name;
		this.age = age;
		this.address = address;
	}
	...
}

6.改变函数声明:修改函数的签名,包括函数名称、参数列表等。这可以使函数更加符合其实际用途,提高代码的可读性和可维护性。 * 封装变量:将一个类的字段(变量)封装在私有属性中,并通过公共的getter和setter方法进行访问和修改。这样做可以提高代码的安全性和可维护性,因为可以控制对字段的访问和修改。 7. 依恋情结: 如果一个函数过于依赖于另一个模块的函数或数据,那么就可能使依赖情结的信号 * 可以通过重构来减少这种依赖关系,提高代码的独立性和可复用性

3.2 常见的重构手法

  1. 提炼函数:将一个方法中的部分代码提取出来,形成一个新的独立方法。这样做可以使代码更易于阅读和理解,因为每个函数都只做一件事情,并且具有明确的名称。
// 重构前
function printOwing(amount) {  
  if (amount > 0) {  
    console.log("You owe me $" + amount);  
  } else {  
    console.log("You don't owe me anything!");  
  }  
}  

// 重构后
function printOwing(amount) {  
  printMessage(amount);  
}  
  
function printMessage(amount) {  
  if (amount > 0) {  
    console.log("You owe me $" + amount);  
  } else {  
    console.log("You don't owe me anything!");  
  }  
}
  1. 内联函数:与提炼函数相反,内联函数是将一个函数体直接替换为它的函数调用。这通常适用于函数体非常简短,且其内部代码的可读性与函数名称相近的情况。
// 重构前
function isPrime(x) {  
  if (x < 2) {  
    return false;  
  }  
  for (let i = 2; i <= Math.sqrt(x); i++) {  
    if (x % i === 0) {  
      return false;  
    }  
  }  
  return true;  
}  
  
function isPrimeNumber(number) {  
  return isPrime(number);  
}  


// 重构后
function isPrimeNumber(number) {  
  if (number < 2) {  
    return false;  
  }  
  for (let i = 2; i <= Math.sqrt(number); i++) {  
    if (number % i === 0) {  
      return false;  
    }  
  }  
  return true;  
}
  1. 提炼变量:将一个复杂的表达式的结果赋值给一个变量,以便在后续的代码中重复使用。这样做可以使代码更易于阅读和维护,因为变量名可以提供有关该值含义的上下文。
// 重构前
function calculatePrice(quantity, itemPrice) {  
  var basePrice = itemPrice * quantity;  
  if (quantity > 50) {  
    basePrice = basePrice * 0.95; // 5% 折扣  
  }  
  return basePrice;  
}  

// 重构后
function calculatePrice(quantity, itemPrice) {  
  var basePrice = itemPrice * quantity;  
  var discount = quantity > 50 ? 0.95 : 1; // 如果有折扣则为 0.95,否则为 1  
  var finalPrice = basePrice * discount;  
  return finalPrice;  
}
  1. 内联变量:与提炼变量相反,内联变量是将一个变量的值直接替换为其赋值表达式。这通常适用于变量只被赋值一次,并且其值在后续代码中只被使用一次的情况。
// 重构前
function calculatePrice(quantity, itemPrice) {  
  var basePrice = itemPrice * quantity;  
  return basePrice;  
}  

// 重构后
function calculatePrice(quantity, itemPrice) {  
  return itemPrice * quantity;  
}
  1. 改变函数声明:修改函数的签名,包括函数名称、参数列表等。这可以使函数更加符合其实际用途,提高代码的可读性和可维护性。
// 重构前
function calculatePrice(quantity, itemPrice) {  
  // ...  
}  


// 重构后
const calculatePrice = function(quantity, itemPrice) {  
  // ...  
};
  1. 封装变量:将一个类的字段(变量)封装在私有属性中,并通过公共的getter和setter方法进行访问和修改。这样做可以提高代码的安全性和可维护性,因为可以控制对字段的访问和修改。
// 重构前
var _privateVariable = 0;  
function incrementPrivateVariable() {  
  _privateVariable++;  
}  
  
// 重构后
class EncapsulatedVariable {  
  constructor() {  
    this._privateVariable = 0;  
  }  
  incrementPrivateVariable() {  
    this._privateVariable++;  
  }  
}  
const instance = new EncapsulatedVariable();  
instance.incrementPrivateVariable();
  1. 变量改名:为变量选择一个更具描述性和意义的名称。一个好的变量名应该能够清晰地表达其用途和含义,从而提高代码的可读性和可维护性。
// 重构前
function calculateArea(length, breadth) {  
  var l = length;  
  var b = breadth;  
  return l * b;  
}  

// 重构后
function calculateArea(length, breadth) {  
  var lengthValue = length;  
  var breadthValue = breadth;  
  return lengthValue * breadthValue;  
}
  1. 引入参数对象:当一个方法的参数列表过长或参数之间存在紧密关联时,可以考虑将这些参数封装到一个对象中,并将该对象作为方法的唯一参数。这样做可以使代码更加整洁和易于理解。
# 重构前
function createOrder(customerName, productName, quantity, price) {  
  var order = {  
    customerName: customerName,  
    productName: productName,  
    quantity: quantity,  
    price: price,  
    totalPrice: quantity * price  
  };  
  return order;  
}  
  
// 使用方式  
var order = createOrder("Alice", "Laptop", 2, 999.99);

# 重构后
// 定义一个参数对象  
function OrderDetails(customerName, productName, quantity, price) {  
  this.customerName = customerName;  
  this.productName = productName;  
  this.quantity = quantity;  
  this.price = price;  
}  
  
// 使用参数对象创建订单  
function createOrder(details) {  
  var order = {  
    details: details,  
    totalPrice: details.quantity * details.price  
  };  
  return order;  
}  
  
// 使用方式  
var details = new OrderDetails("Alice", "Laptop", 2, 999.99);  
var order = createOrder(details);

3.3 面向对象编程中的重构手法

  1. 封装记录:当有一个类包含了多个字段,并且这些字段经常一起被使用时,可以考虑将这些字段封装到一个新的类中。这个新的类将负责这些字段的访问和修改,提供清晰的接口给其他类使用。这样做的好处是可以减少数据的直接访问,增加数据的安全性和封装性
# 重构前
let firstName = "John";  
let lastName = "Doe";  
let age = 30;  

# 重构后
class Person {  
  constructor(firstName, lastName, age) {  
    this.firstName = firstName;  
    this.lastName = lastName;  
    this.age = age;  
  }  
}  
  
const person = new Person("John", "Doe", 30);
  1. 封装集合:当一个类中包含了一个集合(如列表、数组等),并且这个集合的成员变量可以被外部类直接修改时,就可能导致类的不稳定和不安全。为了避免这种情况,可以将集合的访问和修改操作封装在类中,只提供添加、移除等操作方法,而不是直接暴露集合本身。这样做可以确保对集合的修改都经过类的控制,减少出错的可能性
# 重构前
let employees = ["Alice", "Bob", "Charlie"];  

# 重构后
class EmployeeList {  
  constructor() {  
    this.employees = [];  
  }  
  
  addEmployee(name) {  
    this.employees.push(name);  
  }  
  
  getEmployee(index) {  
    return this.employees[index];  
  }  
}  
  
const employeesList = new EmployeeList();  
employeesList.addEmployee("Alice");  
employeesList.addEmployee("Bob");  
employeesList.addEmployee("Charlie");  
console.log(employeesList.getEmployee(0)); // Alice
  1. 以对象取代基本类型:当类的某个字段是一个基本类型(如int、float等),并且该字段具有一些行为或属性时,可以考虑将其替换为一个对象。这样做可以将该字段的行为和属性封装在对象中,增加代码的可读性和可维护性
# 重构前
let id = "12345";  

# 重构后
class Identifier {  
  constructor(value) {  
    this.value = value;  
  }  
  
  toString() {  
    return this.value;  
  }  
}  
  
const id = new Identifier("12345");  
console.log(id.toString()); // 12345
  1. 以查询取代临时变量:当一个方法中有一个复杂的临时变量,该变量只是为了计算某个值而存在,并且这个值在计算过程中只被使用一次时,可以考虑将该临时变量替换为一个查询方法。这样做可以将复杂的计算逻辑封装在查询方法中,使代码更加简洁和清晰
# 重构前
let total = calculateTotal(items);  
console.log(total);  
  
# 重构后
console.log(calculateTotal(items));
  1. 提炼类:当一个类承担了过多的责任,即它包含了多种不同的行为或属性时,可以考虑将其拆分为多个类。每个类只负责一部分责任,这样可以提高代码的可读性和可维护性。提炼类是一种常见的重构手法,它有助于将大型、复杂的类拆分为更小的、更易于管理的部分
# 重构前
class Person {  
  constructor(name, age, address) {  
    this.name = name;  
    this.age = age;  
    this.address = address;  
  }  
  
  printDetails() {  
    console.log(`Name: ${this.name}`);  
    console.log(`Age: ${this.age}`);  
    console.log(`Address: ${this.address}`);  
  }  
}  

# 重构后
class Person {  
  constructor(name, age) {  
    this.name = name;  
    this.age = age;  
  }  
  
  printDetails() {  
    console.log(`Name: ${this.name}`);  
    console.log(`Age: ${this.age}`);  
  }  
}  
  
class Address {  
  constructor(street, city, country) {  
    this.street = street;  
    this.city = city;  
    this.country = country;  
  }  
  
  printAddress() {  
    console.log(`Street: ${this.street}`);  
    console.log(`City: ${this.city}`);  
    console.log(`Country: ${this.country}`);  
  }  
}  
  
const person = new Person("John", 30);  
const address = new Address("123 Main St", "New York", "USA");  
person.printDetails();  
address.printAddress();
  1. 内联类:与提炼类相反,内联类是将一个小的、功能简单的类融入到另一个类中。这样做可以减少类的数量,简化代码结构。当一个类只负责一个简单的任务,并且与另一个类紧密相关时,可以考虑使用内联类
# 重构前
class Utility {  
  static isEven(number) {  
    return number % 2 === 0;  
  }  
}  
  
class Calculator {  
  add(a, b) {  
    if (Utility.isEven(a) && Utility.isEven(b)) {  
      return (a + b) / 2;  
    }  
    return a + b;  
  }  
}  

# 重构后
class Calculator {  
  add(a, b) {  
    const isEven = number => number % 2 === 0;  
  
    if (isEven(a) && isEven(b)) {  
      return (a + b) / 2;  
    }  
    return a + b;  
  }  
}
  1. 隐藏委托关系:当一个类使用了另一个类来实现其功能,但不想暴露这种依赖关系时,可以考虑隐藏委托关系。这样做可以减少类之间的耦合度,提高代码的可维护性。隐藏委托关系通常通过引入新的接口或抽象类来实现
# 重构前
class PaymentProcessor {  
  constructor(gateway) {  
    this.gateway = gateway;  
  }  
  
  processPayment(amount) {  
    this.gateway.authorizePayment(amount);  
    this.gateway.capturePayment(amount);  
  }  
}  
  
class PaymentGateway {  
  authorizePayment(amount) {  
    console.log("Authorizing payment for " + amount);  
  }  
  
  capturePayment(amount) {  
    console.log("Capturing payment for " + amount);  
  }  
}  
  
const gateway = new PaymentGateway();  
const processor = new PaymentProcessor(gateway);  
processor.processPayment(100);  

# 重构后
class PaymentProcessor {  
  processPayment(amount) {  
    this.authorizePayment(amount);  
    this.capturePayment(amount);  
  }  
  
  // 隐藏了实际的gateway调用  
  authorizePayment(amount) {  
    console.log("Authorizing payment for " + amount);  
  }  
  
  capturePayment(amount) {  
    console.log("Capturing payment for " + amount);  
  }  
}  
  
const processor = new PaymentProcessor();  
processor.processPayment(100);
  1. 移除中间人:与隐藏委托关系相反,移除中间人是为了解决由于隐藏委托关系而导致的接口频繁变化的问题。当一个类作为中间人存在,它只是简单地将调用转发给另一个类时,可以考虑直接让调用者调用目标类,从而消除中间人
# 重构前
class Employee {  
  constructor(name) {  
    this.name = name;  
  }  
  
  greet() {  
    console.log("Hello, my name is " + this.name);  
  }  
}  
  
class EmployeeManager {  
  constructor(employee) {  
    this.employee = employee;  
  }  
  
  delegateGreet() {  
    this.employee.greet();  
  }  
}  
  
const employee = new Employee("Alice");  
const manager = new EmployeeManager(employee);  
manager.delegateGreet();  

# 重构后
class Employee {  
  constructor(name) {  
    this.name = name;  
  }  
  
  greet() {  
    console.log("Hello, my name is " + this.name);  
  }  
}  
  
const employee = new Employee("Alice");  
employee.greet(); // 直接调用 Employee 的 greet 方法,移除了 EmployeeManager 中间层

3.4 重新组织数据以改善代码设计

  1. 封装字段: 如果你有一个字段(比如一个变量),在代码中很多地方都被直接访问和修改,这可能会让代码变得很混乱。封装字段意味着将这些字段隐藏在一个类或对象中,并提供方法(getter和setter)来访问和修改它们。这样做可以让代码更加整洁,并减少错误。
// 重构前
class Person {  
  constructor(name, age) {  
    this._name = name;  
    this._age = age;  
  }  
  
  // 直接访问和修改字段  
  getName() {  
    return this._name;  
  }  
  
  setName(name) {  
    this._name = name;  
  }  
  
  getAge() {  
    return this._age;  
  }  
  
  setAge(age) {  
    this._age = age;  
  }  
}  
  
let person = new Person("Alice", 30);  
console.log(person.getName()); // 输出 "Alice"  
person.setAge(31);  
console.log(person.getAge()); // 输出 31

// 重构后
class Person {  
  constructor(name, age) {  
    this.name = name; // 直接访问字段,不需要封装  
    this.age = age;   // 直接访问字段,不需要封装  
  }  
}  
  
let person = new Person("Alice", 30);  
console.log(person.name); // 输出 "Alice"  
person.age = 31;  
console.log(person.age); // 输出 31
  1. 集合封装: 如果你的类里有一个列表、数组或其他集合,并且这些集合在代码中经常被修改,那么可以考虑将它们封装起来。通过为集合提供专门的方法来访问和修改,你可以更好地控制这些集合的使用,减少出错的可能性
// 重构前
class Order {  
  constructor() {  
    this.items = []; // 集合字段未封装  
  }  
  
  addItem(item) {  
    this.items.push(item);  
  }  
  
  removeItem(item) {  
    this.items = this.items.filter(i => i !== item);  
  }  
}  
  
let order = new Order();  
order.addItem("Apple");  
order.addItem("Banana");  
console.log(order.items); // 输出 ["Apple", "Banana"]  
order.removeItem("Apple");  
console.log(order.items); // 输出 ["Banana"]

// 重构后
class Order {  
  constructor() {  
    this.items = new OrderItems(); // 使用专门的集合类来封装集合字段  
  }  
  
  addItem(item) {  
    this.items.add(item);  
  }  
  
  removeItem(item) {  
    this.items.remove(item);  
  }  
}  
  
class OrderItems {  
  constructor() {  
    this.list = [];  
  }  
  
  add(item) {  
    this.list.push(item);  
  }  
  
  remove(item) {  
    this.list = this.list.filter(i => i !== item);  
  }  
}  
  
let order = new Order();  
order.addItem("Apple");  
order.addItem("Banana");  
console.log(order.items.list); // 输出 ["Apple", "Banana"]  
order.removeItem("Apple");  
console.log(order.items.list); // 输出 ["Banana"]
  1. 拆分变量: 如果一个变量做了太多事情,或者它的名字不够明确,那么可以考虑将其拆分成多个更简单的变量。这样做可以让代码更容易理解,每个变量只做一件事情,也更容易维护和修改。
// 重构前
function calculateTax(income) {  
  let taxRate = 0.15; // 假设税率是15%  
  let tax = income * taxRate;  
  let netIncome = income - tax;  
  return { tax, netIncome };  
}  
  
let { tax, netIncome } = calculateTax(10000);  
console.log(`Tax: ${tax}, Net Income: ${netIncome}`);

// 重构后
function calculateTax(income, taxRate) {  
  let tax = income * taxRate;  
  let netIncome = income - tax;  
  return { tax, netIncome };  
}  
  
let { tax, netIncome } = calculateTax(10000, 0.15); // 明确传递税率  
console.log(`Tax: ${tax}, Net Income: ${netIncome}`);
  1. 重命名字段: 如果变量的名字不够清晰,或者容易让人误解,那么可以给它起一个新的、更具描述性的名字。这样做可以让代码更容易阅读和理解。
// 重构前
function User(name, age) {  
  this.n = name;  
  this.a = age;  
}  
  
let user = new User("Alice", 30);  
console.log(`Name: ${user.n}, Age: ${user.a}`);

// 重构后
function User(name, age) {  
  this.name = name; // 更明确的字段名  
  this.age = age;   // 更明确的字段名  
}  
  
let user = new User("Alice", 30);  
console.log(`Name: ${user.name}, Age: ${user.age}`); // 使用更明确的字段名
  1. 查询方法取代派生变量: 有时候,我们会通过一些计算来得到一个新的变量值。如果这个计算很复杂,或者经常需要修改,那么可以考虑将其转换为一个方法,每次需要时都调用这个方法。这样做可以避免在代码中重复相同的计算,也更容易维护和修改
// 重构前
function calculateCircleArea(radius) {  
  let diameter = radius * 2;  
  let area = Math.PI * (diameter / 2) ** 2;  
  return area;  
}  
  
console.log(calculateCircleArea(5));


// 重构后
function calculateCircleArea(radius) {  
  return Math.PI * radius ** 2; // 直接使用半径计算面积,消除派生变量  
}  
  
console.log(calculateCircleArea(5));
  1. 引用对象和值对象的选择: 在编程中,对象可以是引用类型(比如类的实例)或值类型(比如基本数据类型)。选择使用哪种类型取决于你的需求。引用对象可以共享和修改状态,而值对象是不可变的。根据需要,你可能需要将引用对象转换为值对象,或者反过来,以提高代码的性能和可维护性。
# 将引用对象改为值对象
// 重构前
class Person {  
  constructor(name) {  
    this.name = name;  
  }  
  
  changeName(newName) {  
    this.name = newName;  
  }  
}  
  
let person = new Person("Alice");  
person.changeName("Bob");  
console.log(person.name); // 输出 "Bob"

// 重构后
function Person(name) {  
  return {  
    name: name,  
    changeName: function(newName) {  
      return Person(newName); // 返回新的值对象  
    }  
  };  
}  
  
let person = Person("Alice");  
person = person.changeName("Bob"); // 必须重新赋值,因为返回了新的值对象  
console.log(person.name); // 输出 "Bob"

# 将值对象改为引用对象
// 重构前
function createCounter() {  
  return {  
    count: 0,  
    increment: function() {  
      this.count++;  
    }  
  };  
}  
  
let counter = createCounter();  
counter.increment();  
console.log(counter.count); // 输出 1  
counter.increment();  
console.log(counter.count); // 输出 2  
  
let anotherCounter = createCounter();  
anotherCounter.increment();  
console.log(anotherCounter.count); // 输出 1,而不是期望的 2

// 重构后
class Counter {  
  constructor() {  
    this.count = 0;  
  }  
  
  increment() {  
    this.count++;  
  }  
}  
  
let counter = new Counter();  
counter.increment();  
console.log(counter.count); // 输出 1  
counter.increment();

3.5 简化条件逻辑

  1. 分解条件表达式: 当遇到复杂的条件逻辑时,可以考虑将其分解成更小的、更易于理解的子条件。这样做的好处是,每个子条件都可以清晰地表达其意图,使代码更易于阅读和维护。例如,如果有一个包含多个嵌套条件判断的函数,可以将其分解为多个独立的函数,每个函数负责处理一个子条件。
// 重构前
function calculateBonus(sales) {  
  if ((sales > 10000 && sales < 50000) || (sales > 100000 && sales < 200000)) {  
    return sales * 0.1;  
  } else {  
    return 0;  
  }  
}

// 重构后
function isHighSales(sales) {  
  return sales > 10000 && sales < 50000;  
}  
  
function isVeryHighSales(sales) {  
  return sales > 100000 && sales < 200000;  
}  
  
function calculateBonus(sales) {  
  if (isHighSales(sales) || isVeryHighSales(sales)) {  
    return sales * 0.1;  
  } else {  
    return 0;  
  }  
}
  1. 合并条件表达式: 有时候,我们可能会遇到多个条件表达式,它们的结果都是相同的。在这种情况下,可以考虑将这些条件表达式合并成一个更通用的条件。这样做可以减少重复的代码,并提高代码的可读性。
// 重构前
function checkUserStatus(user) {  
  if (user.isAdmin && user.isLoggedIn) {  
    return "Admin and logged in";  
  }  
  if (user.isAdmin) {  
    return "Admin";  
  }  
  if (user.isLoggedIn) {  
    return "Logged in";  
  }  
  return "Not logged in";  
}

// 重构后
function checkUserStatus(user) {  
  if (user.isAdmin) {  
    return user.isLoggedIn ? "Admin and logged in" : "Admin";  
  }  
  if (user.isLoggedIn) {  
    return "Logged in";  
  }  
  return "Not logged in";  
}
  1. 使用卫语句: 卫语句是一种重构技巧,它将否定条件放在函数或方法的开头,如果条件满足则立即返回。这样做的好处是可以避免深度嵌套条件,使代码更加清晰和易于理解。
// 重构前
function prepareFood(ingredients) {  
  if (ingredients) {  
    if (ingredients.length > 0) {  
      if (ingredients[0] === 'vegetable') {  
        return cookVegetables(ingredients);  
      } else if (ingredients[0] === 'meat') {  
        return cookMeat(ingredients);  
      }  
    }  
  }  
  return null;  
}

// 重构后
function prepareFood(ingredients) {  
  if (!ingredients) {  
    return null;  
  }  
  if (ingredients.length === 0) {  
    return null;  
  }  
  if (ingredients[0] === 'vegetable') {  
    return cookVegetables(ingredients);  
  } else if (ingredients[0] === 'meat') {  
    return cookMeat(ingredients);  
  }  
  return null;  
}
  1. 多态取代条件逻辑 在面向对象编程中,多态是一种强大的特性,可以用来替代复杂的条件逻辑。通过定义不同的对象类型和方法,可以将条件逻辑转换为对象之间的交互,使代码更加清晰和易于扩展。
// 重构前
function calculateDiscount(item) {  
  if (item.type === 'book') {  
    return item.price * 0.1;  
  } else if (item.type === 'electronics') {  
    return item.price * 0.05;  
  } else {  
    return 0;  
  }  
}


// 重构后
class DiscountCalculator {  
  calculate(item) {  
    return 0;  
  }  
}  
  
class BookDiscountCalculator extends DiscountCalculator {  
  calculate(item) {  
    return item.price * 0.1;  
  }  
}  
  
class ElectronicsDiscountCalculator extends DiscountCalculator {  
  calculate(item) {  
    return item.price * 0.05;  
  }  
}
  1. 引入特例: 如果在代码中多次遇到相同的特殊值,并且对这些特殊值的处理逻辑相同,可以考虑使用特例模式,创建一个专门的处理逻辑来处理这种特殊情况的逻辑,这样可以将多处重复的代码统一到一个地方
// 重构前
function calculateDiscount(product) {  
  let discount = 0;  
  if (product.name === "SpecialProduct") {  
    discount = 10;  
  } else {  
    // 其他产品的折扣逻辑...  
  }  
  return discount;  
}  
  
function calculatePrice(product) {  
  let price = product.price;  
  if (product.name === "SpecialProduct") {  
    price -= 10; // SpecialProduct 享有 10 元的折扣  
  } else {  
    // 其他产品的价格计算逻辑...  
  }  
  return price;  
}

// 重构后
function isSpecialProduct(product) {  
  return product.name === "SpecialProduct";  
}  
  
function calculateDiscount(product) {  
  if (isSpecialProduct(product)) {  
    return 10;  
  }  
  // 其他产品的折扣逻辑...  
}  
  
function calculatePrice(product) {  
  let price = product.price;  
  if (isSpecialProduct(product)) {  
    price -= 10; // SpecialProduct 享有 10 元的折扣  
  }  
  // 其他产品的价格计算逻辑...  
}

四、 重构挑战

  1. 延缓新功能开发: 有些人试图用“整洁的代码”和“良好的工程实践”等道德理由来论证重构的必要性,但这并不是主要的驱动力。重构的真正意义在于从长远来看能够提升软件开发的效率,让我们能更快地添加新功能或修复bug。因此,需要权衡好重构与新功能开发的时机。
  2. 代码所有权问题: 在软件开发过程中,可能会遇到接口发布者与调用者不是同一个人的情况。这时,如果需要重构接口,就可能需要使用函数改名手法,同时保留旧的对外接口来调用新函数,并标记为不推荐使用。
  3. 缺乏自测试代码: 一组好的测试代码对重构很有意义,它能让我们快速发现错误。然而,实现这样的测试代码可能比较复杂。
  4. 遗留代码问题: 在软件开发中,不可避免地会遇到一些别人的代码,特别是那些没有经过合理测试的代码,这可能会给重构带来困难。

五、 最佳实践与建议

  1. 小步快跑: 每次只进行一小步的修改,这样可以降低风险,使得每次的更改都更容易理解和测试。
  2. 保持测试: 在进行重构的过程中,始终保持有一套可靠的测试集,这样可以确保重构不会引入新的错误。
  3. 使用合适的重构手法: 书中介绍了很多重构手法,如提取方法、内联变量、移动方法、重命名变量等,应该根据实际情况选择合适的重构手法。
  4. 不要过度设计: 重构的目的是改善代码的设计,但并不意味着要进行过度设计。应该遵循“稳定中求发展”的原则,逐步改进代码的设计。
  5. 注意代码的可读性: 代码的可读性是非常重要的,应该尽可能地使代码清晰、简洁、易于理解。可以使用有意义的变量名、提取公共方法、减少嵌套层次等方式来提高代码的可读性。
  6. 保持与团队的沟通: 重构可能会影响到团队中的其他成员,因此应该保持与团队的沟通,让他们了解重构的目的和进展,以便他们能够适应新的代码结构。
  7. 记录重构过程: 在进行重构的过程中,应该记录所做的更改和遇到的问题,以便在必要时进行回顾和总结。

六、 未来趋势

  1. 自动化重构工具的发展: 随着AI和机器学习技术的发展,我们可以预见未来会有更多的自动化重构工具出现。这些工具可以基于代码的质量指标、设计模式、最佳实践等因素,自动地提出重构建议并执行重构操作。
  2. 持续集成和持续重构: 随着持续集成(CI)和持续交付(CD)的普及,我们可以预见未来会有更多的团队采用持续重构的方式,即每次提交代码时都进行一定的重构操作,以保持代码的整洁和可维护性。
  3. 云原生和微服务架构的重构挑战: 随着云原生和微服务架构的普及,应用程序的规模和复杂性也在不断增加。这可能会给重构带来更大的挑战,因为需要在保持系统稳定运行的同时,进行大规模的代码重构。
  4. 代码质量标准的提高: 随着软件质量要求的提高,未来可能会出现更严格的代码质量标准。这意味着重构可能会更加频繁和必要,以保持代码的高质量和可维护性。