[Effective Java] 02. 생성자에 매개변수가 많다면 빌더를 고려하라

 

정적 팩터리와 생성자에는 선택적 매개변수가 많을때 적절한 대응이 어렵다.

점층적 생성자 패턴 ( 확장의 어려움)

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; // 선택

    public NutritionFacts(int servingSize, int servings) {
        this(servingSize, servings, 0);
    }

    public NutritionFacts(int servingSize, int servings, int calories) {
        this(servingSize, servings, calories, 0);
    }

    public NutritionFacts(int servingSize, int servings, int calories, int fat) {
        this(servingSize, servings, calories, fat, 0);
    }

    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium) {
        this(servingSize, servings, calories, fat, 0);
    }

        public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium, int carbohydrate) {
        this.servingSize = servingSize;
        this.servings = servings;
        this.calories = calories;
        this.fat = fat;
        this.sodium = sodium;
        this.carbohydrate = carbohydrate;
    }
}

• 필수 매개변수만 받는 생성자와 섞인 생성자 등 아주 많은 생성자가 있다.
• 설정하기를 원하지 않는 매개변수가 있는데도 불구하고 값을 지정해줘야 해서 0을 넘기게 될 수도 있다.
• 매개변수가 많아지면 코드를 작성하거나 읽는데 어렵고 걷잡을 수 없어진다. → 실수가 잦아 버그로 이어짐.

 

 

자바 빈즈 패턴 (일관성 깨짐, 불변 불가능)

public class NutritionFacts {
    private int servingSize = -1;  // 필수
    private int servings = -1;     // 필수
    private int calories = 0;
    private int fat = 0;
    private int sodium = 0;
    private int carbohydrate = 0;

    public NutritionFacts() {}

    public void setServingSize(int val) { servingSize = val; }
    public void setServings(int val) { servings = val; }
    public void setCalories(int val) { calories = val; }
    public void setFat(int val) { fat = val; }
    public void setSodium(int val) { sodium = val; }
    public void setCarbohydrate(int val) {carbohydrate = val; }
}

• 매개변수가 없는 생성자로 객체를 만든 후에 setter 메서드로 값을 설정한다.
• 인스턴스를 만들기 쉽고 가독성이 좋아짐
• 객체 하나를 만들기 위해 여러 메서드를 호출해야하며, 완전히 생성되기 전까지 일관성이 무너진 상태.
• 일관성이 무너지는 문제 때문에 클래스를 불변으로 만들 수 없는 단점.

 

 

빌더 패턴(Builder pattern)

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;

    public static class Builder {  //빌더는 정적 멤버 클래스로
        private final int servingSize;  // 필수
        private final int servings;     // 필수

        //선택 매개변수는 기본값으로 초기화
        private int calories = 0;
        private int fat = 0;
        private int sodium = 0;
        private int carbohydrate = 0;

        public Builder(int servingSize, int servings) {
            this,servingSize = serginsSize;
            this.servings = servings;
        }

        public Builder fat(int val) {
            fat = val;
            return this;
        }

        public Builder sodium(int val) {
            sodium = val;
            return this;
        }

        public Builder carbohydrate(int val) {
            carbohydrate = val;
            return this;
        }

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

    private NutirionFacts(Builder builder) {
        servingSize = builder.servingSize;
        servings = builder.servings;
        calories = builder.calories;
        fat = builder.fat;
        sodium = builder.fat;
        carbohydrate = builder.carbohydrate;
    }
}

• 점층적 생성자 패턴의 안전성 + 자바 빈즈 패턴의 가독성
• 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자를 호출하여 빌더 객체를 얻은 후에 빌더 객체가 제공하는 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정. 이후에 매개변수가 없는 build 메서드를 호출해 필요한 (보통은 불변인)객체를 얻는다.
• 빌더의 세터 메서드들은 빌더를 반환하기 때문에 연쇄적 호출 가능 (fluent API)

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

 

• 빌더 패턴은 계층적으로 설계된 클래스와 함께 쓰기에 좋음
• 각 계층의 클래스에 관련 빌더를 멤버로 정의하고 추상클래스는 추상 빌더, 구체클래스는 구체 빌더를 가짐
• 추상 클래스의 Builder 클래스는 재귀적 타입 한정을 이용하는 제네릭 타입으로, 하위 클래스에서는 형변환하지 않고도 메서드 연쇄 가능
• 각 하위 클래스의 빌더가 정의한 build()는 해당 구체 하위 클래스를 반환 (공변 반환 타이핑(convariant return typing)

public abstract class Pizza {
    public enum Topping { HAM, MUSHROOM, ONION, PEPPER, SAUSAGE }
    final Set<Topping> toppings;

    abstract static class Builder<T extends Builder<T>> {
        EnumSet<Topping> toppings = EnumSet.noneOf(Topping.class);
        public T addTopping(Topping topping) {
            toppings.add(Objects.requireNonNull(topping));
            return self();
        }

        abstarct Pizza build();

        protected abstract T self(); // 하위 클래스에서 이 메서드를 오버라이드 해서 this를 반환
    }

    Pizza(Builder<?> builder) {
        toppings = builder.toppings.clone();
    }
}

public class NyPizza extends Pizza {
    public enum Size { SMALL, MEDIUM, LARGE }
    private final Size size;

    public static class Builder extends Pizza.Builder<Builder> {
        private final Size size;

        public Builder(Size size) {
            this.size = Objects.requireNonNull(size);
        }

        @Override
        public NyPizza build() {
            return new NyPizza(this);
        }

        @Override
        protected Builder self() {
            return this;
        }

        public NyPizza(Builder builder) {
            super(builder);
            size = builder.size;
        }
    }
}

NyPizza pizza = new NyPizza.Builder(SMALL)
    .addTopping(SAUSAGE).addTopping(ONION)
    .build();

 

 

결론

생성자나 정적 팩터리가 처리해야할 매개변수가 많다면 빌더 패턴이 낫다.

매개변수 중 다수가 필수가 아니거나 같은 타입이면 특히 더 낫다.