PSJay Blog

#FIXME, seriously

静态内部类的应用:Builder

| Comments

有时候我们可能会要设计这样一个类:它有许多属性,其中一部分是必需的( required),而另一部分是可选的(optional)。

以饮料罐上的营养标识为例。

可乐罐上的营养标识可能是这样的:

[table id=1 /]

而咖啡饮料罐上的营养标识可能是这样的:

[table id=2 /]我们可以根据各种饮料的营养标识标抽象出一个NutritionFact类。这个类有两个必需的(required)属性:energy(能量)和carbohydrate(碳水化合物),以及四个可选的(optional)属性:protein(蛋白质),fat(脂肪),sodium(钠)以及vitaminC(维他命C),通常,我们会给这个类添上一个以所有属性为参数列表的构造方法,就像下面这样:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public class NutritionFact {
   private int energy;
   private int carbohydrate;
   private int protein;
   private int sodium;
   private int fat;
   private int vitaminC;

   public NutritionFact(int energy, int carbohydrate, int protein, int sodium, int fat,int vitaminC) {
       this.energy = energy;
       this.carbohydrate = carbohydrate;
       this.protein = protein;
       this.sodium = sodium;
       this.fat = fat;
       this.vitaminC = vitaminC;
   }
   //getters ...
}

于是,我们就可以这样来实例化可乐的营养标识和咖啡的营养标识了:

1
2
NutritionFact colaNutritionFact = new NutritionFact(225, 12, 0, 6, 0, 0);
NutritionFact coffeNutrutionFact = new NutritionFact(225, 11, 1, 10, 1, 0);

这显然不是个好的设计,如果可选属性有几十个甚至更多,那么程序员会为这么一长串参数而头疼不已,毕竟中间有很多实际上不需要的参数都要用“0”来占位。

或许我们可以借助方法重载来改善一下这个设计,比如像下面这样。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
public class NutritionFact {
   private int energy;
   private int carbohydrate;
   private int protein;
   private int sodium;
   private int fat;
   private int vitaminC;

   public NutritionFact(int energy, int carbohydrate) {
       this(energy, carbohydrate, 0);
   }

   public NutritionFact(int energy, int carbohydrate, int protein) {
       this(energy, carbohydrate, protein, 0);
   }

   public NutritionFact(int energy, int carbohydrate, int protein, int sodium) {
       this(energy, carbohydrate, protein, sodium, 0);
   }

   public NutritionFact(int energy, int carbohydrate, int protein, int sodium, int fat) {
       this(energy, carbohydrate, protein, sodium, fat, 0);
   }

   public NutritionFact(int energy, int carbohydrate, int protein, int sodium, int fat,int vitaminC) {
       this.energy = energy;
       this.carbohydrate = carbohydrate;
       this.protein = protein;
       this.sodium = sodium;
       this.fat = fat;
       this.vitaminC = vitaminC;
   }   

   //getters ...

}

这个时候,我们在实例化一些对象的时候就可以省略掉末尾的不需要的参数了。上文的实例化代码就可以简化成这样:

1
2
NutritionFact colaNutritionFact = new NutritionFact(225, 12, 0, 6);
NutritionFact coffeNutrutionFact = new NutritionFact(225, 11, 1, 10, 1);

但是实际上我们还是轻松不了多少,因为通常不需要的可选参数不会这么碰巧的都在参数列表末尾。就像上面的例子中实例化colaNutritionFact一样,参数列表中间还是填充了那烦人的“0”。

那么有没有什么办法能让我们只关心实际需要的可选属性呢?当然是有的,比如说JavaBean:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
public class NutritionFact {
   private int energy = -1;
   private int carbohydrate = -1;
   private int protein;
   private int sodium;
   private int fat;
   private int vitaminC;

  public int getEnergy() {
      return energy;
  }
  public void setEnergy(int energy) {
      this.energy = energy;
  }
  public int getCarbohydrate() {
      return carbohydrate;
  }
  //省略其他属性的getter和setter...

}

这个时候,我们就只要关心我们需要的属性了:

1
2
3
4
5
6
7
8
9
10
11
NutritionFact colaNutritionFact = new NutritionFact();
colaNutritionFact.setEnergy(225);
colaNutritionFact.setCarbohydrate(12);
colaNutritionFact.setSodium(6);

NutritionFact coffeNutrutionFact = new NutritionFact();
coffeNutrutionFact.setEnergy(225);
coffeNutrutionFact.setCarbohydrate(11);
coffeNutrutionFact.setProtein(1);
coffeNutrutionFact.setSodium(10);
coffeNutrutionFact.setFat(1);

这样,我们确实只要关心实际需要的参数了,而且代码的可读性较好。并且如果将getter的返回值改成对象本身的话可以使代码更加简洁。但是这样却带来了一个缺点:不能将这个类设计成不可变的(immutable)。因为我们一旦给属性加上final修饰符,这个类将通不过编译——类中的setter试图改变final属性的值。

那么怎样才可以解决这个问题又能使代码保持简洁性和较好的可读性呢?答案就是:使用Builder。 如果使用Builder,应该这样设计:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
public class NutritionFact {
   private int energy;
   private int carbohydrate;
   private int protein;
   private int sodium;
   private int fat;
   private int vitaminC;

   private NutritionFact(NutritionFactBuilder builder) {
       energy = builder.energy;
       carbohydrate = builder.carbohydrate;
       protein = builder.protein;
       sodium = builder.sodium;
       fat = builder.fat;
       vitaminC = builder.vitaminC;
   }

   static class NutritionFactBuilder {
       //required props
       private int energy;
       private int carbohydrate;
       //optional props
       private int protein;
       private int sodium;
       private int fat;
       private int vitaminC;

       public NutritionFactBuilder(int energy, int carbohydrate) {
           this.energy = energy;
           this.carbohydrate = carbohydrate;
       }

       public NutritionFactBuilder protein(int val) {
           protein = val;
           return this;
       }
       public NutritionFactBuilder sodium(int val) {
           sodium = val;
           return this;
       }
       public NutritionFactBuilder fat(int val) {
           fat = val;
           return this;
       }
       public NutritionFactBuilder vitaminC(int val) {
           vitaminC = val;
           return this;
       }

       public NutritionFact build() {
           return new NutritionFact(this);
       }

  }

  //getters...
}

实例化的代码如下:

1
2
NutritionFact colaNutritionFact = new NutritionFactBuilder(225,12).sodium(6).build();
NutritionFact coffeNutritionFact = new NutritionFactBuilder(225,11).protein(1).sodium(10).fat(1).build();

我们通过builder将需要的数据全部都准备好,然后调用builder的build方法实例化出我们真正需要的对象。这样的代码,简洁性和可读性并存,并且完全可以把NutritionFact类设计成不可变的。Builder是静态内部类的一个重要的应用。

总之,如果需要设计一个拥有很多可选属性的类的时候,特别是当其为不可变(immutable)类的时候,使用Builder是一个不错的选择。

Comments