设计模式第十五讲:重构 - 改善既有代码的设计(下)

简介: 设计模式第十五讲:重构 - 改善既有代码的设计

16、中间人 Middle Man

中间人负责处理委托给它的操作,如果一个类中有过多的函数都委托给其它类,那就是过度运用委托,应当 Remove Middle Man,直接与负责的对象打交道。

17、狎昵关系 Inappropriate Intimacy

两个类多于亲密,花费太多时间去探讨彼此的 private 成分。

18、异曲同工的类 Alernative Classes with Different Interfaces

两个函数做同一件事,却有着不同的签名。

使用 Rename Method 根据它们的用途重新命名。

19、不完美的类库 Incomplete Library Class

类库的设计者不可能设计出完美的类库,当我们需要对类库进行一些修改时,可以使用以下两种方法:如果只是修改一两个函数,使用 Introduce Foreign Method;如果要添加一大堆额外行为,使用 Introduce Local Extension。

20、幼稚的数据类 Data Class

它只拥有一些数据字段,以及用于访问这些字段的函数,除此之外一无长物。

找出字段使用的地方,然后把相应的操作移到 Data Class 中。

21、被拒绝的馈赠 Refused Bequest

子类不想继承父类的所有函数和数据。

为子类新建一个兄弟类,不需要的函数或数据使用 Push Down Method 和 Push Down Field 下推给那个兄弟。

22、过多的注释

Comments

使用 Extract Method 提炼出需要注释的部分,然后用函数名来解释函数的行为。

四、构筑测试体系

Java 可以使用 Junit 进行单元测试。

测试应该能够完全自动化,并能检查测试的结果。

小步修改,频繁测试。

单元测试的对象是类的方法,而功能测是以客户的角度保证软件正常运行。

应当集中测试可能出错的边界条件。

五、重新组织函数

1、提炼函数 Extract Method

将这段代码放进一个独立函数中,并让函数名称解释该函数的用途。

2、内联函数 Inline Method

一个函数的本体与名称同样清楚易懂。

在函数调用点插入函数本体,然后移除该函数。

3、内联临时变量 Inline Temp

一个临时变量,只被简单表达式赋值一次,而它妨碍了其它重构手法。

将所有对该变量的引用替换为对它赋值的那个表达式自身。

double basePrice = anOrder.basePrice();
return basePrice > 1000;
return anOrder.basePrice() > 1000;

4、以查询取代临时变量 Replace Temp with Query

以临时变量保存某一表达式的运算结果,将这个表达式提炼到一个独立函数中,将所有对临时变量的引用点替换为对新函数的调用。

Replace Temp with Query 往往是 Extract Method 之前必不可少的一个步骤,因为局部变量会使代码难以提炼。

double basePrice = quantity * itemPrice;
if (basePrice > 1000)
    return basePrice * 0.95;
else
    return basePrice * 0.98;
if (basePrice() > 1000)
    return basePrice() * 0.95;
else
    return basePrice() * 0.98;
// ...
double basePrice(){
    return quantity * itemPrice;
}

5、引起解释变量 Introduce Explaining Variable

将复杂表达式(或其中一部分)的结果放进一个临时变量, 以此变量名称来解释表达式用途。

if ((platform.toUpperCase().indexOf("MAC") > -1) &&
  (browser.toUpperCase().indexOf("IE") > -1) &&
  wasInitialized() && resize > 0) {
    // do something
}
final boolean isMacOS = platform.toUpperCase().indexOf("MAC") > -1;
final boolean isIEBrower = browser.toUpperCase().indexOf("IE") > -1;
final boolean wasResized = resize > 0;
if (isMacOS && isIEBrower && wasInitialized() && wasResized) {
    // do something
}

6、分解临时变量 Split Temporary Variable

某个临时变量被赋值超过一次,它既不是循环变量,也不是用于收集计算结果。

针对每次赋值,创造一个独立、对应的临时变量,每个临时变量只承担一个责任。

7、移除对参数的赋值 Remove Assigments to Parameters

以一个临时变量取代对该参数的赋值。

