如何编写类中的setter和getter

十二月 8, 2004

在effective java中有一item叫”保护性拷贝”，今天又看了许多部门里的代码，发现很多代码都与该item“相违”，晚上和toidi_xu讨论这个问题有些收获。

Considering the following code:
public class Box {
   private int length;
   public void setLength(int length){
       this.length = length;
   }
   public int getLength(){
       return this.length;
   }
}

public class TestJava {
   private String id;
   private int idx;
   private Box box;
   public void setId(String id){
       this.id = id;
   }
   public String getId(){
       return this.id;
   }
   public void setIdx(int idx){
       this.idx = idx;
   }
   public int getIdx(){
       return this.idx;
   }
   public void setBox(Box box){
       this.box = box;
   }
   public Box getBox(){
       return this.box;
   }
   public static void main(String[] args) {
       TestJava tj = new TestJava();
       String id = "tony";
       int idx = 5;
       Box aBox = new Box();
       aBox.setLength(7);

       tj.setId(id);
       tj.setIdx(idx);
       tj.setBox(aBox);

       System.out.println(tj.getId());
       System.out.println(tj.getIdx());
       System.out.println(tj.getBox().getLength());

       id = "bai";
       idx = 6;
       aBox.setLength(8);
       System.out.println(tj.getId());
       System.out.println(tj.getIdx());
       System.out.println(tj.getBox().getLength());
   }
}
//output:
tony
5
7
tony
5
8

对于TestJava类中的3个类型(String, int, Box)的成员变量我们编写了相同的setter和getter,但结果是Box类型的成员变量居然不通过setBox就被修改了，而String和int类型在外部不能被修改。这是为什么呢。在effective java中曾经说过String类和Number类都是immutable的。任何对String or Number类对象的操作都会copy出一个不同于原object的object,而原来的object的状态并未被修改。在上面的例子中Box不是immutable class所以被外部修改了。

为了使client只能通过Box提供的setLength来修改，我们必须作保护性的copy。修改如下：
public void setBox(Box box){
   this.box = new Box();
   this.box.setLength(box.getLength());
}
public Box getBox(){
   Box aBox = new Box();
   aBox.setLength(this.box.getLength());
   return aBox;
}

修改后的output:
tony
5
7
tony
5
7

这样我们在TestJava中就出现两种setter和getter的样式，我们在写代码的时候该使用哪种呢？在实践中“为类中immutable class类型（如String和数值Number类）的field member写setter\getter时，我们不需要提供defensive copy;在为其它非immutable class类型(如上例中的Box类)的field member写setter\getter时，建议考虑defensive copy，以防止client对你的代码的恶意破坏”。所以上面的代码还有另一种改法就是将Box写成immutable class。

这篇blog就当作是对effective java中“defensive copy”一节的细化和补充吧。