副标题#e#
本文用eclipse的自动重组成果对一个措施实例举办重构,目标是摸索Eclipse自动重构可以在多洪流平上帮助重构这个进程。措施实例利用《Refactoring:Improving the Design of Existing Code》一书中的例子。
Eclipse的自动重组成果可以或许很好地支持各类措施元素的重定名,并自动更新相关的引用。Eclipse可以或许支持要领、字段在类之间移动,并自动更新引用。Eclipse较好地支持内联字段、函数的更新替换。Eclipse较好地支持抽取要领、变量等措施元素。
重构的进程是一个不绝实验和摸索的进程。Eclipse的重构支持取消和重做,而且可以或许预览重构功效,这些是很实用的成果。
Eclipse的重定名、抽取要领、移动、内联成果、变动要领特征符等代码布局级此外重构要领,是较量成熟同时也值得利用的成果。至于设计布局上的重构,eclipse还不能很好地支持。可是作者相信,自动重构的理念应该是"东西帮助下的重构事情",人仍然包袱大部门重构事情。
一、预备事情
本文利用《Refactoring:Improving the Design of Existing Code》一书第一章的例子。重构前的代码及每一步重构后的代码见附件。读者最好共同《Refactoring:Improving the Design of Existing Code》一书阅读本文。
Eclipse利用如下版本:
同时安装了中文语言包。
二、重构第一步:解析并重组statement()
目标:
1、把statement()函数中的swich语句提炼到独立的函数amountFor()中。
2、修改amountFor()参数定名
重构要领:
Extract Method
Rename Method
要领:
1、选中swich语句的代码块,在右键菜单中选择"重构/抽取要领",呈现参数对话框。Eclipse自动阐明代码块中的局部变量,找到了两个局部变量:each和thisAmount。个中,each只是在代码块中被读取,但thisAmount会在代码块中被修改。凭据重构Extract Method总结出来的法则,应该把each看成抽取函数的参数、thisAmount看成抽取函数的返回值。然而Eclipse并不做区分,直接把这两个变量看成抽取新要领的参数,如图。
我们的目标是把在抽取函数中不会被修改的each作为参数;会被修改的thisAmount作为返回值。办理的步伐是,把 double thisAmount = 0; 这行代码移到switch语句的上面,酿成这样:
double thisAmount = 0;
switch(each.getMovie().getPriceCode()){
case Movie.REGULAR:
thisAmount += 2;
if(each.getDaysRented()>2)
thisAmount += (each.getDaysRented()-2)*1.5;
break;
case Movie.NEW_RELEASE:
thisAmount += each.getDaysRented()*3;
break;
case Movie.CHILDRENS:
thisAmount += 1.5;
if(each.getDaysRented()>3)
thisAmount += (each.getDaysRented()-3)*1.5;
break;
}
选中这段代码,在右键菜单中选择"重构/抽取要领",eclipse这次变得智慧点了,如图。
#p#副标题#e#
选择"预览"按钮预先查察重构后的功效,切合我们最初的目标。
选择"确定"按钮,重构后的代码片段如下:
public String statement() { double totalAmount = 0; int frequentRenterPoints = 0; Enumeration rentals = _rentals.elements(); String result = "Rental Record for " + getName() + "\n"; while(rentals.hasMoreElements()){ Rental each = (Rental)rentals.nextElement(); double thisAmount = amountFor(each); frequentRenterPoints ++; if((each.getMovie().getPriceCode())==Movie.NEW_RELEASE &&each.getDaysRented()>1) frequentRenterPoints ++; result += "\t" + each.getMovie().getTitle() + "\t" +String.valueOf(thisAmount) + "\n"; totalAmount += thisAmount; } result += "Amount owed is " + String.valueOf(totalAmount) + "\n"; result += "You earned " + String.valueOf(frequentRenterPoints) + " frequent renter points"; return result; } /** * @param each * @return */ private double amountFor(Rental each) { double thisAmount = 0; switch(each.getMovie().getPriceCode()){ case Movie.REGULAR: thisAmount += 2; if(each.getDaysRented()>2) thisAmount += (each.getDaysRented()-2)*1.5; break; case Movie.NEW_RELEASE: thisAmount += each.getDaysRented()*3; break; case Movie.CHILDRENS: thisAmount += 1.5; if(each.getDaysRented()>3) thisAmount += (each.getDaysRented()-3)*1.5; break; } return thisAmount; }
#p#分页标题#e#
2、选中amountFor()的参数each,在右键菜单中选择"重构/重定名",在对话框中输入新的名称:aRental,选择确定,amountFor()中所有each的引用全部被替换成新的名称。用同样的步伐修改amountFor()中的局部变量thisAmount为result。重构后的amountFor()代码如下:
/**
* @param aRental
* @return
*/
private double amountFor(Rental aRental) {
double result = 0;
switch(aRental.getMovie().getPriceCode()){
case Movie.REGULAR:
result += 2;
if(aRental.getDaysRented()>2)
result += (aRental.getDaysRented()-2)*1.5;
break;
case Movie.NEW_RELEASE:
result += aRental.getDaysRented()*3;
break;
case Movie.CHILDRENS:
result += 1.5;
if(aRental.getDaysRented()>3)
result += (aRental.getDaysRented()-3)*1.5;
break;
}
return result;
}
三、重构第二步:搬移"金额计较"代码
目标:
1、将函数amountFor()转移到Rental类中,并改名为getCharge()。
2、更新并替换所有对amountFor()的引用。
重构要领:
Move Method
Change Method signatrue
Inline Method
Inline Temp
要领:
1、选中函数amountFor()的界说,在右键菜单中选择"重构/移动",显示参数配置对话框。把新要领名改成getCharge。按下"确定"按钮,Customer Class中的amountFor()函数被移动到Rental Class中,并改名为:getCharge()。
同时eclipse自动在Customer的amountFor()函数中添加一行对新函数的"委托"代码:
private double amountFor(Rental aRental) {
return aRental.getCharge();
}
这行代码会发生编译错误,原因是amountFor()的private型被通报到了新的要领中:
/**
* @param this
* @return
*/
private double getCharge() {
……
}
2、继承重构!选中getCharge()要领,在右键菜单中选择"重构/变动要领特征符",弹出参数选择对话框,把会见修饰符从private改成public。Eclipse的编译错误提示自动消失。
3、回到Customer类,把所有对amountFor()引用的处所替换成直接对getCharge()的引用。选中Customer类的函数amountFor(Rental aRental),在右键菜单中选择"重构/内联",呈现参数选择对话框。
选择"确认"按钮,引用amountFor()的处所被替换成对getCharge()的引用。
public String statement() {
……
double thisAmount = each.getCharge();
……
}
4、撤除姑且变量thisAmount。
选中变量thisAmount,在右键菜单中选择"重构/内联",重构预览窗口如下,可见到达了重构的目标。按下"确认"按钮重构代码。
statement()代码:
public String statement() { double totalAmount = 0; // 总消费金额 int frequentRenterPoints = 0; // 常客积点 Enumeration rentals = _rentals.elements(); String result = "Rental Record for " + getName() + "\n"; while(rentals.hasMoreElements()){ Rental each = (Rental)rentals.nextElement(); //取得一笔租借记录 // add frequent renter points(累加 常客积点) frequentRenterPoints ++; // add bouns for a two day new release rental if((each.getMovie().getPriceCode())==Movie.NEW_RELEASE && each.getDaysRented()>1) frequentRenterPoints ++; // show figures for this rental(显示此笔租借数据) result += "\t" + each.getMovie().getTitle() + "\t" + String.valueOf(each.getCharge()) + "\n"; totalAmount += each.getCharge(); } // add footer lines(末了打印) result += "Amount owed is " + String.valueOf(totalAmount) + "\n"; result += "You earned " + String.valueOf(frequentRenterPoints) + " frequent renter points"; return result; }
四、重构第三步:提炼"常客积点计较"代码
目标:提取"常客积点计较"代码并放在Rental类中,"常客积点计较"代码如下。
#p#分页标题#e#
public String statement() {
……
// add frequent renter points
frequentRenterPoints ++;
// add bouns for a two day new release rental
if((each.getMovie().getPriceCode())==Movie.NEW_RELEASE && each.getDaysRented()>1)
frequentRenterPoints ++;
……
}
重构后的代码如下:
frequentRenterPoints += each.getFrequentRenterPoints();
重构要领:
Extract Method
Move Method
Change Method signatrue
Inline Method
要领:
1、首先,抽代替码到独立的函数中。
用"抽取要领"重构代码,函数名:getFrequentRenterPoints。很遗憾,eclipse的不能生成诸如:frequentRenterPoints += getFrequentRenterPoints(Rental aRental); 的代码。原因是执行自增操纵的局部变量frequentRenterPoints要呈此刻等式右边,因此抽取函数getFrequentRenterPoints()必然要把frequentRenterPoints作为参数。手工修改函数和对函数的引用,重构后的代码如下:
public String statement() {
……
while(rentals.hasMoreElements()){
……
frequentRenterPoints += getFrequentRenterPoints(each);
……
}
……
}
/**
* @param each
* @return
*/
private int getFrequentRenterPoints(Rental each) {
if((each.getMovie().getPriceCode())==Movie.NEW_RELEASE && each.getDaysRented()>1)
return 2;
else
return 1;
}
2、把getFrequentRenterPoints()移动到Rental类中。
3、对getFrequentRenterPoints()"变动要领特征符"为public。
4、对Customer的函数getFrequentRenterPoints()执行内联操纵,重构方针完成。
五、重构第四步:去除姑且变量(totalAmount和frequentRenterPoints)
目标:去除姑且变量(totalAmount和frequentRenterPoints)
要领:
1、阐明totalAmount和frequentRenterPoints的界说和引用布局如下:
// 声明和界说
double totalAmount = 0;
int frequentRenterPoints = 0;
……
// 在轮回中修改
while(rentals.hasMoreElements()){
……
frequentRenterPoints += each.getFrequentRenterPoints();
……
totalAmount += each.getCharge();
……
}
……
// 在轮回外利用
result += "Amount owed is " + String.valueOf(totalAmount) + "\n";
result += "You earned " + String.valueOf(frequentRenterPoints) + " frequent renter points";
……
上述两个变量在轮回体外面界说和利用,在轮回中被修改,运用Replace Temp with Query要领去除这两个姑且变量是一项稍微巨大的重构。很遗憾,eclipse今朝不支持这样的重构。
2、手工修改代码。
六、重构第五步:运用多态代替与价值相关的条件逻辑
目标:
1、把Rental类中的函数getCharge()移动到Movie类中。
2、把Rental类中的函数getFrequentRenterPoints()移动到Movie类中。
重构要领:
Move Method
Inline Method
要领:
1、选中Rental类中的函数getCharge(),右键菜单选中"重构/移动",eclipse提示找不到吸收者,不能移动。原因在于这行语句:
switch(getMovie().getPriceCode()){//取得影片出租价值
选中getMovie(),右键菜单选中"重构/内联",确定儿女码成为:
switch(_movie.getPriceCode()){ //取得影片出租价值
选中getCharge(),执行"重构/移动"后,函数被移动到Movie类中。然而这只是部门告竣了重构目标,我们发明,移动后的代码把Rental作为参数传给了getCharge(),手工修改一下,代码酿成:
class Movie ……
/**
* @param this
* @return
*/
public double getCharge(int _daysRented) {
double result = 0;
switch(getPriceCode()){ //取得影片出租价值
case Movie.REGULAR: // 普通片
result += 2;
if(_daysRented>2)
result += (_daysRented-2)*1.5;
break;
case Movie.NEW_RELEASE: // 新片
result += _daysRented*3;
break;
case Movie.CHILDRENS: // 儿童片
result += 1.5;
if(_daysRented>3)
result += (_daysRented-3)*1.5;
break;
}
return result;
}
class Rental……
/**
* @param this
* @return
*/
public double getCharge() {
return _movie.getCharge(_daysRented);
}
2、用同样的步调处理惩罚getFrequentRenterPoints(),重构后的代码:
#p#分页标题#e#
class Movie ……
/**
* @param frequentRenterPoints
* @param this
* @return
*/
public int getFrequentRenterPoints(int daysRented) {
if((getPriceCode())==Movie.NEW_RELEASE && daysRented>1)
return 2;
else
return 1;
}
class Rental……
/**
* @param frequentRenterPoints
* @param this
* @return
*/
public int getFrequentRenterPoints(int daysRented) {
if((getPriceCode())==Movie.NEW_RELEASE && daysRented>1)
return 2;
else
return 1;
}
七、重构第六步:终于……我们来到担任
目标:对switch语句引入state模式。
要领:
很遗憾,不得不在这里提前竣事eclipse的自动重构之旅。Eclipse险些不能做布局上的重构。也许Martin Fowler在书中呼喊的自动重构东西止于"东西帮助下的重构事情"这一理念。艺术是人类的专利,编程艺术的空想将一连下去。
感乐趣的读者可以查察手工重构的最后一步代码。将重构举办到底!
附录:eclipse支持的重构要领(摘自eclipse中文辅佐)
名称 | 成果 |
取消 | 执行上一次重构的"取消"。只要除了重构之外尚未执行任何其它源变动,重构取消缓冲区就有效。 |
重做 | 执行上一次取消重构的"重做"。只要除了重构之外尚未执行任何其它源变动,重构取消/重做缓冲区就有效。 |
重定名 | 启动"重定名"重构对话框:重定名所选择的元素,并矫正对元素的所有引用(假如启用了的话)(还在其它文件中)。可用于:要领、字段、局部变量、要领参数、范例、编译单位、包、源文件夹和项目,以及理会为这些元素范例中的个中一种的文本选择部门。 |
移动 | 启动"移动"重构对话框:移动所选择的元素,并矫正对元素的所有引用(假如启用了的话)(还在其它文件中)。合用于:一个实例要领(可以将它移至某个组件)、一个或多个静态要领、静态字段、范例、编译单位、包、源文件夹和项目,以及理会为这些元素范例中的个中一种的文本选择部门。 |
变动要领特征符 | 启动"变动要领特征符"重构对话框。变动参数名称、参数范例和参数顺序,并更新对相应要领的所有引用。另外,可以撤除或添加参数,而且可以变动要领返回范例和它的可视性。可以将此重构应用于要领或理会为要领的文本选择。 |
将匿名类转换为嵌套类 | 启动"将匿名类转换为嵌套类"重构对话框。辅佐您将匿名内部类转换为成员类。可以将此重构应用于匿名内部类。 |
将嵌套范例转换成顶层 | 启动"将嵌套范例转换为顶层范例"重构对话框。为所选成员范例建设新的 Java 编译单位,并按照需要更新所有引用。对付非静态成员范例,将添加字段以答允会见先前的外围实例。可以将此重构应用于成员范例或理会为成员范例的文本。 |
下推 | 启动"下推"重构对话框。将一组要领和字段从一个类移至它的子类。可以将此重构应用于在同一个范例中声明的一个或多个要领和字段可能字段或要领内的文本选择。 |
上拉 | 启动"上拉"重构型中声明的一个或多个要领、字段和成员范例,也可以应用于字段、要领或成员范例内的文本选择。领导。将字段或要领移至其声明类的超类可能(对付要领)将要领声明为超类中的抽象类。可以将此重构应用于在同一个类 |
抽取接口 | 启动"抽取接口"重构对话框。利用一组要领建设新接口并使选择的类实现该接口,并尽大概地将对该类的引用变动为对新接口的引用(可选)。可以将此重构应用于范例。 |
尽大概利用超范例 | 启动"尽大概利用超范例"对话框。将某个范例的呈现替换为它的个中一个超范例,在执行此替换之前,需要标识所有有大概举办此替换的位置。此重构可用于范例。 |
内联 | 启动"内联"重构对话框。内联局部变量、要领或常量。此重构可用于要领、静态终态字段息争析为要领、静态终态字段或局部变量的文本选择。 |
抽取要领 | 启动"抽取要领"重构对话框。建设一个包括当前所选择的语句或表达式的新要领,并将选择替换为对新要领的引用。可以利用编辑菜单中的扩大选择至以获取有效的选择范畴。此成果对付清理冗长、混乱或过于巨大的要领是很有用的。 |
抽取局部变量 | 启动"抽取变量"重构对话框。建设为当前所选择的表达式指定的新变量,并将选择替换为对新变量的引用。此重构可用于理会为局部变量的文本选择。可以利用编辑菜单中的扩大选择至以获取有效的选择范畴。 |
抽取常量 | 启动"抽取常量"重构对话框。从所选表达式建设静态终态字段并替换字段引用,而且可以选择重写同一表达式的其它呈现位置。此重构可用于静态终态字段息争析为静态终态字段的文本选择。 |
将局部变量转换为字段 | 启动"将局部变量转换为字段"重构对话框。将局部变量转换为字段。假如该变量是在建设时初始化的,则此操纵将把初始化移至新字段的声明或类的结构函数。此重构可用于理会为局部变量的文本选择。 |
封装字段 | 启动"自封装字段"重构对话框。将对字段的所有引用替换为 getting 和 setting 要领。它合用于所选择的字段或理会为字段的文本选择。 |