Eclipse 是一个开放源代码的、基于 Java 的可扩展开发平台。就其本身而言,它只是一个框架和一组服务(图1),用于通过插件组件构建开发环境。幸运的是,Eclipse 附带了一个标准的插件集,包括 Java 开发工具(Java Development Tools,JDT)。Eclipse Platform 为工具开发提供一组健壮的服务和 API。它使来自完全不同的供应商的工具之间的集成变得平滑,为不同类型的开发工作创建了一个无缝的环境。
图1:Eclipse框架
何谓重构?
重构――是指在不改变软件任何功能的前提下对代码进行修改,调整其结构,提高其可理解性,降低其修改的成本。
为什么重构?
重构的基本思想就是集中精力使设计简化,并且在新的需求出现时提供一个持续发展(而非扩展)的环境。重构是一项功能强大的技术,但需以微小的步伐修改程序才行。因为在重构时可能在你不经意之间引入了一些错误,尤其是我们在手工进行时更是如此。有这样的危险存在,那我们为什么要对现有运行良好的程序进行重构呢?
重构可以改进软件的设计;
重构可以使你的代码看起来更易理解;
重构可以找出潜伏的臭虫;
重构可以帮助你提高编程的速度――在一次次的迭代过程中阻止系统腐败变质,减少在调试中所花的时间;
重构这个工具有太多太多的好处,它可以使我们更快速的开发软件,甚至还可以提高我们的设计质量。
前面也提到过手工重构可能会引入一些错误,所以我们需要一个可以自动重构的工具――Eclipse。只要我们知道 Eclipse 实现了什么样的重构工具,并理解了它们的适用情况,我们的生产力就会得到极大的提高。当然要降低对代码造成破坏的风险,一套可靠的测试机制是必不可少的。一整组完全自动化的测试就是一个强大的臭虫侦测器,能够大大缩减查着臭虫所需要的时间。频繁的运行这个测试可以极大的减小错误产生的可能,所以在重构中测试也是非常重要的,Martin Fowler说:“没有测试就不要轻易地重构,那样会给你带来麻烦的”。同样Eclipse也集成了对JUnit的支持。
图2:Eclipse的Java工作台
本文所用到的重构手法简介:
手法一:Encapsulate Field (封装值域)――在类中存在一个public值域。将它声明为private,并提供响应的访问函数。
public String _name; |
private String _name; public String getName() {return _name;} public void setName(String arg) {_name = arg;} |
手法二:Pull Up Method (函数上移)――有些函数,在各个subClass中产生完全相同的结果。将该函数移至superClass。
手法三:Extract InterFace (提炼接口)――若干客户使用class接口中的同一子集;或者两个classes的接口有部分相同。将相同的子集提炼到一个独立的接口中。
好了,在简单的了解了为何重构和测试的介绍和重要性后,让我们用Eclipse一步步的图解重构与测试:
第一步:建立工程
按 按钮选择java打开Java工作环境(图2),选择菜单File > New > Project…(在package Explorer栏里单击右键也可)弹出New Project对话框,选择Java > Java Project >Next,填入工程名(我这里为traffic) > Next,在设置对话框中选择Libraries标签框(图3),点击Add External JARs按钮加入JUnit.jar(可以到http://www.junit.org/免费下载),最后点击Finish完成。这样一个工程就建好了。
图3:添加Junit
第二步:建立类
原本想遵循极限编程的原则,在建立新类写代码前,必须先建立好完全自动的测试该类功能的单元测试(特别是在重构之前)。但由于Eclipse好像在没有这个类之前无法运行这个测试(也许可以,如果你知道的话请告诉我),说找不到这个类。因此我先建立这些类再编写测试。
在package explorer栏中(菜单选择也可)右击选择New > Source Folder 弹出New Source Folder对话框在Folder Name中填入文件夹名(我这里为src)。然后在package explorer栏中右击选择New > Class 弹出New Java Class对话框,在Name中输入类名(我这里为Car),按Finish完成。同样方法再建立Truck和Person类(类图1),代码如清单一。
清单一:
//Car.java…… public class Car { public String go() { if(engineStarted) return "Vroom"; else return "..."; } public void startEngine() { engineStarted = true; } public void stopEngine() { engineStarted = false; } private boolean engineStarted; } //Truck.java…… public class Truck { public String go() { if(engineStarted) return "Rumble"; else return "..."; } public void startEngine() { engineStarted = true; } public void stopEngine() { engineStarted = false; } public void loadCargo() { //load Cargo }
private boolean engineStarted; } //Person.java…… public class Person { public Person(String arg){ if(arg.equals("Car")){ Car vehicle = new Car(); vehicle.startEngine(); vehicleName = vehicle.go(); } else if(arg.equals("Truck")) { Truck vehicle = new Truck(); vehicle.startEngine(); vehicleName = vehicle.go(); } } public String getVehicle(){ return vehicleName; } private String vehicleName; } |
类图1
第三步:建立测试
选择File > New > Other 弹出新建对话框选择JUnit > TestCase(图4) >Next进入下一个对话框,在Test Calss中填入要测试的类(我这里是Person),Test Case会自动填写为PersonTest(图5),按Finish完成对测试用例的建立。代码如清单二。
图4:新建测试用例
图5:新建测试用例
清单二: import junit.framework.TestCase;
public class PersonTest extends TestCase { public PersonTest(String name) { super(name); } public void testGetVehicle() { assertEquals("Vroom", controlCar.getVehicle()); } public static void main(String[] args) { junit.textui.TestRunner.run(new PersonTest("testGetVehicle")); } protected void setUp() throws Exception { super.setUp(); controlCar = new Person("Car"); controlTruck = new Person("Truck"); } private Person controlCar; private Person controlTruck; } |
第五步:对Person类进行测试
总算写好了这些类,让我来测试一番吧!选择菜单Run > Run…弹出Run对话框(图6),选择JUint单击New,在Test Class中填写测试类名(我这里为PersonTest),随后单击Run,将会有JUnit的图形界面出现在左边栏中,如果没出现请单击原package explorer栏中右下角的JUnit标签(图7)。其中绿色代表测试成功,红色则为失败。
图6:运行测试
图7:Juint的GUI
第六步:开始重构
总算轮到重构了,建立一个良好的测试也未尝不是对重构起到方便之处。好吧!从那里开始呢?先看看那些代码有什么坏味道?
很明显可以看到Car类和Truck类里的方法可以提取一个抽象基类。在解决这个坏味道之前,首先要对这两个类运用手法一进行值域的封装。在Car类中用鼠标反选engineStarted变量,单击右键选择Refactor > Encapsulate Field…(图8)会弹出封装值域的对话框,不用填写任何东西,按Ok完成值域的封装。运行测试看有无错误(测试非常重要,要做一步,测试一次)。当然你也可以按preview按钮查看它做了那些更改,如果有你不需要修改的地方大可去掉。同样完成对Truck类的值域封装。
图8:Refactor 菜单
接下来新建一个Vehicle类做为Car和Truck的基类,无需写任何代码。在Car类中继承Vehicle类(public class Car extends Vehicle)。好了现在可以把这些函数上移了(手法二)。在Car类中的选择go()方法右击,选择Refactor > Pull Up… 弹出上移对画框。设置如图9。你可以一路Next看看他是如何转换的,按Finish完成这次重构。运行测试通过。同样对Truck类进行这项重构。
图9:Pull Up 对话框
好了,让我们再来看看还能进行些什么重构?可以看到Truck类中的loadCargo()函数是卡车装载货物的方法。要是将来再有个货车类型,也需要此方法。所以应该提炼这个接口。有了这个Eclipse自动重构工具,提炼接口可以变得如此简单。选择Truck类的类名,右击选择Refactor > Extract Interface… 弹出Extract Interface对话框(图10),在对话框中的Interface name中输入接口名(我这里是CargoTransport),然后选择loadCargo()函数,可以选择Preview按钮看看它做了那些更改,单击ok完成提炼接口。运行单元测试,显示条为绿色。Ok成功。
图10:Extract Interface 对话框
第七步:最后的修改
最后我们来修改一下Person类,看看重构后修改了那些结构,如何降低了修改成本?
Person类代码修改如清单三,再看一下重构后的类图(类图2)。
清单三: public class Person { public Person(String arg){ try { Class vehicleClass = Class.forName(arg); vehicle = (Vehicle)vehicleClass.newInstance(); vehicle.startEngine(); } catch(Exception e) { e.printStackTrace(); } } public String getVehicle(){ return vehicle.go(); } private Vehicle vehicle; } |
类图2
可以看出重构后的类有着良好的持续发展的能力,当加入一个新的货车类时,可以不必修改Person类,当然重构后的代码也遵循了OCP的一个原则减少类之间的耦合,在抽象层上建立类之间的关联。这――就是这次重构带来的威力。
结束语:
Eclipse 所提供的重构工具使重构变得简单易行,重构可以提高你的编程速度,那么熟悉这些工具将更加有助于提高您的效率。敏捷开发方法采用迭代方式增加程序特性,因此需要依赖于重构技术来改变和扩展程序的设计。当然Eclipse所提供的重构工具不一定非要用在重构上,在你平时编码时一样可以派得上用场,不仅在进行一般的代码修改时提供节约时间的方法。还可以在不修改代码是一样使用(如值域的封装)。如果您花些时间熟悉这些工具,那么当出现可以利用它们的情况时,您就能意识到所花费的时间是值得的。
注:
本文的例子可能举的有些牵强,但这并不影响使用Eclipse实战重构。