在Eclipse中对Java代码重构初探

原文选择自 sxhv998 的 CSDN Blog
修改：zieckey(zieckey@yahoo.com.cn)
Eclipse 是一个开放源代码的、基于 Java 的可扩展开发平台。就其本身而言，它只是一个框架和一组服务(图1)，用于通过插件组件构建开发环境。幸运的是，Eclipse 附带了一个标准的插件集，包括 Java 开发工具（Java Development Tools，JDT）。Eclipse Platform 为工具开发提供一组健壮的服务和 API。它使来自完全不同的供应商的工具之间的集成变得平滑，为不同类型的开发工作创建了一个无缝的环境。



何谓重构?
重构――是指在不改变软件任何功能的前提下对代码进行修改，调整其结构，提高其可理解性，降低其修改的成本。
为什么重构?
重构的基本思想就是集中精力使设计简化，并且在新的需求出现时提供一个持续发展（而非扩展）的环境。重构是一项功能强大的技术，但需以微小的步伐修改程序才行。因为在重构时可能在你不经意之间引入了一些错误，尤其是我们在手工进行时更是如此。有这样的危险存在，那我们为什么要对现有运行良好的程序进行重构呢？
重构可以改进软件的设计；
重构可以使你的代码看起来更易理解；
重构可以找出潜伏的臭虫；
重构可以帮助你提高编程的速度――在一次次的迭代过程中阻止系统腐败变质，减少在调试中所花的时间；
重构这个工具有太多太多的好处，它可以使我们更快速的开发软件，甚至还可以提高我们的设计质量。
前面也提到过手工重构可能会引入一些错误，所以我们需要一个可以自动重构的工具――Eclipse。只要我们知道 Eclipse 实现了什么样的重构工具，并理解了它们的适用情况，我们的生产力就会得到极大的提高。当然要降低对代码造成破坏的风险，一套可靠的测试机制是必不可少的。一整组完全自动化的测试就是一个强大的臭虫侦测器，能够大大缩减查着臭虫所需要的时间。频繁的运行这个测试可以极大的减小错误产生的可能，所以在重构中测试也是非常重要的，Martin Fowler说：“没有测试就不要轻易地重构，那样会给你带来麻烦的”。同样Eclipse也集成了对JUnit的支持。

一般的重构手法简介:
手法一：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一步步的图解重构：

下面我们看一个具体的例子。
假设我们现在有下面的一个程序，根据注释应该很快就可以明白这个程序的大体流程和功能。

/**
* 该程序实现一个基本的图型应用程序窗口
* 有菜单栏，并且对部分菜单项进行了程序响应，例如退出、打开文件等
*/
package menutest;

import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.FileInputStream;

/**
* @author zieckey@yahoo.com.cn
*/
public class MenuFrame extends Frame
{
String frameTitle;

public MenuFrame ( String name ) throws HeadlessException
{
super ( );
this.frameTitle = name;
}

/**
* @param args
*/
@SuppressWarnings ( "deprecation" )
public static void main ( String[] args )
{
final MenuFrame f = new MenuFrame ( "http://zieckey.cublog.cn" );
f.setSize ( 600 , 400 );
f.setLocation ( 100 , 100 );

final TextArea ta = new TextArea();//构造一个输入区域
f.add ( ta );

// 响应关闭按钮的信号
f.addWindowListener ( new WindowAdapter ( )
{
public void windowClosing ( WindowEvent e )
{
System.exit ( 0 );
}
} );

MenuBar mb = new MenuBar ( );
Menu m1 = new Menu ( "File" );
Menu m2 = new Menu ( "Edit" );
MenuItem mi1 = new MenuItem ( "New" );
MenuItem mi2 = new MenuItem ( "Open" );
MenuItem mi3 = new MenuItem ( "Save" );
MenuItem mi4 = new MenuItem ( "Exit" );
MenuItem mi5 = new MenuItem ( "Copy" );
MenuItem mi6 = new MenuItem ( "Paste" );

// 响应Open退出菜单的事件
mi2.addActionListener ( new ActionListener ( )
{
public void actionPerformed ( ActionEvent arg0 )
{
//构造一个打开文件对话框
FileDialog fd = new FileDialog ( f,
"zieckey Open File Dialog", FileDialog.LOAD );
fd.setVisible ( true );//将其显示出来

//得到用户选择的文件名全称
String fileName = fd.getDirectory ( ) + fd.getFile ( ) ;
if ( fileName != null )
{
try
{
FileInputStream fis=new FileInputStream(fileName);//构造一个文件输入流
byte[] buf=new byte[10*1024];

//读取数据到buf中
int len=fis.read(buf);
//将buf中数据添加到文本输入区域
ta.append ( new String(buf,0,len) );
fis.close ( );
}
catch ( Exception e )
{
e.printStackTrace ( );
}
} else
{

}
}

} );

// 响应Exit退出菜单的事件
mi4.addActionListener ( new ActionListener ( )
{
public void actionPerformed ( ActionEvent arg0 )
{
System.exit ( 0 );
}
} );

// 将菜单项添加到菜单中
m1.add ( mi1 );
m1.add ( mi2 );
m1.add ( mi3 );
m1.add ( mi4 );
m2.add ( mi5 );
m2.add ( mi6 );

// 将各个菜单添加到菜单栏中
mb.add ( m1 );
mb.add ( m2 );

// 将菜单栏添加到主窗口中
f.setMenuBar ( mb );

f.setVisible ( true );
}
}