int discount (int inputVal, int quentity, int yearToDate) {
    if (inputVal > 50) inputVal -= 2;
    ...
}
int discount (int inputVal, int quentity, int yearToDate) {
    int result = inputVal;
    if (inputVal > 50) result -= 2;
    ...
}

8、以函数对象取代函数 Replace Method with Method Object

当对一个大型函数采用 Extract Method 时,由于包含了局部变量使得很难进行该操作。

将这个函数放进一个单独对象中,如此一来局部变量就成了对象内的字段。然后可以在同一个对象中将这个大型函数分解为多个小型函数。

9、替换算法 Subsititute Algorithn

六、在对象之间搬移特性

1、搬移函数 Move Method

类中的某个函数与另一个类进行更多交流: 调用后者或者被后者调用。

将这个函数搬移到另一个类中。

2、搬移字段 Move Field

类中的某个字段被另一个类更多地用到,这里的用到是指调用取值设值函数,应当把该字段移到另一个类中。

3、提炼类 Extract Class

某个类做了应当由两个类做的事。

应当建立一个新类,将相关的字段和函数从旧类搬移到新类。

4、将类内联化 Inline Class

与 Extract Class 相反。

5、隐藏委托关系 Hide Delegate

建立所需的函数,隐藏委托关系。

class Person {
    Department department;
    public Department getDepartment() {
        return department;
    }
}
class Department {
    private Person manager;
    public Person getManager() {
        return manager;
    }
}

如果客户希望知道某人的经理是谁,必须获得 Department 对象,这样就对客户揭露了 Department 的工作原理。

Person manager = john.getDepartment().getManager();

通过为 Peron 建立一个函数来隐藏这种委托关系。

public Person getManager() {
    return department.getManager();
}

6、移除中间人 Remove Middle Man

与 Hide Delegate 相反,本方法需要移除委托函数,让客户直接调用委托类。

Hide Delegate 有很大好处,但是它的代价是:每当客户要使用受托类的新特性时,就必须在服务器端添加一个简单的委托函数。随着受委托的特性越来越多,服务器类完全变成了一个“中间人”。

7、引入外加函数 Introduce Foreign Method

需要为提供服务的类添加一个函数,但是无法修改这个类。

可以在客户类中建立一个函数,并以第一参数形式传入一个服务类的实例,让客户类组合服务器实例。

8、引入本地扩展 Introduce Local Extension

和 Introduce Foreign Method 目的一样,但是 Introduce Local Extension 通过建立新的类来实现。有两种方式:子类或者包装类,子类就是通过继承实现,包装类就是通过组合实现。

七、重新组织数据

1、自封装字段 Self Encapsulate Field

为字段建立取值/设值函数,并用这些函数来访问字段。只有当子类想访问父类的一个字段,又想在子类中将对这个字段访问改为一个计算后的值,才使用这种方式,否则直接访问字段的方式简洁明了。

2、以对象取代数据值 Replace Data Value with Object

在开发初期,往往会用简单的数据项表示简单的情况,但是随着开发的进行,一些简单数据项会具有一些特殊行为。比如一开始会把电话号码存成字符串,但是随后发现电话号码需要“格式化”、“抽取区号”之类的特殊行为

3、将值对象改成引用对象 Change Value to Reference

将彼此相等的实例替换为同一个对象。这就要用一个工厂来创建这种唯一对象,工厂类中需要保留一份已经创建对象的列表,当要创建一个对象时,先查找这份列表中是否已经存在该对象,如果存在,则返回列表中的这个对象;否则,新建一个对象,添加到列表中,并返回该对象。

4、将引用对象改为值对象 Change Reference to value

以 Change Value to Reference 相反。值对象有个非常重要的特性:它是不可变的,不可变表示如果要改变这个对象,必须用一个新的对象来替换旧对象,而不是修改旧对象。

  • 需要为值对象实现 equals() 和 hashCode() 方法。

5、以对象取代数组 Replace Array with Object

有一个数组,其中的元素各自代表不同的东西。

以对象替换数组,对于数组中的每个元素,以一个字段来表示,这样方便操作,也更容易理解。

6、赋值被监视数据 Duplicate Observed Data

