概念
对软件内部结构的一种调整,目的是在不改变软件可观察的性外的前提下,提高其可理解性,降低其修改成本。
代码的坏味道
- 重复代码
- 过长函数
-
- 分解为小函数,并赋予它一个好名字
- 过大的类
- 过长的参数列
- 发散式变化
-
- 一个类受多种变化的影响
- 霰弹式修改
-
- 一种变化引发多个类相应修改
- 依恋情结
-
- 某个函数为了计算某个值,从另一个对象那儿调用很多的取值函数
- 数据泥团
-
- 两个类中相同的字段、许多函数签名中相同的参数,总是绑在一起出现的数据应该拥有属于它们自己的对象
- 基本类型偏执
-
- 启用小型类, 如由一个起始值和一个结束值组成的range类
- switch惊悚现身
-
- 少用switch(或case)语句
- 平行继承体系
- 冗赘类
- 夸夸其谈未来性
- 令人迷惑的暂时字段
-
- 对象内某个实例变量仅为某种特定情况而设
- 过度耦合的消息链
-
- 用户向一个对象请求另一个对象,然后再向后者请求另一个对象,然后再请求另一个对象
- 中间人
-
- 某个类接口有一半的函数都委托给其他类,就是过渡运用委托
- 狎昵关系
-
- 两个类之间的关系过于亲密
- 异曲同工的类
- 不完美的库类
- Data Class
-
- 拥有一些字段,以及用于访问(读写)这些字段的函数,除此之外一无长处
- 被拒绝的遗赠
-
- 子类应该继承超类的函数和数据,但子类不想或不需要继承
- 过多的注释
测试体系
JUnit测试体系,在重构中很重要,但针对spring mvc框架,我只测通了对service层的单元测试,对controller层的测试跑不通
重新组织函数
Extract Method(提炼函数)
有一段代码可以被阻止在一起并独立出来,可将这段代码放进一个独立函数,并让函数名称解释该函数的用途。这样可以把长函数剖析成一个个的小函数,更符合面向对象的思想,也便于阅读和理解。
- 无局部变量
- - 简单提炼
- 有局部变量
- - 传参
- 对局部变量再赋值
- - return 局部变量
Inline Method(内联函数)
一个函数的本体和名称同样清楚易懂,就在函数调用点插入函数本体,然后移除该函数,这个与提炼函数相对,是把函数分得太细了导致单独的函数没有意义。
Inline Temp(内联临时变量)
有一个临时变量,只被一个简单表达式赋值一次,而它妨碍了其他重构手法,就应该将所有对该变量的引用动作,替换为对它复制的那个表达式自身。
Replace Temp with Query(以查询取代临时变量)
以一个临时变量保存某一表达式的运算结果,将这个表达式提炼到一个独立的函数中,将这个临时变量的所有引用点替换为对新函数的调用,此后,新函数就可悲其他函数使用。
// 原
double basePrice = this.quantity * this.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 this.quantity * this.itemPrice;
}
这样重构的好处在于:临时变量有它自己的问题 – 它们是暂时的,而且只能在所属函数内使用,所以会驱使你写出更长的函数,因为只有这样你才能访问到临时变量,或者需要用参数传递,感觉这个需要权衡,像上面的范例,这么短,如果没有其他地方需要basePrice这玩意儿,就觉得有点多余。
Introduce Explaining Variable(引入解释性变量)
有一个复杂的表达式,将该复杂表达式(或其中的一部分)的结果放进一个临时变量,以此变量名称来解释表达式用途,感觉有些很复杂的判断句里是挺有必要的,一团的判断放在那儿,很容易看不懂。
// 原
if (platform.toUpperCase().indexOf("MAC")>-1) &&
(browser.toUpperCase().indexOf("IE")>-1) &&
resize >0 ) {
// do something
}
// 重构后
final boolean isMacOs = platform.toUpperCase().indexOf("MAC")>-1;
final boolean isIEBrowser = browser.toUpperCase().indexOf("IE")>-1;
final boolean wasResized = resize> 0;
if (isMacOs && isIEBrowser && wasResized) {
// do something
}
Split Temporary Variable(分解临时变量)
程序有某个临时变量被赋值超过一次,它既不是循环变量,也不被用于收集计算结果,那就针对每次赋值,创造一个独立、对应的临时变量,不要代表a也用temp,代码走到后面代表b了还是用temp,只是给它再赋值,这样容易看不清楚代码的含义。
Remove Assignments to Parameters(移除对参数的赋值)
代码对一个参数进行赋值,就用一个临时变量取代该参数的位置,这个问题我好像一直都有,看着参数顺眼就直接拿过来用了,而不是重新用一个临时变量来存储结果。
// 原
int discount(int inputVal, int quantity, int yearToDate) {
if (inputVal > 50) inputValue -= 2;
}
// 重构后
int discount(int inputVal, int quantity, int yearToDate) {
int result = inputVal;
if (inputVal > 50) result -= 2;
}
这种情况需要重构的原因在于:因为它降低了代码的清晰度,而且混用了按值传递和按引用传递这两种参数传递方式。
- ++划重点:Java 的按值传递++
public class test {
public static void main(String[] args) {
int x = 5;
triple(x);
System.out.println("x after triple: " + x);
}
public static void triple(int arg) {
arg = arg * 3;
System.out.println("arg in triple: " + arg);
}
}
/*******结果********/
// 调用函数后参数没有变化
arg in triple: 15
x after triple: 5
/*******************/
public class test {
public static void main(String[] args) {
Date d1 = new Date();
nextDateUpdate(d1);
System.out.println("d1 after nextDay: " + d1);
Date d2 = new Date();
nextDateReplace(d2);
System.out.println("d2 after nextDay: " + d2);
}
public static void nextDateUpdate(Date arg) {
arg.setDate(arg.getDate() + 1); // 改变了参数值
System.out.println("arg in nextDay: " + arg);
}
public static void nextDateReplace(Date arg) {
arg = new Date(arg.getYear(), arg.getMonth(), arg.getDate() + 1);
System.out.println("arg in nextDay: " + arg);
}
}
/********结果*******/
arg in nextDay: Tue Jun 06 17:36:37 CST 2017
d1 after nextDay: Tue Jun 06 17:36:37 CST 2017 // 值变化了
arg in nextDay: Tue Jun 06 00:00:00 CST 2017
d2 after nextDay: Mon Jun 05 17:36:37 CST 2017
/*******************/
Replace Method with Method Object(以函数对象取代函数)
如果有一个大型函数,其中对局部变量的使用导致无法采用Extract Method,可以将这个函数放进一个单独对象中,如此一来局部变量就成了对象内的字段,然后就可以在同一个对象中将这个大型函数分解为多个小型函数。这样临时变量就变成了新建对象的成员变量,在提炼函数的时候可以不用顾及到这些临时变量,方便分解。
Substitue Algorithm(替换算法)
想要把某个算法替换为另一个更清晰的算法,将函数本体替换为另一个算法。
在对象之间搬移特性
Move Method(搬移函数)
程序中,有一个函数与其所驻类之外的另一个类进行更多交流:调用后者,或者被后者调用。那就在该函数最常引用的类中建立一个有着类似行为的新函数,将旧函数变成一个单纯的委托函数,或是将旧函数完全移除。
“搬移函数”是重构理论的支柱,如果一个类有太多行为,或如果一个类与另一个有太多合作而形成高度耦合,就应该搬移函数。
Move Field(搬移字段)
程序中某个字段被其所驻类之外的另一个类更多地用到,就应该在目标类新建一个字段,修改源字段的所有用户,令它们改用新字段。(如果需要搬移字段又需要搬移函数,就先搬移字段,再搬移函数)
Extract Class(提炼类)
某个类做了应该由两个类做的事,就建立一个新类,将相关的字段和函数从旧类搬移到新类。
Inline Class(将类内联化)
某个类没有做太多事情,就将这个累的所有特性搬移到另一个类中,然后移除原类,和Extract Class正好相反,这种情况发生在一个类不再承担足够责任,不再有单独存在的理由(这通常是因为此前的重构动作移走了这个类的责任)。
Hide Delegate(隐藏“委托关系”)
客户通过一个委托类来调用另一个对象,可以在服务类上建立客户所需的所有函数,用以隐藏委托关系。
public class Person {
private Department department;
// 不需要通过获取Department来获取manager
public Person getManager() {
return this.department.getManager();
}
public Department getDepartment() {
return department;
}
public void setDepartment(Department department) {
this.department = department;
}
}
class Department {
private String chargeCode;
private Person manager;
public String getChargeCode() {
return chargeCode;
}
public void setChargeCode(String chargeCode) {
this.chargeCode = chargeCode;
}
public Person getManager() {
return manager;
}
public void setManager(Person manager) {
this.manager = manager;
}
}
重构之前获取某人的Mannager,必须先取得Department对象,形如:manager = john.getDepartment().getManager(),重构后可以直接通过getManager()来获得。
Remove Middle Man(移除中间人)
某个类做了过多的简单委托动作,就让客户直接调用受托类,和Hide Delegate正好相反,因为“封装受托对象”(形如Hide Delegate)的代价是:每当客户要使用受托类的新特性时,就必须在服务端添加一个简单委托函数,随着受托类的特性(功能)越来越多,服务类就完全变成了一个“中间人”,这时候就应该让客户直接调用受托类,这两者之间的权衡重点在于受托类的特性是否很多,是否被很多次调用,需要判断。
Introduce Foreign Method(引入外加函数)
当需要为提供服务的类增加一个函数,但有无法修改这个类时,在客户类中建立一个函数,并以第一参数形式传入一个服务类的实例。其实就是新建一个满足自己需要的函数,在函数里面去调用已存在类函数。
// Date类中没有nextDay()函数 那就建一个
Date newStart = nextDay(previousEnd);
private static Date nextDay(Date arg) {
return new Date(arg.getYear(), arg.getMonth(), arg.getDate() + 1);
}
// 而不是直接 Date newStart = new Date(arg.getYear(), arg.getMonth(), arg.getDate() + 1);这样理解起来比较有障碍
备注:其实这里Date类中的getYear() getMonth()方法都过期了,现在都直接用日历类代替,这里只作为一个例子说明;另外,如果关于Date类需要添加挺多的自定义函数时,可以自定义一个类继承Date,在这个类中添加自定义函数。
Introduce Local Extension(引入本地扩展)
当需要为服务类提供一些额外函数,但又无法修改这个类时,可以建立一个新类,使它包含这些额外的函数,让这个扩展品成为源类的子类或包装类,上面已提到。
// 子类 很显而易见的用法
class DateSub extends Date {
public MfDateSub nextDay() {
// do something
}
}
// 包装类 需要用上委托
class DateWrap {
private Date original;
public DateWrap(String dateString) {
this.original = new Date(dateString);
}
// 为原始类的所有函数提供委托函数 如
public int getYear() {
return this.original.getYear();
}
}
包装类有个问题就是处理接受原始类实例为参数的函数,比如说after():
aWrapper.after(aDate) // 有效
aWrapper.after(anotherWrapper) // 有效
aDate.after(aWrapper) // 无效 因为aWrapper不是Date类型
所以感觉包装类这种方式有隐患而且写写也麻烦。
重新组织数据
Self Encapsulate Field(自封装字段)
直接访问一个字段,但与字段之间的耦合关系逐渐变得笨拙,可以为这个字段建立取值/设值函数,并且只以这些函数来访问字段。需要权衡。
Replace Data Value with Object(以对象取代数据值)
有一个数据项,需要与其他数据和行为一起使用才有意义,那就将数据项变成对象。比如一开始设计的时候Order类中有一个String类型的成员变量customer来表示客户,那时候只需要一个字段来标记客户名称,现在发现需要客户的更多资料,就可以建立一个客户类,用客户对象来取代之前的数据值,会更加清晰。
Change Value to Reference(将值对象改为引用对象)
从一个类衍生出许多彼此相等的实例,希望将它们替换为同一个对象,可以将这个值对象变成引用对象。
class Customer {
private final String name;
private static Map<String, Customer> instances = new Hashtable<>();
static void loadCustomers() {
new Customer("Lemon Car Hire").store();
new Customer("Associated Coffee Machines").store();
new Customer("Bilston Gasworks").store();
}
private void store() {
instances.putIfAbsent(this.getName(), this);
}
private static void storeWhenCreate(Customer customer) {
instances.put(customer.getName(), customer);
}
private Customer(String name) {
this.name = name;
}
public static Customer create(String name) {
Customer customer = instances.get(name);
if (null == customer) {
customer = new Customer(name);
storeWhenCreate(customer);
}
return customer;
}
public String getName() {
return name;
}
}
私有化构造函数,使用工厂函数create()代替,达到预期获取同一客户对象不会每次都新建对象的目的。
Change Reference to Value(将引用对象改为值对象)
有一个引用对象,很小且不可变,而且不易管理,就将它变成一个值对象。和上一种方式正好相反。值对象有一个非常重要的特性:它们应该是不可变的,无论何时,只要你调用同意对象的同一个查询函数,都应该得到同样结果。要把一个引用对象变成值对象,关键动作是检查它是否不可变,如果不是就不能进行本项重构,因为可变的值对象会造成烦人的别名问题。
// 保存并返回一个货币种类代码
public class Currency {
private String code;
private Currency(String code) {
this.code = code;
}
public static Currency get(String code) {
return new Currency(code);
}
public String getCode() {
return code;
}
}
// 引用对象 得到它的实例的方法
Currency usd = Currency.get("USD");
但是有个问题,Currency.get(“USD”).equals(Currency.get(“USD”)) // return false,在这里,Currency对象应该是不可变的,即不管在哪儿Currency.get(“USD”)应该都是对等的,所以需要为它定义equals()方法,并且同时必须定义hashCode()如下:
public boolean equals(Object arg) {
if (!(arg instanceof Currency)) return false;
Currency other = (Currency) arg;
return this.code.equals(other.code);
}
public int hashCode() {
return this.code.hashCode();
}
如此,Currency.get(“USD”).equals(Currency.get(“USD”))就为true了。还可以把构造函数声明为public,就可以以构造函数获取Currency实例。
++划重点++:
Change Value to Reference和Change Reference to Value感觉上的区别就是后者是当一个类要求每次获取都是对等的值,这个值是不可变的,USD代表美元,到哪儿都是美元,而前者是每次都要获得同一个容器,里面装着什么并无所谓,比如获取同一个客户,每次都是同一个用户这个容器,至于第一次取出来这个客户成交了10单,过一段时间取出来这个客户已经成交了11单了这个并没有关系,关心的是是这个客户就好。从这个概念上讲,这两个东西不是相反的过程,分明是两种不同的需求么。
Replace Array with Object(以对象取代数组)
有一个数组,其中的元素各自代表不同的东西,可以以对象替换数组,对于数组中的每个元素,以一个字段来表示。
Duplicate Observed Data(复制“被监视数据”)
有一些领域数据置身于GUI控件中,而领域函数需要访问这些数据,可以将该数据复制到一个领域对象中,建立一个Observer模式,用以同步领域对象和GUI对象内的重复数据。这个因为涉及到GUI没有仔细研究,基本思想就是分离展示和数据处理,类似MVC的思想,同时用到了观察者模式。
Change Unidirectional Association to Bidirectional(将单向关联改为双向关联)
两个类都需要使用对方的特性,但其间只有一条单向连接。可以添加一个反向指针,并使修改函数能够同时更新两条连接。就是比方说customer和order要双向关联,就需要在customer类中添加order类型的成员变量,并添加对order的修改函数,同时在order类中添加customer类型的成员变量,同样添加对customer的修改函数。其实和数据库的一对一、一对多、多对多的表关系可以类比。
Change Bidirectional Association to Unidirectional(将双向关联改为单向关联)
如果两个类有双向关联,但其中一个类如今不再需要另一个类的特性,就取出不必要的关联。双向关联很有用,但维护双向连接、确保对象被正确创建和删除增加了不少的复杂度。
Replace Magic Number with Symbolic Constant(以字面常量取代魔法数)
有一个字面数值,带有特别含义,就创造一个常量,根据其意义为它命名,并将上述的字面数值替换为这个常量。其实我们平常使用的状态码都是这么个意思。
// 原 9.81 意义不明
double potentialEnergy(double mass, double heigh) {
return mass * 9.81 * height;
}
// 重构后
double potentialEnergy(double mass, double height) {
return mass * GRAVITATIONAL_CONSTANT * height;
}
static final double GRAVITATIONAL_CONSTANT = 9.81;
Encapsulate Field(封装字段)
类中存在一个public字段,可以将它声明为private,并提供相应的访问函数。
Encapsulate Collection(封装集合)
有个函数返回一个集合,让这个函数返回该集合的一个只读副本,并在这个类中提供添加/移除集合元素的函数,这样可以保证在类的操纵范围内添加/移除元素,避免在类外修改了集合,其实类的成员变量并没有改变的情况。
public class Course {
public Course(String name, boolean isAdvanced) {
}
public boolean isAdvanced() {
return true;
}
}
class Person {
private Set<Course> courses = new HashSet<>();
public Set<Course> getCourses() {
return this.courses;
}
// 初始化集合
public void initializeCourses(Set<Course> courses) {
Assert.assertTrue(this.courses.isEmpty());
this.courses.addAll(courses);
}
// 添加集合元素
public void addCourse(Course course) {
this.courses.add(course);
}
// 移除集合元素
public void removeCourse(Course course) {
this.courses.remove(course);
}
int numberOfAdvancedCourses() {
Iterator iterator = getCourses().iterator();
int count = 0;
while (iterator.hasNext()) {
Course each = (Course) iterator.next();
if (each.isAdvanced())
count++;
}
return count;
}
int numberOfCourses() {
return this.courses.size();
}
}
class Test {
public static void main(String[] args) {
Person kent = new Person();
kent.addCourse(new Course("Smalltalk Programming", false));
kent.addCourse(new Course("Appreciating Single Malts", true));
Assert.assertEquals(2, kent.getCourses().size());
}
}
Replace Record with Data Class(以数据类取代记录)
在需要面对传统编程环境中的记录结构时,为该记录创建一个“哑”数据对象。就例如从数据库取出来的本来是个集合,但基本都会封装成对象。
备注:“哑”数据指的是还没有任何有用的行为的对象,但因为平常在用的mybatis hibernate 这种已经是很完善的框架了,一般都是先创建对象,数据库取出的时候直接返回的对象。
Replace Type Code with Class(以类取代类型码)
类中有一个数值类型码,但它并不影响类的行为,可以以一个新的类替换数值类型码。
public class Person {
private BloodGroup bloodGroup;
public Person(BloodGroup bloodGroup) {
this.bloodGroup = bloodGroup;
}
public BloodGroup getBloodGroup() {
return this.bloodGroup;
}
public void setBloodGroup(BloodGroup bloodGroup) {
this.bloodGroup = bloodGroup;
}
}
class BloodGroup {
public static final BloodGroup O = new BloodGroup(0);
public static final BloodGroup A = new BloodGroup(1);
public static final BloodGroup B = new BloodGroup(2);
public static final BloodGroup AB = new BloodGroup(3);
private static final BloodGroup[] values = {O, A, B, AB};
private final int code;
public BloodGroup(int code) {
this.code = code;
}
private int getCode() {
return this.code;
}
private static BloodGroup code(int index) {
return values[index];
}
}
class Test {
public static void main(String[] args) {
Person thePerson = new Person(BloodGroup.A);
}
}
实际应用过程中一般都是直接用常量的。
Replace Type Code with Subclasses(以子类取代类型码)
有一个不可变的类型码,它会影响类的行为,可以以子类取代这个类型码。比如说Employee类中有type,用来标记雇员是Engineer或者Salesman,不同类型的雇员薪资计算什么的都不一样,这种情况可以创建子类用来标记不同的雇员,而不是用类型字段来标记,在同一个函数中判断类型再进行不同的处理。
Replace Type Code with State/Strategy(以State/Strategy取代类型码)
有一个类型码,它会影响类的行为,但无法通过继承手法消除它(比如状态码可变)的情况下,可以以状态对象取代状态码。
public class Employee {
private EmployeeType type;
private int monthlySalary, commission, bonus;
public Employee(int type) {
this.type = EmployeeType.newType(type);
}
public int getType() {
return type.getTypeCode();
}
public void setType(int type) {
this.type = EmployeeType.newType(type);
}
int payAmount() {
switch(getType()) {
case EmployeeType.ENGINEER:
return this.monthlySalary;
case EmployeeType.SALESMAN:
return this.monthlySalary + this.commission;
case EmployeeType.MANAGER:
return this.monthlySalary + this.bonus;
default:
throw new RuntimeException("Incorrect Employee");
}
}
}
abstract class EmployeeType {
static final int ENGINEER = 0;
static final int SALESMAN = 1;
static final int MANAGER = 2;
abstract int getTypeCode();
static EmployeeType newType(int code) {
switch (code) {
case ENGINEER:
return new Engineer();
case SALESMAN:
return new Salesman();
case MANAGER:
return new Manager();
default:
throw new IllegalArgumentException("Incorrect Employee Code");
}
}
}
class Engineer extends EmployeeType {
int getTypeCode() {
return ENGINEER;
}
}
class Salesman extends EmployeeType {
@Override
int getTypeCode() {
return SALESMAN;
}
}
class Manager extends EmployeeType {
@Override
int getTypeCode() {
return MANAGER;
}
}
Replace Subclass with Fields(以字段取代子类)
如果各个子类的唯一差别只在“返回常量数据”的函数身上,那就修改这些函数,使它们返回超类中的某个(新增)字段,然后销毁子类。
// 原
abstract class Person {
abstract boolean isMale();
abstract char getCode();
}
// Female也类似 太浪费了 都没有逻辑只有返回
class Male extends Person {
boolean isMale() {
return true;
}
char getCode() {
return 'M';
}
}
// 重构后
class Person {
private final boolean isMale;
private final char code;
private Person(boolean isMale, char code) {
this.isMale = isMale;
this.code = code;
}
// 简洁清晰 Female也类似
public static Person createMale() {
return new Person(true, 'M');
}
}
简化条件表达式
Decompose Conditional(分解条件表达式)
有一个复杂的条件(if-then-else)语句,可以从if、then、else三个段落中分别提炼出独立函数。最大的好处就是适于阅读。
// 原
if (date.before(SUMMER_START) || date.after(SUMMER_END))
charge = quantity * this.winterRate + this.winterServiceCharge;
else
charge = quantity * this.summerRate;
// 重构后
if (notSummer(date))
charge = winterCharge(quantity);
else
charge = summerCharge(quantity);
private boolean notSummer(Date date) {
return date.before(SUMMER_START) || date.after(SUMMER_END);
}
private winterCharge(int quantity) {
return quantity * this.winterRate + this.winterServiceCharge;
}
private summerCharge(int quantity) {
return quantity * this.summerRate;
}
Consolidate Conditional Expression(合并条件表达式)
如果有一系列条件测试,都得到相同的结果,可以将这些测试合并为一个条件表达式,并将这个条件表达式提炼成为一个独立函数。
Consolidate Duplicate Conditional Fragments(合并重复的条件片段)
在条件表达式的每个分支上有着相同的一段代码,可以将这段重复代码搬移到条件表达式之外。
Remove Control Flag(移除控制标记)
在一系列布尔表达式中,某个变量带有“控制标记”(xxx=false/xxx=true来控制流程)的作用,可以以break语句或者return语句取代控制标记。
Replace Nested Conditional with Guard Clauses(以卫语句取代嵌套条件表达式)
函数中的条件逻辑使人难以看清正常的执行路径,可以使用卫语句表现所有特殊情况。
备注:卫语句就是把复杂的条件表达式拆分成多个条件表达式,比如一个很复杂的表达式,嵌套了好几层的if-then-else语句,转换为多个if语句,实现它的逻辑,这多条if语句就是卫语句。
// 原
double getPayAmount() {
double result;
if (isDead) {
result = deadAmount();
} else {
if (isSeparated) {
result = separtedAmount();
} 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();
}
Replace Conditional with Polymorphism(以多态取代条件表达式)
如果有个条件表达式,它根据对象类型的不同而选择不同的行为,可以将这个条件表达式的每个分支放进一个子类中的覆写函数中,然后将原始函数声明为抽象函数。
Introduce Null Object(引入Null对象)
如果你需要再三检查某对象是否为null,可以将null值替换为null对象。创建一个新的类,作为正常类的子类,用isNull()来标记是否为空对象,在子类中覆写在null情况下需要特殊处理的函数。广义上来说,就是一种特例类。感觉不仅仅是Null,其他特殊情况也可以用这种处理方式。
Introduce Assertion(引入断言)
某一段代码需要对程序状态做出某种假设,可以以断言明确表现这种假设。比如当某个条件为真时,该段代码才能正常运行,例如平方根计算只对正值才能进行。因为断言如果不符合就会报错,所以其实这里所谓的条件不是针对业务上的,而是程序上的,只是为了规范代码的逻辑。
简化函数调用
Rename Method(函数改名)
函数的名称未能揭示函数的用途时,就修改函数名称。
Add Parameter(添加参数)
某个函数需要从调用端得到更多信息时,为此函数添加一个对象参数,让该对象带进函数所需信息。
Remove Parameter(移除参数)
函数本体不再需要某个参数时,就将该参数去除。
Separate Query from Modifier(将查询函数和修改函数分离)
某个函数既返回对象状态值,又修改对象状态的情况下,可以建立两个不同的函数,其中一个负责查询,另一个负责修改。
任何有返回值的函数,都不应该有看得到的副作用。
Parameterize Mehod(令函数携带参数)
如果若干函数做了类似的工作,但在函数本体中却包含了不同的值,可以建立单一函数,以参数表达那些不同的值。
// 原
class Employee {
int fivePercentRaise() {
// do something
}
int tenPercentRaise() {
// do something
}
}
// 重构后
class Employee {
int raise(percentage) {
// do something
}
}
Replace Parameter with Explicit Methods(以明确函数取代参数)
如果有一个函数,其中完全取决于参数值而采取不同行为,可以针对每一个可能值,建立一个独立函数,和上面一种方法不一样的是,这里强调的是每一种参数值对应的行为都不一样,而上一个是处理方式差不多,所以可以直接用参数。
// 原
void setValue(String name, int value) {
if (name.equals("height")) {
this.height = value;
}
if (name.equals("width")) {
this.width = value;
}
Assert.shouldNeverReachHere();
}
// 重构后
void setHeight(int arg) {
this.height = arg;
}
void setWidth(int arg) {
this.width = arg;
}
Preserve Whole Object(保持对象完整)
如果从某个对象中取出若干值,将它们作为某一次函数调用时的参数,改为传递整个对象。这样下次修改如果需要新的数据项,可以直接调用这个对象中的对应成员变量。
Replace Parameter with Methods(以函数取代参数)
对象调用某个函数,并将所得结果作为参数,传递给另一个函数,而接受该参数的函数本身也能够调用前一个函数,可以让参数接受者去除该项参数,并直接调用前一个函数。
如果函数可以通过其他途径获得参数值,那就不应该通过参数取得该值,过长的参数列会增加程序阅读者的理解难度,因此我们应该尽可能缩短参数列的长度。
Introduce Parameter Object(引入参数对象)
某些参数总是很自然地同时出现,可以以一个对象取代这些参数。
public class Account {
double getFlowBetween(DateRange range) {
Vector<Entry> entries = new Vector<>();
double result = 0;
Enumeration e = entries.elements();
while (e.hasMoreElements()) {
Entry each = (Entry) e.nextElement();
if (range.includes(each.getChargetDate())) {
result += each.getValue();
}
}
return result;
}
}
class Entry {
private Date chargeDate;
private double value;
Entry(double value, Date chargeDate) {
this.chargeDate = chargeDate;
this.value = value;
}
Date getChargetDate() {
return this.chargeDate;
}
double getValue() {
return this.value;
}
}
// 参数对象
class DateRange {
private final Date start;
private final Date end;
DateRange(Date start, Date end) {
this.start = start;
this.end = end;
}
Date getStart() {
return start;
}
Date getEnd() {
return end;
}
boolean includes(Date arg) {
return arg.equals(this.start) || arg.equals(this.end) || (arg.after(this.start) && arg.before(this.end));
}
}
Remove Setting Method(移除设置函数)
类中的某个字段应该在对象创建时被设值,然后就不再改变,就应该去掉该字段的所有设值函数。
Hide Method(隐藏函数)
如果有一个函数,从来没有被其他任何类用到,应该将这个函数修改为private。
Replace Constructor with Factory Method(以工厂函数取代构造函数)
如果在创建对象时不仅仅是做简单的构建动作,可以将构造函数替换为工厂函数,这个我感觉第一可以用函数名表明函数的意义,第二单例的时候需要。
Encapsulate Downcast(封装向下转型)
某个函数返回的对象,需要由函数调用者执行向下转型,可以将向下转型动作移到函数中。
// 原
Object lastReading() {
return readings.lastElement();
}
// 重构后
Reading lastReading() {
return (Reading) readings.lastElement();
}
这样调用者拿到的返回值就是Reading类型的了,不用再额外做什么处理。
Replace Error Code with Exception(以异常取代错误码)
某个函数返回一个特定的代码,用以表示某种错误情况,可以改用异常。异常的方式更好,是因为它清除地将“普通程序”和“错误处理”分开了,这使得程序更容易理解。
++划重点++:
传说中的受控异常和非受控异常,受控异常需要在客户端显式捕捉处理或抛出异常,继承自java.lang.Exception,而非受控异常不需要在客户端显示捕捉处理或抛出,继承自RuntimeException,只在代码运行的时候抛出。
Replace Exception with Test(以测试取代异常)
面对一个调用者可以预先检查的条件,抛出了一个异常,这种情况下可以修改调用者,使它在调用函数之前先做检查。
// 原
double getValueForPeriod(int periodNumber) {
try {
return this.value[periodNumber];
} catch(ArrayIndexOutOfBoundsException e) {
return 0;
}
}
// 重构后
double getValueForPeriod(int periodNumber) {
if (periodNumber >= this.value.length) return 0;
return this.value[periodNumber];
}
处理概括关系(即继承关系)
Pull Up Field(字段上移)
两个子类拥有相同的字段,将该字段移至超类。本项重构从两方面减少了重复:首先它去除了重复的数据声明;其次它使你可以将使用该字段的行为从子类移至超类,从而去除重复的行为。
Pull Up Method(函数上移)
有些函数,在各个子类中产生完全相同的结果,可以将该函数移至超类。
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;
}
}
// 重构后
class Manager extends Employee {
public Manager(String name, String id, int grade) {
super(name, id);
this.grade = grade;
}
}
Push Down Method(函数下移)
如果超类中的某个函数只与部分(而非全部)子类有关,可以将这个函数移到相关的那些子类中去。
Push Down Field(字段下移)
如果超类中的某个字段只被部分(而非全部)子类用到,可以将这个字段移到需要它的那些子类中去。
Extract Subclass(提炼子类)
如果类中的某些特性只被某些(而非全部)实例用到,可以新建一个子类,将上面所说的那一部分特性移到子类中。
Extract Superclass(提炼超类)
如果两个类有相似特性,可以为这两个类建立一个超类,将相同特性移至超类。
Extract Interface(提炼接口)
若干客户试用类接口中的同一子集,或者两个类的接口有部分相同,可以将相同的子集提炼到一个独立接口中。
接口在代码中更重要的是责任划分的过程,主要是对代码进行一个管理感觉。
public class TimeSheet {
// 这里的emp是Billable 而不是Employee
// 强调该函数只使用Employee的这部分行为
double charge(Billable emp, int days) {
int base = emp.getRate() * days;
return emp.hasSpecialSkill() ? base * 1.05 : base;
}
}
class Employee implements Billable{
private int rate;
private boolean specialSkill;
public int getRate() {
return rate;
}
public boolean hasSpecialSkill() {
return specialSkill;
}
}
interface Billable {
public int getRate();
public boolean hasSpecialSkill();
}
++划重点++:
面向接口编程,运用多态的好处,重点在于用户类不必与具体的实现类直接依赖,而是依赖于抽象的接口。
Collapse Hierarchy(折叠继承体系)
如果超类和子类之间没有太大的区别,就将它们合为一体。
Form Template Method(塑造模板函数)
如果有一些子类,其中响应的某些函数以相同顺序执行类似的操作,但各个操作的细节上有所不同。可以将这些操作分别放进独立函数中,并保持它们都有相同的签名,于是原函数也就变得相同了,然后将原函数上移至超类。
也就是在遇到子类中的某些函数只有细微的不同,可以把不同的部分提炼出来在各自的类中处理,超类中定义为抽象函数,相同的部分提炼至超类。
Replace Inheritance with Delegation(以委托取代继承)
如果某个子类只使用超类接口中的一部分,或者根本不需要继承而来的数据,可以在子类中新建一个字段用以保存超类,调整子类函数,令它改而委托超类,然后去掉两者之间的继承关系。
++划重点++:
委托简单点理解就是A类中有一个B类类型的成员变量,然后可以使用B类的一些行为方法。
Replace Delegation with Inheritance(以继承取代委托)
如果在两个类之间使用委托关系,并经常为整个接口编写许多极简单的委托函数,就让委托类继承受托类。
有两种情况需要注意:1. 如果并没有使用受托类的所有函数,那么就不应该使用该重构方法;2. 受托对象被不止一个其他对象共享,而且受托对象是可变的,在这种情况下,就不能将委托关系替换为继承关系,因为这样就无法再共享数据了。
大型重构
Tease Apart Inheritance(梳理并分解继承体系)
某个继承体系同时承担两项责任时,应该建立两个继承体系,并通过委托关系让其中一个调用另一个。
Convert Procedural Design to Objects(将过程化设计转化为对象设计)
如果手上有一些传统过程化风格的代码,应该将数据记录变成对象,将大块行为分成小块,并将行为移入相关对象之中。
Separate Domain from Presentation(将领域和表述/显示分离)
某些GUI类之中包含了领域逻辑,可以将领域逻辑分离出来,为它们建立独立的领域类。
Extract Hierarchy(提炼继承体系)
如果某个类做了太多工作,其中一部分工作是以大量条件表达式完成的,可以建立继承体系,以一个子类表示一种特殊情况。