下面开始代码重构第一步：Rename (更换名字)
“String name;”语句定义了窗口的标题,可是从name的命名没有看出这一点,
所以换个更有意义的名字例如"frameTitle"会使程序可读性更好。
在代码中选择语句 “String name;”中的“name”，然后右键依次选择：Refactor->Rename，
如下图所示：



接下来在弹出的对话框中将name改为frameTitle，如下图：



好了，可以选择Preview > 来预览以下效果，如下图：



感觉满意的话就点击OK按钮实现这次更名操作。

代码重构第二步：Encapsulate Field (封装值域)
对于面向对象程序设计而言，类的内容数据成员应该是被封装起来的，所以我们可以对MenuFrame类中的frameTitle进行封装，选中frameTitle，然后右键依次选择：Refactor-> Encapsulate Field…，如下图所示：



好了，可以选择Preview > 来预览以下效果，如下图：



感觉满意的话就点击OK按钮实现这次值域封装操作。

代码重构第三步：Extract Method (抽取函数)
在main方法中，对open菜单的响应是通过内部类来实现的，这个过程由点复杂，现在我们尝试将这个操作通过一个函数来实现，选中new ActionListener ( ){}，以及大括号内所有内容，然后右键依次选择：Refactor-> Extract Method，如下图所示：



好了，输入新建立的函数名称，例如我们选择这个名称：openFileActionListener，这一过程会自动将函数内要用的变量作为函数参数传入的，如下图所示：




点击OK按钮实现这次抽取函数操作。

现在程序看起来是这个样子：
/**
* 该程序实现一个基本的图型应用程序窗口 有菜单栏，并且对部分菜单项进行了程序响应，例如退出、打开文件等
*/
package menutest;

import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.FileInputStream;

/**
* @author zieckey@yahoo.com.cn
*/
public class MenuFrame extends Frame
{
private String frameTitle;

public MenuFrame ( String name ) throws HeadlessException
{
super ( );
this.setFrameTitle ( name );
}

/**
* @param args
*/
@SuppressWarnings ( "deprecation" )
public static void main ( String[] args )
{
final MenuFrame f = new MenuFrame ( "http://zieckey.cublog.cn" );
f.setSize ( 600 , 400 );
f.setLocation ( 100 , 100 );

final TextArea ta = new TextArea ( );// 构造一个输入区域
f.add ( ta );

// 响应关闭按钮的信号
f.addWindowListener ( new WindowAdapter ( )
{
public void windowClosing ( WindowEvent e )
{
System.exit ( 0 );
}
} );

MenuBar mb = new MenuBar ( );
Menu m1 = new Menu ( "File" );
Menu m2 = new Menu ( "Edit" );
MenuItem mi1 = new MenuItem ( "New" );
MenuItem mi2 = new MenuItem ( "Open" );
MenuItem mi3 = new MenuItem ( "Save" );
MenuItem mi4 = new MenuItem ( "Exit" );
MenuItem mi5 = new MenuItem ( "Copy" );
MenuItem mi6 = new MenuItem ( "Paste" );

// 响应Open退出菜单的事件
mi2.addActionListener ( openFileActionListener ( f , ta ) );

// 响应Exit退出菜单的事件
mi4.addActionListener ( new ActionListener ( )
{
public void actionPerformed ( ActionEvent arg0 )
{
System.exit ( 0 );
}
} );

// 将菜单项添加到菜单中
m1.add ( mi1 );
m1.add ( mi2 );
m1.add ( mi3 );
m1.add ( mi4 );
m2.add ( mi5 );
m2.add ( mi6 );

// 将各个菜单添加到菜单栏中
mb.add ( m1 );
mb.add ( m2 );

// 将菜单栏添加到主窗口中
f.setMenuBar ( mb );

f.setVisible ( true );
}

private static ActionListener openFileActionListener ( final MenuFrame f,
final TextArea ta )
{
return new ActionListener ( )
{
public void actionPerformed ( ActionEvent arg0 )
{
// 构造一个打开文件对话框
FileDialog fd = new FileDialog ( f,
"zieckey Open File Dialog", FileDialog.LOAD );
fd.setVisible ( true );// 将其显示出来

// 得到用户选择的文件名全称
String fileName = fd.getDirectory ( ) + fd.getFile ( );
if ( fileName != null )
{
try
{
FileInputStream fis = new FileInputStream (
fileName );// 构造一个文件输入流
byte[] buf = new byte[10 * 1024];

// 读取数据到buf中
int len = fis.read ( buf );
// 将buf中数据添加到文本输入区域
ta.append ( new String ( buf, 0, len ) );
fis.close ( );
}
catch ( Exception e )
{
e.printStackTrace ( );
}
} else
{

}
}

};
}

void setFrameTitle ( String frameTitle )
{
this.frameTitle = frameTitle;
}

String getFrameTitle ()
{
return frameTitle;
}
}

好了，现在程序是不是比开始的可读性要好多了呢？

是的，通过Eclipse我们可以很方便的对Java代码进行重构，提高其可理解性，降低其修改的成本。

Eclipse还提供了很多其他的重构方法，相信你很快就会熟练的使用了。