一些领域数据置身于 GUI 控件中,而领域函数需要访问这些数据。

将该数据赋值到一个领域对象中,建立一个 Oberver 模式,用于同步领域对象和 GUI 对象内的重复数据。

7、将单向关联改为双向关联 Change Unidirectional Association to Bidirectional

当两个类都需要对方的特性时,可以使用双向关联。

有两个类,分别为订单 Order 和客户 Customer,Order 引用了 Customer,Customer 也需要引用 Order 来查看其所有订单详情。

class Order {
    private Customer customer;
    public void setCustomer(Customer customer) {
        if (this.customer != null)
            this.customer.removeOrder(this);
        this.customer = customer;
        this.customer.add(this);
    }
}
class Curstomer {
    private Set<Order> orders = new HashSet<>();
    public void removeOrder(Order order) {
        orders.remove(order);
    }
    public void addOrder(Order order) {
        orders.add(order);
    }
}

注意到,这里让 Curstomer 类来控制关联关系。有以下原则来决定哪个类来控制关联关系:如果某个对象是组成另一个对象的部件,那么由后者负责控制关联关系;如果是一对多关系,则由单一引用那一方来控制关联关系

8、将双向关联改为单向关联 Change Bidirectional Association to Unidirectional

和 Change Unidirectional Association to Bidirectiona 为反操作。

双向关联维护成本高,并且也不易于理解。大量的双向连接很容易造成“僵尸对象”:某个对象本身已经死亡了,却保留在系统中,因为它的引用还没有全部完全清除。

  • 第2节

9、以字面常量取代魔法数 Replace Magic Number with Symbolic Constant

创建一个常量,根据其意义为它命名,并将字面常量换为这个常量。

10、封装字段 Encapsulate Field

public 字段应当改为 private,并提供相应的访问函数。

11、封装集合 Encapsulate Collection

函数返回集合的一个只读副本,并在这个类中提供添加/移除集合元素的函数。如果函数返回集合自身,会让用户得以修改集合内容而集合拥有者却一无所知。

12、以数据类取代记录 Replace Record with Data Class

13、以类取代类型码 Replace Type Code with Class

类中有一个数值类型码,但它并不影响类的行为,就用一个新类替换该数值类型码。如果类型码出现在 switch 语句中,需要使用 Replace Conditional with Polymorphism 去掉 switch,首先必须运用 Replace Type Code with Subcalss 或 Replace Type Code with State/Strategy 去掉类型码。

14、以子类取代类型码 Replace Type Code with Subcalsses

有一个不可变的类型码,它会影响类的行为,以子类取代这个类型码。

15、以 State/Strategy 取代类型码 Replace Type Code with State/Strategy

有一个可变的类型码,它会影响类的行为,以状态对象取代类型码。

和 Replace Type Code with Subcalsses 的区别是 Replace Type Code with State/Strategy 的类型码是动态可变的,前者通过继承的方式来实现,后者通过组合的方式来实现。因为类型码可变,如果通过继承的方式,一旦一个对象的类型码改变,那么就要改变用新的对象来取代旧对象,而客户端难以改变新的对象。但是通过组合的方式,改变引用的状态类是很容易的。

16、以字段取代子类 Replace Subclass with Fields

各个子类的唯一差别只在“返回常量数据”的函数上。

八、简化条件表达式

1、分解条件表达式 Decompose Conditional

对于一个复杂的条件语句,可以从 if、then、else 三个段落中分别提炼出独立函数。

if (data.befor(SUMMER_START) || data.after(SUMMER_END))
    charge = quantity * winterRate + winterServiceCharge;
else
    charge = quantity * summerRate;
if (notSummer(date))
    charge = winterCharge(quantity);
else
    charge = summerCharge(quantity);

2、合并条件表达式 Consolidate Conditional Expression

有一系列条件测试,都得到相同结果。

将这些测试合并为一个条件表达式,并将这个条件表达式提炼成为一个独立函数。

double disabilityAmount() {
    if (seniority < 2) return 0;
    if (monthsDisabled > 12 ) return 0;
    if (isPartTime) return 0;
    // ...
}
double disabilityAmount() {
    if (isNotEligibleForDisability()) return 0;
    // ...
}

