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

 

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

public class NutritionFacts {
    private final int servingSize;
    private final int servings;
    private final int calories;
    private final int fat;

    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 = servingSize;
        this.servings = servings;
        this.calories = calories;
        this.fat = fat;
    }
}

 

 

이 클래스의 인스턴스화를 위해서 원하는 매개변수를 모두 포함한 생성자를 호출해야한다. 

NutritionFacts kukbab = new NutritionFacts(300,8,400,0);

 

하지만, 매개변수 개수가 많아질수록 코드를 작성하거나 읽기 어려워진다. 

 

다른 대안은 자바빈즈 패턴이다. 

매개변수가 없는 생성자로 객체를 만든 후, 세터(setter) 메서드를 호출해 매개변수의 값을 설정하는 방식이다. 

public class NutritionFacts {
    private int servingSize;
    private int servings;
    private int calories;
    private int fat;

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

더 읽기 쉬운 코드가 된다. 

NutritionFacts kukbab = new NutritionFacts();
kukbab.setCalories(240);
kukbab.setServings(3);
kukbab.setCalories(300);
kukbab.setFat(5);

 

자바빈즈 패턴의 단점

• 객체하나를 만들기 위해 메서드 여러 개를 호출해야 한다.
• 객체가 완전히 생성되기 전까지 일관성이 무너진 상태에 놓이게 된다. 

이 단점을 완화하기 위해 생성이 끝난 객체를 수동으로 컨트롤(freezing) 하기도 한다. 하지만 이 방법은 다루기 어려워 거의 쓰이지 않는다. 또한 컴파일러가 보증할 방법이 없어 런타임 오류에 취약하다. 

 

 

 

 

세 번째 대안   빌더 패턴(builder pattern) 

점층적 생성자 패턴의 안전성과 자바 빈즈 패턴의 가독성을 겸비한 빌더 패턴이 있다. 필수 매개변수만으로 생성자를 호출해 빌더 객체를 얻는다. 마지막으로 build 메서드를 호출해 필요한 객체를 얻는다. 

public class NutritionFacts {
    private final int servingSize;
    private final int servings;
    private final int calories;
    private final int fat;

   public static class Builder{
       //필수
       private final int servingsSize;
       private final int servings;

       //선택
       private int calories = 0;
       private int fat      = 0;

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

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

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

       public NutritionFacts build() {
           return new NutritionFacts(this);
       }
   }
    private NutritionFacts(Builder builder){
        servingSize = builder.servingsSize;
        servings    = builder.servings;
        calories    = builder.calories;
        fat         = builder.fat;
    }
}

 

NutritionFacts 클래스는 불변이며, 모든 매개변수의 기본 값들을 한 곳에 모았다. 메서드 호출이 연쇄적으로 호출되어 플루언트 API 또는 메서드 연쇄라 한다. 

 

 

NutritionFacts kukbab = new Builder(240,8)
        .calories(300)
        .fat(5)
        .build();

클래스를 인스턴스화 시킨 코드이다. 쓰기도 쉽고, 읽기도 쉽다.

잘못된 매개변수를 최대한 일찍 발견하려면 빌더의 생성자와 메서드에서 입력 매개변수를 검사하고, build 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식을 검사하는 방법이 있다. 

 

 

 

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

 

추상 클래스는 추상 빌더를,

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

다음은 피자의 다양한 종류를 표현하는 추상 클래스다. 

 

//계층적으로 설계된 피자 클래스
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();
    }
}

//뉴욕 피자 
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;}
    }

    private 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(){
            sauceInside = true;
            return this;
        }

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

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

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

 

Pizza.Builder 클래스는 재귀적 타입 한정을 이용하는 제네릭 타입이다. 추가로 추상 메서드인 self를 더해 하위 클래스에서는 형변환하지 않고도 메서드 연쇄를 지원할 수 있다. 

 

1. 뉴욕 피자는 크기(size) 매개변수를 필수로 받는다. 
2. 칼초네 피자는 소스를 안에 넣을지 선택하는 매개변수를 필수로 받는다. 

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

Calzone calzone = new Builder()
        .addTopping(Topping.HAM)
        .sauceInside()
        .build();

NyPizza.Builder는 NyPizza를 반환하고, Calzone.Builder는 Calzone를 반환하게 된다. 

 

※상위 클래스의 메서드가 정의한 반환 타입이 아닌, 하위 타입을 반환하는 것이다. 

이러한 기능을 공변 반환 타이핑(covariant return typing)이라 한다. 

 

빌더패턴은 유연하다. 빌더 하나로 여러 객체를 순회하면서 만들 수 있고, 빌더에 넘기는 매개변수에 따라 다른 객체를 만들 수 있다. 

 

빌더 패턴의 단점, 2가지

1. 빌더 생성 비용이 크진 않으나, 성능에 민감한 상황에서는 문제가 될 수 있다. 
2. 매개변수가 4개 이상은 되어야 값어치를 한다. 

 

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

빌더 패턴은 읽고 쓰기에 편리하다.