在《Effective Java》 中创建与销毁对象第二条规则中提到:遇到多个构造器参数时要考虑用构建器(builder模式)
原文中提出如果用一个类表示食品包装外面显示的营养成分标签,在这个标签中,有些元素是必需的;每份的含量、每罐的含量以及每份的卡路里、还有超过20个可选域:总脂肪量、饱和脂肪量、转化脂肪、胆固醇、钠、钾、等。可选域为非必需的、
对于具有这样特性的类,一般习惯采用重叠构造器模式,在这种模式下,只提供第一个有必要参数的构造器,第二个构造器有一个可选参数、第三个有两个可选参数、以此类推,最后一个构造器包含所有的可选参数,示例如下:
重叠构造器模式
public class NutritionFacts {
private final int servingSize; //必需元素
private final int servings; //必需元素
private final int calories; //非必需元素
private final int fat; //非必需元素
private final int sodium; //非必需元素
private final int carbohydrate; //非必需元素
1 public NutritionFacts(int servingSize, int servings) {
// TODO Auto-generated constructor stub
this(servingSize,servings,0);
}
2 public NutritionFacts(int servingSize, int servings,int calories) {
// TODO Auto-generated constructor stub
this(servingSize,servings,calories,0);
}
3 public NutritionFacts(int servingSize, int servings,int calories,int fat) {
// TODO Auto-generated constructor stub
this(servingSize,servings,calories,fat,0);
}
4 public NutritionFacts(int servingSize, int servings,int calories,int fat,int sodium) {
// TODO Auto-generated constructor stub
this(servingSize,servings,calories,fat,sodium,0);
}
//包含所有参数的构造函数
5 public NutritionFacts(int servingSize, int servings,int calories,int fat,int sodium,int carbohydrate) {
// TODO Auto-generated constructor stub
this.servingSize=servingSize;
this.servings=servings;
this.calories=calories;
this.fat=fat;
this.sodium=sodium;
this.carbohydrate=carbohydrate;
}
}
当需要创建实例的时候,选用参数列表最短的构造器,但是该构造器的参数列表要满足包含要设置的所有参数。 通过上述代码可以发现,选用的构造函数会依次调用其下面的构造函数。如选用2,2又会调用3、3继续调用4、4又调用5,然后在5中完成对象创建。
但是这样存在着一个问题,如果说我们的可选元素是最后一个,那我们就得调用最后这个构造函数,但是前面那些不需要的可选元素仍在参数列表中,我们还必须给它传递值为0。参数比较少的时候还可以接受,一旦参数变得很多这种方法的使用就很不方便了,对客户端代码的编写将会非常困难和麻烦,并且还需要清楚每一个参数是什么意思,如果说参数顺序不小心弄错了编译不会出现问题,但是实例出来的对象肯定是我们不想要的无效对象。
平时我们编写类时一般都遵循JavaBean模式,通过构造函数创建对象,然后调用setter方法进行参数设置
通过JavaBean可以选择性地来根据需求创建我们想要的实例,但是JavaBean模式本身存在一个缺点,对象先被创建,然后通过几个调用来构造对象,这可能会使JavaBean处于不一致的状态
Builder模式
该模式不直接生成想要的对象,而是利用所有必要的参数调用构造器,得到一个Builder对象,然后在Builder对象调用类似setter的方法,来设置每个相关的可选参数,最后调用build方法生成不可变对象,Builder是要构建的类的静态内部类,示例如下:
public class NutritionFactsBuilder {
private final int servingSize; //必需元素
private final int servings; //必需元素
private final int calories; //非必需元素
private final int fat; //非必需元素
private final int sodium; //非必需元素
private final int carbohydrate; //非必需元素
//静态内部类
public static class Builder{
//复制需要创建类的成员变量
private final int servingSize;
private final int servings;
private int calories;
private int fat;
private int sodium;
private int carbohydrate;
//构造函数,参数列表为所有必需元素
public Builder(int servingSize, int servings) {
this.servingSize=servingSize;
this.servings=servings;
}
//类似JavaBean中setter,为可选属性赋值,并且返回自身引用
public Builder calories(int calories) {
this.calories=calories;
return this;
}
public Builder fat(int fat) {
this.fat=fat;
return this;
}
public Builder sodium(int sodium) {
this.sodium=sodium;
return this;
}
public Builder carbohydrate(int carbohydrate) {
this.carbohydrate=carbohydrate;
return this;
}
//在内部类对象组装完成后调用该方法,将该对象作为参数传入需要创建的类的构造方法中,返回最终想要得到的对象
public NutritionFactsBuilder build() {
return new NutritionFactsBuilder(this);
}
}
//需要创建的类的构造方法,以静态内部类Builder的对象为参数,完成对象的初始化
public NutritionFactsBuilder(Builder builder) {
servingSize=builder.servingSize;
servings=builder.servings;
calories=builder.calories;
fat=builder.fat;
sodium=builder.sodium;
carbohydrate=builder.carbohydrate;
}
@Override
public String toString() {
return "NutritionFactsBuilder [servingSize=" + servingSize + ", servings=" + servings + ", calories=" + calories
+ ", fat=" + fat + ", sodium=" + sodium + ", carbohydrate=" + carbohydrate + "]";
}
}
创建代码如下:
public class ClazzTest {
public static void main(String[] args) {
NutritionFactsBuilder nutr=new NutritionFactsBuilder.Builder(19, 12).calories(12).build();
System.out.println(nutr);
}
}
打印结果:
NutritionFactsBuilder [servingSize=19, servings=12, calories=12, fat=0, sodium=0, carbohydrate=0]
这样的代码在使用过程中很容易编写,也很容易理解,易于阅读
如果类的构造器或静态工厂中有多个参数,builder模式是种不错的选择,特别是当很多参数是可选参数,比传统的重叠构造器模式相比,builder模式更易于阅读和编写,同时又比JavaBean更加安全。