3、合并重复的条件片段 Consolidate Duplicate Conditional Fragments

在条件表达式的每个分支上有着相同的一段代码。

将这段重复代码搬移到条件表达式之外。

if (isSpecialDeal()) {
    total = price * 0.95;
    send();
} else {
    total = price * 0.98;
    send();
}
if (isSpecialDeal()) {
    total = price * 0.95;
} else {
    total = price * 0.98;
}
send();

4、移除控制标记 Remove Control Flag

在一系列布尔表达式中,某个变量带有“控制标记”的作用。

用 break 语句或 return 语句来取代控制标记。

5、以卫语句取代嵌套条件表达式 Replace Nested Conditional with Guard Clauses

如果某个条件极其罕见,就应该单独检查该条件,并在该条件为真时立刻从函数中返回,这样的单独检查常常被称为“卫语句”(guard clauses)。

条件表达式通常有两种表现形式。第一种形式是:所有分支都属于正常行为。第二种形式则是:条件表达式提供的答案中只有一种是正常行为,其他都是不常见的情况,可以使用卫语句表现所有特殊情况

double getPayAmount() {
    double result;
    if (isDead) result = deadAmount();
    else {
        if (isSeparated) result = separatedAmount();
        else {
            if (isRetired) result = retiredAmount();
            else result = normalPayAmount();
        };
    }
    return result;
};
double getPayAmount() {
    if (isDead) return deadAmount();
    if (isSeparated) return separatedAmount();
    if (isRetired) return retiredAmount();
    return normalPayAmount();
};

6、以多态取代条件表达式 Replace Conditional with Polymorphism

将这个条件表达式的每个分支放进一个子类内的覆写函数中,然后将原始函数声明为抽象函数。需要先使用 Replace Type Code with Subclass 或 Replace Type Code with State/Strategy 来建立继承结果。

double getSpeed() {
    switch (type) {
        case EUROPEAN:
            return getBaseSpeed();
        case AFRICAN:
            return getBaseSpeed()- getLoadFactor()* numberOfCoconuts;
        case NORWEGIAN_BLUE:
            return isNailed ? 0 : getBaseSpeed(voltage);
    }
    throw new RuntimeException("Should be unreachable");
}

7、引入 Null 对象 Introduce Null Object

将 null 值替换为 null 对象。这样做的好处在于,不需要询问对象是否为空,直接调用就行。

if (customer == null) 
  plan = BillingPlan.basic();
else 
  plan = customer.getPlan();

参考这篇文章:设计模式第九讲:常见重构技巧 - 去除不必要的!=

  • 见场景4

8、引入断言 Introduce Assertion

以断言明确表现某种假设。断言只能用于开发过程中,产品代码中不会有断言

double getExpenseLimit() {
    // should have either expense limit or a primary project
    return (expenseLimit != NULL_EXPENSE)
        ? expenseLimit
        : primaryProject.getMemberExpenseLimit();
}
double getExpenseLimit() {
    Assert.isTrue (expenseLimit != NULL_EXPENSE || primaryProject != null);
    return (expenseLimit != NULL_EXPENSE)
        ? expenseLimit
        : primaryProject.getMemberExpenseLimit();
}

九、简化函数调用

1、函数改名 Rename Method

使函数名能解释函数的用途。

2、添加参数 Add Parameter

使函数不需要通过调用获得某个信息。

3、移除参数 Remove Parameter

与 Add Parameter 相反,改用调用的方式来获得某个信息。

4、将查询函数和修改函数分离 Separate Query from Modifier

某个函数即返回对象状态值,又修改对象状态。

应当建立两个不同的函数,其中一个负责查询,另一个负责修改。任何有返回值的函数,都不应该有看得到的副作用。

getTotalOutstandingAndSetReadyForSummaries();
getTotalOutstanding();
setReadyForSummaries();

5、令函数携带参数 Parameterize Method

若干函数做了类似的工作,但在函数本体中却包含了不同的值。

建立单一函数,以参数表达那些不同的值。

fivePercentRaise();
tenPercentRaise();
raise(percentage);

