JBuilder2005实现重构之重命名
当需要对包、类、方法、值域、局域变量等这些元素进行更名时,请不要通过Search->Replace...或者Search->Replace in path...菜单来进行,而应该用重构功能来完成。如前所述,因为在一个工程中,元素可能已经有众多的调用者,通过替换更名将很难保证定义和调用的同步更改,而重构则从语义关联上提供同时调整的保障。应该说,有了重构,替换的功能在JBuilder将大大弱化。
1、值域及变量重命名
打开Java文件,将光标置于某个值域或局域变量的代码标识处,通过Ctrl+Shift+R->Rename Field调出重构对话框:
图 4 更名值域或局域变量的对话框
·Class:值域或局域变量所在的类
·Old name:原名
·New name:新名
按OK,再点击预览窗口的 应用重构,JBuilder将所有引用的定位的地方都一起同步更改。
属性重命名表 3
属性和值域的区别是前者具有一个get/set访问方法,更改属性变量名时,必须同步更改其相应的get/set方法。可惜的是在编辑器中重构,你无法做到这一点,所幸的是,在UML浏览器中JBuilder却允许你进行这样的重构。
假设Cat类有两个属性,一为age,一为name,现在希望将属性name重构为nickname。切换到Cat类的UML视图页,鼠标右击name属性,在弹出的菜单中选择Rename Property for name...,如下图所示:
图 5 属性重命名重构
弹出属性更名重构对话框,如下图所示:
图 6 属性重命名重构对话框
在New name中键入nickname,点击OK按钮完成重构。JBuilder除完成属性定义和引用的更名外,还完成属性访问方法名的重构:getName()->getNickname(),setName(String name)->setNickname(String name),并更改引用这两个方法的所有调用。
2、方法重命名
将光标移到方法名处,Ctrl+Shift+R->Rename Method调出方法名更名重构对话框如图所示:
图 7 方法重构对话框
提示:
如果一个方法的定位代码为:public String cry(){/**do sth*/},需要将光标放到方法名cry处,才可以调出方法名重构对话框。
对话框中有两个选项:
·Refactor ancestors:勾选这个选项时,如果当前方法是父类方法的覆盖方法,或接口的实现方法,则父类方法或接口方法一并更改。
·Create fowwarding method:在Refactor ancestors选项取消勾选时,这个选项才可用,当选择这个选项时,将产生的一个为保持版本兼容性的转接调用方法,如你将public void foo()方法更名为public void foo_1()方法,该选项在重构的方法后产生一个转接调用的方法:public void foo_1(){/**do sth*/}//更名的方法
public void foo(){foo_1();}//转接调用的方法
如果这个类已经发布,通过这个选项,即可以保证代码的重构,又可以保证版本的兼容。
需要指出的是,方法更名重构只会对方法声明及所有调用同步更改,方法的重载方法并不会相应更改,所以如果一个方法有3个重载方法,需要执行3次方法更名重构。
3、方法参数更改
方法参数的更改,包括以下内容:
·新增一个入参。
·删除某个无用的入参。
·调整文件参数的次序。
下面是myrafactor.Horse类的getAccountPrice()方法:
代码清单 1 参数重构示例代码1. private double getAccountPrice(int amount , double account)
2. {
3. return amount * price * account ;
4. }
5. public void printAccountPrice(int amount)
6. {
7. double account ;
8. if(amount <= 100) {
9. account = 1 ;
10. }
11. else if(amount <= 500) {
12. account = 0.9 ;
13. }
14. else {
15. account = 0.8 ;
16. }
17. System.out.println("总价为:" + getAccountPrice(amount , account)) ;
18. }
假设我们需要为getAccountPrice()新增一个price入参,并将amount和account参数的位置对调,将光标置于getAccountPrice()方法名处:Ctrl+Shift+R->Change Parameters of “getAccountPrice”调出如下所示的对话框:
图 8 方法参数重构对话框
按以下步骤完成重构:
1.点选参数列表中的amount参数,点击Move Down将amount参数调到account之后。
2.点击对话框的Add...按钮弹出Add New Parameter的对话框,如下图所示:
图 9
新增参数对话框
·Type:参数类型,下拉框中列出了基础数据类型及String和Object对象类型,你也可以通过Type后的…按钮选择其他的对象类型。这里我们选择double类型。
·Name:入参的名称,设置为price。
·Default value:默认值,很有必要,因为如果当前的方法已经被调用,则调用处用这个默认的值为新增的入参赋值,这里我们填入1000.0。
你还可以定义数组类型的入参,通过Dimensions指定数组的维度,默认为一维数组。 点击OK返回重构对话框。
3.在重构对话框中点击OK完成方法入参的重构,如下图所示:
代码清单 2 入参调整后的代码1. private double getAccountPrice(double account, int amount, double price)
2. {
3. return amount * price * account ;
4. }
5. public void printAccountPrice(int amount)
6. {
7. double account ;
8. if(amount <= 100) {
9. account = 1 ;
10. }
11. else if(amount <= 500) {
12. account = 0.9 ;
13. }
14. else {
15. account = 0.8 ;
16. }
17. System.out.println("总价为:" + getAccountPrice(account, amount, 1000.0)) ;
18. }
JBuilder搜索所有引用原getAccountPrice()法的地方,完成入参顺序的调整,用默认值为新增的入参赋值,如第17行引用了getAccountPrice(),重构后account和amount对调了顺序,并新增了一个1000.0入参值。
4、类重命名
光标移到类名上,Ctrl+Shift+R->Rename Class调出类重命名的重构对话框,如下图所示:
图 10 类重命名重构
在这里,我们将myrefactor.Cat类名更名为PersianCat,JBuilder将完成以下的事情:
·将类名更改为PersianCat
·类的所有构造函数名更名为PersianCat
·类Java文件从Cat.java更名为PersianCat.java
·实例化类的代码相应,如Cat c = new Cat()将更改为PersianCat c = new PersianCat()。
在没有重构功能之前,更改类名是一项比较累人的差事,因为Java语法规定public类名必须和类Java文件名保持一致,类构造函数名也必须同类名一致,此外还需要和对值域或方法更名一样保证调用一起更改。所以手工对类进行更名是比较麻烦的,而通过重构功能更改类名则不费吹灰之力。
5、包重命名
如果通过手工操作,则包重命名比类重命名的难度更大,因为Java语言规定包名必须和文件目录保持一致,且包中可能会包括多个类,这些类被各自的调用者引用。用重构来完成包重命名将一并完成所有的事情。
要通过重构对包进行重命名时,如将包myrefactor更名为myrefactor_1,只需要打开包中的任何一个类Java文件,将光标移到包名myrefactor处:Ctrl+Shift+R->Rename Package调出包重命名对话框,如下图11所示。
按OK重构后,JBuilder将完成以下的事件:
·将包中所有类的包声明语句更名为package myrefactor_1;
·在<工作目录>src下创建myrefactor_1文件夹,并将原myrefactor文件夹下的Java文件移到myrefactor_1文件夹下。
·同步该包所有类的引用代码,如将某类的myrefactor.Cat c = new myrefactor.Cat()更改为myrefactor_1.Cat c = new myrefactor_1.Cat()。
在包中任何类中对包名进行更名重构,包中所有类的包名都一起更改。如果你只希望更改某个类的包名而保持包中其他类的包声明不变,则你可以通过ErrorInsight到达这个目的。假设包myrefactor中包括4 个类:Creature、Animal、Cat、Horse,你只希望将Horse的包名改为myrefactor_1,则你可以打开Horse.java,将光标置于类名定义外:Ctrl+Shift+R->Move Class,弹出如下的对话框: