玩转Eclipse — 自动生成setter和getter方法

我们在程序开发过程中，往往要编写这样的类：类的部分或者全部属性不希望让外部世界直接访问，而不用public字段修饰。这样，方法调用成了访问这些属性的唯一途径。JavaBean就是一个很好的例子，其严格遵守面向对象的设计逻辑，所有属性都是private。对于任何属性xxx，都有public的getXxx()方法来获取属性和public的setXxx()方法来修改属性。如果只有少量这样的属性，可以通过手动方式为它们添加setter和getter方法。但是，如果有大量这样的属性，手动添加会很费时。

        下面通过一个示例，来介绍如何通过Eclipse自动生成需要的setter和getter方法。示例代码如下：

[java]  view plain  copy

1. /** 
2.  * The Class Boy. 
3.  */  
4. public class Boy {  
5.       
6.     /** The name. */  
7.     private String name;  
8.       
9.     /** The age. */  
10.     private int age;  
11.       
12.     /** The smart. */  
13.     private boolean smart;  
14. }  

1.  基本设置

        在代码编辑器中打开Boy.class文件，使用快捷键Alt + Shift + S，再按R键（你Eclipse中的快捷键可能不同），或者右键选择Source -> Generate Getters and Setters...，操作如下图所示：

        进入自动生成setter和getter方法的设置界面如下：

• Select

Select All：选择为所有的属性添加setter和getter方法

Deselect All：取消所有已选择的setter和getter方法

Select Getters：选择所有属性的getter方法

Select Setters：选择所有属性的setter方法

• Insertion point

可以选择为该文件的“First Member”，“Last Member”，或者某个元素之后等。

• Sort by

Fields in getter/setter pairs：每个属性的getter和setter方法成对排序

First getters, then setters：所有的getter方法在所有的setter方法之前

• Access modifier

可以选择访问权限：public，protected，default，private

还可以选择是否为final或者synchronized

• Comments

可以选择是否在自动生成setter和getter方法的同时，为它们生成注释

       另外，在Code Template中可以设置自动生成的setter和getter方法的主体和注释的格式。

2. setter方法的参数加前缀

        一般情况下，自动生成的setter方法中的参数，会跟属性完全相同，需要通过this来区分同名属性和参数。示例如下：

[java]  view plain  copy

1. /** 
2.  * @param age the age to set 
3.  */  
4. public final void setAge(int age) {  
5.     this.age = age;  
6. }  

        在比较严的代码格式检查中，这种情况会提示‘xxx’ hides a field的问题。为了避免这种checkstyle的问题，通过在该项目的.settings目录下的org.eclipse.jdt.core.prefs文件，在其末尾添加org.eclipse.jdt.core.codeComplete.argumentPrefixes=new，就可以在自动创建的所有setter方法的参数前面加上new前缀。这种配置，需要重新启动Eclipse才能生效。这种方法的具体操作和分析，可以参考《玩转Eclipse — 项目的.settings目录解密》。

        进行以上配置之后，自动生成的setter和getter方法后的完成的代码如下：

[java]  view plain  copy

1. /** 
2.  * The Class Boy. 
3.  */  
4. public class Boy {  
5.       
6.     /** The name. */  
7.     private String name;  
8.       
9.     /** The age. */  
10.     private int age;  
11.       
12.     /** The smart. */  
13.     private boolean smart;  
14.   
15.     /** 
16.      * @return the name 
17.      */  
18.     public final String getName() {  
19.         return name;  
20.     }  
21.   
22.     /** 
23.      * @param newName the name to set 
24.      */  
25.     public final void setName(String newName) {  
26.         name = newName;  
27.     }  
28.   
29.     /** 
30.      * @return the age 
31.      */  
32.     public final int getAge() {  
33.         return age;  
34.     }  
35.   
36.     /** 
37.      * @param newAge the age to set 
38.      */  
39.     public final void setAge(int newAge) {  
40.         age = newAge;  
41.     }  
42.   
43.     /** 
44.      * @return the smart 
45.      */  
46.     public final boolean isSmart() {  
47.         return smart;  
48.     }  
49.   
50.     /** 
51.      * @param newSmart the smart to set 
52.      */  
53.     public final void setSmart(boolean newSmart) {  
54.         smart = newSmart;  
55.     }  
56. }  

        说明：

                1）setter方法的参数会自动大写属性的首字母，并加上前缀。

                2）setter方法的参数在属性前面加了前缀之后，就没有必要再用this区分属性和参数。

                3）对于boolean类型的属性，getter不再是get开头，而是以is开头。

from: http://blog.csdn.net/jmyue/article/details/11903899