6、以明确函数取代参数 Replace Parameter with Explicit Methods

有一个函数,完全取决于参数值而采取不同行为。

针对该参数的每一个可能值,建立一个独立函数。

void setValue(String name, int value){
    if (name.equals("height")){
        height = value;
        return;
    }
    if (name.equals("width")){
        width = value;
        return;
    }
    Assert.shouldNeverReachHere();
}
void setHeight(int arg){
    height = arg;
}
void setWidth(int arg){
    width = arg;
}

7、保持对象完整 Preserve Whole Object

从某个对象中取出若干值,将它们作为某一次函数调用时的参数。

改为传递整个对象。

int low = daysTempRange().getLow();
int high = daysTempRange().getHigh();
withinPlan = plan.withinRange(low, high);
withinPlan = plan.withinRange(daysTempRange());

8、以函数取代参数 Replace Parameter with Methods

对象调用某个函数,并将所得结果作为参数,传递给另一个函数。而接受该参数的函数本身也能够调用前一个函数。

让参数接收者去除该项参数,而是直接调用前一个函数。

int basePrice = _quantity * _itemPrice;
discountLevel = getDiscountLevel();
double finalPrice = discountedPrice (basePrice, discountLevel);
int basePrice = _quantity * _itemPrice;
double finalPrice = discountedPrice (basePrice);

9、引入参数对象 Introduce Parameter Object

某些参数总是很自然地同时出现,这些参数就是 Data Clumps。

以一个对象取代这些参数。

10、移除设值函数 Remove Setting Method

类中的某个字段应该在对象创建时被设值,然后就不再改变。

去掉该字段的所有设值函数,并将该字段设为 final。

11、隐藏函数 Hide Method

有一个函数,从来没有被其他任何类用到。

将这个函数修改为 private。

12、以工厂函数取代构造函数 Replace Constructor with Factory Method

希望在创建对象时不仅仅是做简单的建构动作。

将构造函数替换为工厂函数。

工厂模式可以参考这篇文章:JAVA设计模式第二讲:创建型设计模式

  • 第8.2节

13、封装向下转型 Encapsulate Downcast

某个函数返回的对象,需要由函数调用者执行向下转型(downcast)。

将向下转型动作移到函数中。

Object lastReading() {
    return readings.lastElement();
}
Reading lastReading() {
    return (Reading)readings.lastElement();
}

14、以异常取代错误码 Replace Error Code with Exception

某个函数返回一个特定的代码,用以表示某种错误情况。

改用异常,异常将普通程序和错误处理分开,使代码更容易理解。

15、以测试取代异常 Replace Exception with Test

面对一个调用者可以预先检查的条件,你抛出了一个异常。

修改调用者,使它在调用函数之前先做检查。

