[이펙티브 자바] 아이템 2. 생성자에 매개변수가 많다면 빌더를 고려하라

effective-java에서 스터디를 진행하고 있습니다.

 

점층적 생성자 패턴

정적 팩터리와 생성자에는 모두 매개변수가 많을 때 적절히 대응하기 어렵다. 가령 클래스의 필드가 6개있고, 매개변수를 2개 일 때, 3개 일 때, ... 등으로 생성자를 나누고 싶다면, 아래와 같이 점층적 생성자 패턴을 사용할 수 있다.

 

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, 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;
    }

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

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

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

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

 

하지만 이마저도 매개 변수가 많아지면, 코드를 읽을 때 각 값의 의미가 무엇인지 헷갈리고, 타입이 같은 매개변수를 혼동하여 값을 넣을 수가 있다.

 

자바 빈즈 패턴

자바 빈즈 패턴은 매개변수가 없는 생성자로 객체를 만든 후, setter 메서드들을 호출하여 원하는 매개변수의 값을 설정하는 방식이다.

 

public class NutritionFactsWithJavaBeansPattern {

    private int servingSize = -1; // 필수. 기본 값 없음.

    private int servings = -1; // 필수. 기본 값 없음.

    private int calories;

    private int fat;

    private int sodium;

    private int carbohydrate;

    public void setServingSize(int servingSize) {
        this.servingSize = servingSize;
    }

    public void setServings(int servings) {
        this.servings = servings;
    }

    public void setCalories(int calories) {
        this.calories = calories;
    }

    public void setFat(int fat) {
        this.fat = fat;
    }

    public void setSodium(int sodium) {
        this.sodium = sodium;
    }

    public void setCarbohydrate(int carbohydrate) {
        this.carbohydrate = carbohydrate;
    }
}

 

자바 빈즈 패턴은 매개변수가 많아지더라도 값을 헷갈리지 않고 인스턴스를 만들어줄 수 있다. 하지만 객체 하나를 만드려면 setter 메서드를 여러 개 호출해야 하고, 객체가 완전히 완성되기 전까지는 일관성이 깨지게 된다. 이 때문에 클래스를 불변으로 만들 수 없다.

 

빌더 패턴

점층적 생성자 패턴의 안정성과 자바 빈즈 패턴의 가독성을 겸비한 빌더 패턴을 주로 사용한다.

클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자를 호출하여 빌더 객체를 얻는다. 그런 다음 빌더 객체가 제공하는 일종의 setter 메서드들로 원하는 선택 매개변수를 설정한다. 마지막으로 매개변수가 없는 build() 메서드를 호출하여 필요한 객체를 얻는다.

 

public class NutritionFactsWithBuilderPattern {

    private final int servingSize;

    private final int servings;

    private final int calories;

    private final int fat;

    private final int sodium;

    private final int carbohydrate;

    private NutritionFactsWithBuilderPattern(Builder builder) {
        servingSize = builder.servingSize;
        servings = builder.servings;
        calories = builder.calories;
        fat = builder.fat;
        sodium = builder.sodium;
        carbohydrate = builder.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;
        }

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

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

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

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

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

Builder 클래스 내의 생성자는 필수 매개변수만을 입력받고, 나머지 선택 매개변수는 일종의 setter 메서드로 채워 넣는다. 그리고 마지막으로 build() 메서드를 통해 완성된 NutritionFactsWithBuilderPattern 객체를 생성한다. NutritionFactsWithBuilderPattern 클래스는 불변이며, 빌더의 setter 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다. 이런 방식을 플루언트 API 혹은 메서드 연쇄라고 한다.

 

NutritionFactsWithBuilderPattern nutritionFacts = 
    new NutritionFactsWithBuilderPattern.Builder(240, 8)
        .calories(100)
        .sodium(35)
        .build();

 

클라이언트 입장에서는 빌더 패턴을 통해 코드를 쓰기 쉽고, 읽기도 쉽게 작성할 수 있다.

 

계층적으로 설계된 클래스와 잘 어울리는 빌더 패턴

public abstract class Pizza {

    public enum Topping {
        HAM, MUSHROOM, ONION, PEPPER, SAUSAGE
    }

    final Set<Topping> toppings;

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

    abstract static class Builder<T extends Builder<T>> {

        private EnumSet<Topping> toppings = EnumSet.noneOf(Topping.class);

        public T addTopping(Topping topping) {
            toppings.add(topping);
            return self();
        }

        abstract Pizza build();

        protected abstract T self();
    }
}

 

Pizza.Builder 클래스는 재귀적 타입 한정을 이용하는 제네릭 타입이며, 추상 메서드인 self() 를 더해 하위 클래스에서는 형변환하지 않고도 메서드 연쇄를 지원한다. 하위 클래스에서는 이 추상 메서드의 반환 값을 자기 자신을 주면 된다.

이제 Pizza의 하위 클래스인 뉴욕 피자와 칼초네 피자를 보며, 빌더 패턴의 유연함을 경험해 보자.

 

public class NyPizza extends Pizza {

    public enum Size {
        SMALL, MEDIUM, LARGE
    }

    private final Size size; // 필수 매개변수

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

    public static class Builder extends Pizza.Builder<Builder> {

        private final Size size;

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

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

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

}

public class CalzonePizza extends Pizza {

    private final boolean sauceInside; // 선택 매개변수

    private CalzonePizza(Builder builder) {
        super(builder);
        sauceInside = builder.sauceInside;
    }

    public static class Builder extends Pizza.Builder<Builder> {

        private boolean sauceInside = false;

        public Builder sauceInside() {
            sauceInside = true;
            return this;
        }

        @Override
        CalzonePizza build() {
            return new CalzonePizza(this);
        }

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

}

 

각 하위 클래스의 빌더가 정의한 build() 클래스는 구체 하위 클래스를 반환하고 있다. 하위 클래스의 메서드가 상위 클래스의 메서드가 반환한 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변 반환 타이핑이라고 한다. 이 기능을 사용하면 클라이언트가 형변환을 할 필요가 없다.

 

NyPizza nyPizza = new NyPizza.Builder(Size.SMALL)
    .addTopping(Topping.SAUSAGE)
    .addTopping(Topping.ONION)
    .build();

CalzonePizza calzonePizza = new CalzonePizza.Builder()
    .addTopping(Topping.HAM)
    .sauceInside()
    .build();

 

클라이언트 입장에서는 Pizza의 enum과 각 하위 클래스의 enum을 혼용할 수 있으며, 각각의 적절한 메서드로 객체를 완성할 수 있게 된다.

 

빌더 패턴의 단점

• 빌더 객체를 생성해야 한다.
• 코드가 장황하다.

 

정리

생성자나 정적 팩터리 메서드가 처리해야 할 매개변수가 많다면 빌더 패턴을 고려해 보자.

 

출처

• 이펙티브 자바