[Effective Java] 아이템 2 - 생성자에 매개변수가 많다면 빌더를 고려하라

 

정적 팩터리와 생성자에는 똑같은 제약이 하나 있다. 바로 선택적 매개변수가 많을 때 적절하게 대응하기가 어렵다는 것이다.

 

점층적 생성자 패턴을 사용할 수 있지만, 매개변수의 개수가 많아질수록 클라이언트 코드를 작성하기에도, 읽기에도 어렵다.

코드를 읽을 때 각 값의 의미가 무엇인지 헷갈릴 것이고, 매개변수가 몇 개인지도 주의해서 세어보아야 할 것이다.

 

이럴 때 대안으로는 자비빈즈 패턴(JavaBeans pattern)이 있다.

매개변수가 없는 생성자로 객체를 만든 후, 세터를 이용해서 원하는 매개변수의 값을 설정하는 방식이다.

 

그러나 이러한 방식은 또 다른 단점을 지니는데, 객체 하나를 만들려면 메서드를 여러개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성(consistency)이 무너진 상태에 놓이게 된다.

이로 인해 자바빈즈 패턴을 사용하면 불변 클래스(immutable)로 만들 수 없으며, 스레드 안정성을 얻으려면 프로그래머가 추가적인 작업을 해주어야 한다.

 

마지막 대안이 바로 빌더 패턴이다.

클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자(혹은 정적 팩터리)를 호출해 빌더 객체를 얻는다.

그런 다음 빌더 객체가 제공하는 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정한다.

마지막으로 매개변수가 없는 build 메서드를 호출해 객체(보통은 불변 객체)를 얻는다.

 

 

다음은 예시이다.

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

NutritionFacts는 불변이며, 모든 매개변수의 기본값들을 한곳에 모아뒀다.

빌더의 세터 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다.

이런 방식을 메서드 호출이 흐르듯 연결된다는 뜻으로 플루언트 API(fluent API) 혹은 메서드 연쇄(method chaining)이라 한다.

 

 

빌더 패턴은 계층적으로 설계된 클래스와 함께 사용하기에 좋다.

각 꼐층의 클래스에 관련 빌더를 멤버로 정의하자.

추상 클래스는 추상 빌더를, 구체 클래스는 구체 빌더를 갖게 한다.

다음은 예시이다.

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();
        }
        
        abstract Pizza build();
        protected abstract T self();
        
    }
    
    
    Pizza(Builder<?> builder){
        toppings = builder.toppings.clone();//아이템 50 참조
    }

}

Pizza.Builder 클래스는 재귀적 타입 한정(아이템 30)을 이용하는 제네릭 타입이다.

여기에 추상 메서드인 self를 더해 하위 클래스에서는 형변환하지 않고도 메서드 연쇄를 지원할 수 있다.

self타입이 없는 자바를 위한 이 우회 방법을 시뮬레이트한 셀프 타입(simulated self-type) 관용구라 한다.

 

이제 Pizza의 하위 클래스를 만들어보자.

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
        Pizza build() {
            return new NyPizza(this);
        }

        @Override
        protected Builder self() {
            return this;
        }
    }
    
    NyPizza(Builder builder) {
        super(builder);
        size = builder.size;
    }
    
    
}

 

public class Calzone extends Pizza{

    private final boolean sauceInside;


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

        private boolean sauceInside = false;

        public Builder() {
            sauceInside = true;
        }

        @Override
        Pizza build() {
            return new Calzone(this);
        }

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

    Calzone(Builder builder) {
        super(builder);
        sauceInside = builder.sauceInside;
    }


}

 

각 하위 클래스의 빌더가 정의한 build 메서드는 해당 구체 하위 클래스를 반환하도록 선언한다.

하위 클래스의 메서드가 상위 클래스의 메서드가 정의한 반환 타입이 아닌, 그 타위 타입을 반환하는 기능을 공변 반환 타이핑(covariant return typing)이라 한다.

이 기능을 이용하면 클라이언트가 형변환에 신경쓰지 않고도 빌더를 사용할 수 있다.

 

 

---

 

단점

객체를 만들려면, 그에 앞서 빌더부터 만들어야 한다.

생성 비용이 큰 것은 아니지만 성능에 민감한 상황에서는 문제가 될 수 있으며, 또한 점층적 생성자 패턴보다는 코드가 장황해진다.

 

 

 

---

 

 

핵심 정리

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