double getValueForPeriod(int periodNumber) {
    try {
        return values[periodNumber];
    } catch (ArrayIndexOutOfBoundsException e) {
        return 0;
    }
}
double getValueForPeriod(int periodNumber) {
    if (periodNumber >= values.length) return 0;
    return values[periodNumber];

十、处理概括关系

1、字段上移 Pull Up Field

两个子类拥有相同的字段。

将该字段移至父类。

2、函数上移 Pull Up Method

有些函数,在各个子类中产生完全相同的结果。

将该函数移至父类。

3、构造函数本体上移 Pull Up Constructor Body

你在各个子类中拥有一些构造函数,它们的本体几乎完全一致。

在父类中新建一个构造函数,并在子类构造函数中调用它。

class Manager extends Employee...
public Manager(String name, String id, int grade) {
    this.name = name;
    this.id = id;
    this.grade = grade;
}
public Manager(String name, String id, int grade) {
    super(name, id);
    this.grade = grade;
}

4、函数下移 Push Down Method

父类中的某个函数只与部分子类有关。将这个函数移到相关的那些子类去。

5、字段下移 Push Down Field

父类中的某个字段只被部分子类用到。将这个字段移到需要它的那些子类去。

6、提炼子类 Extract Subclass

类中的某些特性只被某些实例用到。

新建一个子类,将上面所说的那一部分特性移到子类中。

7、提炼父类 Extract Superclass

两个类有相似特性。

为这两个类建立一个父类,将相同特性移至父类。

8、提炼接口 Extract Interface

若干客户使用类接口中的同一子集,或者两个类的接口有部分相同。

将相同的子集提炼到一个独立接口中。

9、折叠继承体系 Collapse Hierarchy

父类和子类之间无太大区别。

将它们合为一体。

10、塑造模板函数 Form Template Method

你有一些子类,其中相应的某些函数以相同顺序执行类似的操作,但各个操作的细节上有所不同。

将这些操作分别放进独立函数中,并保持它们都有相同的签名,于是原函数也就变得相同了。然后将原函数上移至父类。(模板方法模式)

模版方法模式见这篇文章:JAVA设计模式第四讲:行为型设计模式

  • 见第10.2

11、以委托取代继承 Replace Inheritance with Delegation

某个子类只使用父类接口中的一部分,或是根本不需要继承而来的数据。

在子类中新建一个字段用以保存父类,调整子类函数,令它改而委托父类,然后去掉两者之间的继承关系。

12、以继承取代委托 Replace Delegation with Inheritance

你在两个类之间使用委托关系,并经常为整个接口编写许多极简单的委托函数。

让委托类继承受托类。

重构练习

参考资料

  • Martin Fowler, 福勒, 贝克, 等. 重构: 改善既有代码的设计 [M]. 电子工业出版社, 2011.
相关文章
|
5天前
|
设计模式 前端开发 API
写出易维护的代码|React开发的设计模式及原则
本文对React社区里出现过的一些设计模式进行了介绍,并讲解了他们遵循的设计原则。
|
17天前
|
设计模式 存储 Java
C++从入门到精通:3.5设计模式——提升代码可维护性与可扩展性的关键
C++从入门到精通:3.5设计模式——提升代码可维护性与可扩展性的关键
|
1月前
|
设计模式 算法 Java
23种设计模式,访问者模式的概念优缺点以及JAVA代码举例
【4月更文挑战第10天】访问者模式是一种将算法与对象结构分离的设计模式。这种模式主要用于执行一个操作(或一组操作)在一个对象结构的各元素上,它可以在不修改各元素的类的前提下定义新的操作。
19 2
|
1月前
|
设计模式 算法 Java
23种设计模式,模板方法模式的概念优缺点以及JAVA代码举例
【4月更文挑战第10天】模板方法模式是一种行为设计模式,它定义了一个操作中的算法的骨架,而将一些步骤延迟到子类中。模板方法使得子类可以在不改变算法结构的情况下,重新定义算法中的某些特定步骤。
20 0
|
1月前
|
设计模式 算法 搜索推荐
23种设计模式,策略模式的概念优缺点以及JAVA代码举例
【4月更文挑战第10天】设计模式是软件工程中的一种最佳实践指导,用于解决常见的设计问题。它们被分类为创建型、结构型和行为型模式。其中,策略模式是一种行为型设计模式,旨在定义一系列算法,封装每一个算法,并使它们可互换。策略模式允许算法独立于使用它们的客户端变化
22 1
|
1月前
|
设计模式 Java
23种设计模式,状态模式的概念优缺点以及JAVA代码举例
【4月更文挑战第9天】状态模式是一种行为设计模式,允许一个对象在其内部状态改变时改变它的行为,这个对象看起来似乎修改了它的类。
29 4
|
1月前
|
设计模式 Java
23种设计模式,观察者模式的概念优缺点以及JAVA代码举例
【4月更文挑战第9天】观察者模式是一种行为设计模式,它定义了对象之间的一对多依赖关系,使得当一个对象改变状态时,所有依赖于它的对象都会得到通知并自动更新。
24 2
|
1月前
|
设计模式 SQL 算法
设计模式了解哪些,模版模式
设计模式了解哪些,模版模式
22 0
|
2月前
|
设计模式 Java uml
C++设计模式之 依赖注入模式探索
C++设计模式之 依赖注入模式探索
54 0
|
29天前
|
设计模式 Java 数据库
小谈设计模式(2)—简单工厂模式
小谈设计模式(2)—简单工厂模式