2. 当构造方法参数过多时使用 builder 模式

      应该为这样的类编写什么样的构造方法或静态工厂?传统上,程序员使用了可伸缩(telescoping constructor)构造方法模式,在这种模式中,首先提供一个只有必需参数的构造方法,接着提供增加了一个可选参数的构造函数,然后提供增加了两个可选参数的构造函数,等等,最终在构造函数中包含所有必需和可选参数。以下就是它在实践中的样子。为了简便起见,只显示了四个可选属性:

      当想要创建一个实例时,可以使用包含所有要设置的参数的最短参数列表的构造方法:

      通常情况下,这个构造方法的调用需要许多你不想设置的参数,但是你不得不为它们传递一个值。 在这种情况下,我们为 fat 属性传递了 0 值。「只有」六个参数可能看起来并不那么糟糕,但随着参数数量的增加,它很快就会失控。

      简而言之,可伸缩构造方法模式是有效的,但是当有很多参数时,很难编写客户端代码,而且很难读懂它。 读者不知道这些值是什么意思,并且必须仔细地去数参数才能找到答案。一长串相同类型的参数可能会导致一些细微的 bug。如果客户端不小心写反了两个这样的参数,编译器并不会报错,但是程序在运行时会出现错误行为 (详见第 51 条)。

      当在构造方法中遇到许多可选参数时,另一种选择是 JavaBeans 模式,在这种模式中,调用一个无参的构造方法来创建对象,然后调用 setter 方法来设置每个必需的参数和可选参数:

    1. // JavaBeans Pattern - allows inconsistency, mandates mutability
    2. public class NutritionFacts {
    3. // Parameters initialized to default values (if any)
    4. private int servingSize = -1; // Required; no default value
    5. private int servings = -1; // Required; no default value
    6. private int calories = 0;
    7. private int fat = 0;
    8. private int sodium = 0;
    9. private int carbohydrate = 0;
    10. public NutritionFacts() { }
    11. // Setters
    12. public void setServingSize(int val) { servingSize = val; }
    13. public void setServings(int val) { servings = val; }
    14. public void setCalories(int val) { calories = val; }
    15. public void setFat(int val) { fat = val; }
    16. public void setSodium(int val) { sodium = val; }
    17. public void setCarbohydrate(int val) { carbohydrate = val; }
    18. }

      这种模式没有伸缩构造方法模式的缺点。有点冗长,但创建实例很容易,并且易于阅读所生成的代码:

      通过在对象构建完成时手动「冻结」对象,并且不允许它在解冻之前使用,可以减少这些缺点,但是这种变体在实践中很难使用并且很少使用。 而且,在运行时会导致错误,因为编译器无法确保程序员会在使用对象之前调用 freeze 方法。

      幸运的是,还有第三种选择,它结合了可伸缩构造方法模式的安全性和 JavaBean 模式的可读性。 它是 Builder 模式[Gamma95] 的一种形式。客户端不直接构造所需的对象,而是调用一个包含所有必需参数的构造方法 (或静态工厂)得到获得一个 builder 对象。然后,客户端调用 builder 对象的与 setter 相似方法来设置你想设置的可选参数。最后,客户端调用builder对象的一个无参的 build 方法来生成对象,该对象通常是不可变的。Builder 通常是它所构建的类的一个静态成员类(详见第 24 条)。以下是它在实践中的示例:

    1. // Builder Pattern
    2. public class NutritionFacts {
    3. private final int servingSize;
    4. private final int servings;
    5. private final int calories;
    6. private final int fat;
    7. private final int sodium;
    8. private final int carbohydrate;
    9. public static class Builder {
    10. // Required parameters
    11. private final int servingSize;
    12. private final int servings;
    13. // Optional parameters - initialized to default values
    14. private int calories = 0;
    15. private int fat = 0;
    16. private int sodium = 0;
    17. private int carbohydrate = 0;
    18. public Builder(int servingSize, int servings) {
    19. this.servingSize = servingSize;
    20. this.servings = servings;
    21. }
    22. public Builder calories(int val) {
    23. calories = val;
    24. }
    25. public Builder fat(int val) {
    26. fat = val;
    27. return this;
    28. }
    29. public Builder sodium(int val) {
    30. sodium = val;
    31. return this;
    32. }
    33. public Builder carbohydrate(int val) {
    34. carbohydrate = val;
    35. return this;
    36. }
    37. public NutritionFacts build() {
    38. return new NutritionFacts(this);
    39. }
    40. }
    41. private NutritionFacts(Builder builder) {
    42. servingSize = builder.servingSize;
    43. servings = builder.servings;
    44. calories = builder.calories;
    45. fat = builder.fat;
    46. sodium = builder.sodium;
    47. carbohydrate = builder.carbohydrate;
    48. }
    49. }

      NutritionFacts 类是不可变的,所有的参数默认值都在一个地方。builder 的 setter 方法返回 builder 本身,这样就可以进行链式调用,从而生成一个流畅的 API。下面是客户端代码的示例:

    1. NutritionFacts cocaCola = new NutritionFacts.Builder(240, 8)
    2. .calories(100).sodium(35).carbohydrate(27).build();

      这个客户端代码很容易编写,更重要的是易于阅读。 采用Builder 模式模拟实现的的可选参数可以在Python和Scala都可以找到。

      为了简洁起见,省略了有效性检查。 要尽快检测无效参数,检查 builder 的构造方法和方法中的参数有效性。 在 build 方法调用的构造方法中检查包含多个参数的不变性。为了确保这些不变性不受攻击,在从 builder 复制参数后对对象属性进行检查(详见第 50 条)。 如果检查失败,则抛出 IllegalArgumentException 异常(详见第 72 条),其详细消息指示哪些参数无效(详见第 75 条)。

      Builder 模式非常适合类层次结构。 使用平行层次的 builder,每个builder嵌套在相应的类中。 抽象类有抽象的 builder;具体的类有具体的 builder。 例如,考虑代表各种比萨饼的根层次结构的抽象类:

      这里有两个具体的 Pizza 的子类,其中一个代表标准的纽约风格的披萨,另一个是半圆形烤乳酪馅饼。前者有一个所需的尺寸参数,而后者则允许指定酱汁是否应该在里面或在外面:

    1. import java.util.Objects;
    2. public class NyPizza extends Pizza {
    3. public enum Size { SMALL, MEDIUM, LARGE }
    4. private final Size size;
    5. public static class Builder extends Pizza.Builder<Builder> {
    6. private final Size size;
    7. this.size = Objects.requireNonNull(size);
    8. }
    9. return new NyPizza(this);
    10. }
    11. @Override protected Builder self() {
    12. return this;
    13. }
    14. }
    15. private NyPizza(Builder builder) {
    16. super(builder);
    17. size = builder.size;
    18. }
    19. }
    20. public class Calzone extends Pizza {
    21. private final boolean sauceInside;
    22. public static class Builder extends Pizza.Builder<Builder> {
    23. private boolean sauceInside = false; // Default
    24. public Builder sauceInside() {
    25. sauceInside = true;
    26. return this;
    27. }
    28. @Override public Calzone build() {
    29. return new Calzone(this);
    30. }
    31. @Override protected Builder self() {
    32. return this;
    33. }
    34. }
    35. private Calzone(Builder builder) {
    36. super(builder);
    37. sauceInside = builder.sauceInside;
    38. }
    39. }

      请注意,每个子类 builder 中的 build 方法被声明为返回正确的子类:NyPizza.Builderbuild 方法返回 NyPizza,而 Calzone.Builder 中的 build 方法返回 Calzone。 这种技术,其一个子类的方法被声明为返回在超类中声明的返回类型的子类型,称为协变返回类型(covariant return typing)。 它允许客户端使用这些 builder,而不需要强制转换。

      这些「分层 builder(hierarchical builders)」的客户端代码基本上与简单的 NutritionFacts builder 的代码相同。为了简洁起见,下面显示的示例客户端代码假设枚举常量的静态导入:

    1. NyPizza pizza = new NyPizza.Builder(SMALL)
    2. .addTopping(SAUSAGE).addTopping(ONION).build();
    3. .addTopping(HAM).sauceInside().build();

      builder 对构造方法的一个微小的优势是,builder 可以有多个可变参数,因为每个参数都是在它自己的方法中指定的。或者,builder 可以将传递给多个调用的参数聚合到单个属性中,如前面的 addTopping 方法所演示的那样。

      Builder 模式非常灵活。 单个 builder 可以重复使用来构建多个对象。 builder 的参数可以在构建方法的调用之间进行调整,以改变创建的对象。 builder 可以在创建对象时自动填充一些属性,例如每次创建对象时增加的序列号。

      Builder 模式也有缺点。为了创建对象,首先必须创建它的 builder。虽然创建这个 builder 的成本在实践中不太可能被注意到,但在看中性能的场合下这可能就是一个问题。而且,builder 模式比伸缩构造方法模式更冗长,因此只有在有足够的参数时才值得使用它,比如四个或更多。但是请记住,你可能在以后会想要添加更多的参数。但是,如果你一开始是使用的构造方法或静态工厂,当类演化到参数数量失控的时候再转到Builder模式,过时的构造方法或静态工厂就会面临尴尬的处境。因此,通常最好从一开始就创建一个 builder。