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

점층적 생성자 패턴(Telescoping Constructor Pattern)

선택적 매개변수가 많을때 적절히 대응하기가 어렵다. 점층적 생성자 패턴이란, 필수 매개변수만 받는 생성자, 필수 매개변수와 선택 매개변수 1개를 받는 생성자, 선택 매개변수를 받는 생성자, 필수 매개변수와 선택 매개변수 1개를 받는 생성자, 선택 매개변수를 2개까지 받는 생성자 등의 형태로 선택 매개변수를 전부 다 받는 생성자까지 늘려가는 방식이다.

 

점층적 생성자 패턴 - 확장하기 어렵다.

public class NutritionFacts {
    private final int servingSize;  // (mL, 1회 제공량)     필수
    private final int servings;     // (회, 총 n회 제공량)  필수
    private final int calories;     // (1회 제공량당)       선택
    private final int fat;          // (g/1회 제공량)       선택
    private final int sodium;       // (mg/1회 제공량)      선택
    private final int carbohydrate; // (g/1회 제공량)       선택

    /**
     * 많은 생성자
     * - 점층적 생성자 패턴 (생성자 체이닝)
     */
    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, sodium, 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;
    }

    public static void main(String[] args) {
        // 생성자에 내가 어떤 파라미터 순서로 입력해야할지? (command+p 단축키 사용 가능)
        NutritionFacts cocaCola =
                new NutritionFacts(10, 10);
    }
    
}

그러나 아무리 점층적 생성자 패턴을 사용하더라도, 매개변수가 더 늘어난다면 코드가 더 길어지며, 관리하기가 어려워진다.

 

▶ 점층적 생성자 패턴 단점

• 매개변수 개수가 많아질수록 클라이언트 코드를 작성하거나 읽기 어렵다.
• 각 값의 의미가 무엇인지 헷갈린다.
• 매개변수가 몇개인지 주의해서 세어봐야한다.
• 타입이 같은 매개변수가 연달아 늘어서 있으면 찾기 어려운 버그로 이어질 수 있다.
• 매개변수의 순서를 바꿔 호출해도 컴파일러는 알아채지 못하고, 런타임에 엉뚱한 동작을 하게된다.

 

 

자바빈즈 패턴(JavaBeans Pattern)

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

 

자바빈즈 패턴 - 일관성이 깨지고, 불변으로 만들 수 없다.

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;
    private boolean healthy;

    public NutritionFacts() { }

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

    public void setHealthy(boolean healthy) {
        this.healthy = healthy;
    }

    public static void main(String[] args) {
        /* 필수값 셋팅은 안된채로 사용하게 될 수도 있다. - 불안정한 상태 */
        NutritionFacts cocaCola = new NutritionFacts();

        // immutable : set()을 제공하지 않고, 생성자로만 셋팅되도록한다.
        // set()을 제공해야할때는 이를 immutable 객체로 만들기 어렵다.

        // 필수인 데이터를 set() 하기 전에 cocaCola 객체를 사용할 위험이 있음
        cocaCola.setServingSize(240);
        cocaCola.setServings(8);

        cocaCola.setCalories(100);
        cocaCola.setSodium(35);
        cocaCola.setCarbohydrate(27);
    }
}

점층적 생성자 패턴의 단점들이 자바빈즈 패턴에서는 해결되었다. 코드가 길어지긴 했지만 인스턴스를 만들기 쉽고, 더 읽기 쉬운 코드가 되었다.

 

▶ 자바빈즈 패턴 단점

• 객체 하나를 만들려면 메서드를 여러개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성(consistency)이 무너진 상태에 놓이게 된다.
• set 메서드를 호출해서 값을 셋팅해주는 방식이기 때문에 클래스를 불변으로 만들 수 없다.

 

 

빌더 패턴(Builder Pattern)

클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자(혹은 정적 팩터리)를 호출해 빌더 객체를 얻는다. 그런 다음 빌더 객체가 제공하는 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정한다. 마지막으로 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 void main(String[] args) {
        NutritionFacts cocaCola = new Builder(240, 8)
                .calories(100)
                .sodium(35)
                .carbohydrate(27).build();
    }

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

        /* Builder 타입을 리턴 */
        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)
        { carbohydrate = val;  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;
    }
}

NutiritionFacts 클래스는 불변이며, 모든 매개변수의 기본값들을 한곳에 모아뒀다. 빌더의 세터 메서드들을 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다. 이렇게 메서드 호출이 흐르듯 연결됨을 플루언트 API(fluent API) 혹은 메서드 연쇄(method chaining)이라고 한다. 

 

빌더 패턴 사용 예시

public class BuilderTest {

    public static void main(String[] args) {
        // 필수 속성을 설정할 수 있다. (객체를 안전하게, 반드시 받아오게끔 강제할 수 있음)
        // 옵션 속성은 설정해도되고 안해도된다.
        // 반드시 빌더패턴을 사용하지 말고, immutable 하게 만들고 싶을때 사용하자.
        new NutritionFacts.Builder(10, 10)
                .calories(10)
                .build();
    }
}

이 클라이언트 코드는 쓰기 쉽고, 읽기 쉽다. 빌더 패턴에서 잘못된 매개변수를 최대한 일찍 발견하려면 빌더의 생성자와 메서드에서 입력 매개변수를 검사하고, build() 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식(invariant)을 검사하자.

 

공격에 대비해 이런 불변식을 보장하려면 빌더로부터 매개변수를 복사한 후 해당 객체 필드들도 검사해서, 잘못된 점을 발견하면 어떤 매개변수가 잘못되었는지를 자세히 알려주는 메시지를 담아 IllegalArgumentException을 던지면 된다.

 

 

빌더패턴의 계층적 구조

빌더 패턴을 계층적으로 설계된 클래스와 함께 쓰기에 좋다. 각 계층의 클래스에 관련 빌더를 멤버로 정의하자. 추상 클래스는 추상 빌더를, 구체 글래스(concrete class)는 구체 빌더를 갖게한다.

 

추상 클래스 Pizza : 피자의 다양한 종류를 표현하는 계층 구조의 루트

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

   // 추상 클래스는 추상 Builder를 가진다. 서브 클래스에서 이를 구체 Builder로 구현한다.
   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();

      // 하위 클래스는 이 메서드를 overriding하여 this를 반환하도록 해야 한다.
      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;

    /**
     * NyPizza.Builder 타입을 넣는것
     * Builder : <NyPizza.Builder> 타입
     * Builder : Pizza.Builder 의 하위 클래스
     */
    public static class Builder extends Pizza.Builder<NyPizza.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;
    }

    @Override public String toString() {
        return toppings + "로 토핑한 뉴욕 피자";
    }
}

Pizza.Builder 클래스

재귀적 타입 한정을 이용하는 제네릭 타입

 

추상 메서드 self()

하위 클래스에서는 형변환하지 않고도 메서드 연쇄를 지원할 수 있다. self 타입이 없는 자바를 위한 이 우회 방법을 시뮬레이트한 셀프 타입(simulated self-type) 관용구라 한다.

// 아래 코드와 같은 형변환을 하지 않아도 된다.
(NyPizza) new NyPizza.Builder().build();

 

하위 클래스 NyPizza

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

    /**
     * NyPizza.Builder 타입을 넣는것
     * Builder : <NyPizza.Builder> 타입
     * Builder : Pizza.Builder 의 하위 클래스
     */
    public static class Builder extends Pizza.Builder<NyPizza.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;
    }

    @Override public String toString() {
        return toppings + "로 토핑한 뉴욕 피자";
    }
}

 

하위 클래스 Calzone

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

    @Override public String toString() {
        return String.format("%s로 토핑한 칼초네 피자 (소스는 %s에)",
                toppings, sauceInside ? "안" : "바깥");
    }
}

 

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

 

공변 반환 타이핑(convariant return typing)

하위 클래스의 메서드가 상위 클래스의 메서드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능 

 

NyPizza.Builder

NyPizza를 반환

 

Calzone.Builder

Calzone를 반환

 

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

public class PizzaTest {
    public static void main(String[] args) {
        NyPizza pizza = new NyPizza.Builder(SMALL)
                .addTopping(SAUSAGE)
                .addTopping(ONION).build();

        Calzone calzone = new Calzone.Builder()
                .addTopping(HAM).sauceInside().build();
        
        System.out.println(pizza);
        System.out.println(calzone);
    }
}

 

 

빌더의 유용성

빌더를 이용하면 가변인수(varargs) 매개변수를 여러개 사용할 수 있다. 각각을 적절한 메서드로 나눠 선언하면 된다. 아니면 메서드를 여러번 호출하도록 하고 각 호출때 넘겨진 매개변수들을 하나의 필드로 모을 수도 있다.

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

        ...
    }
    
    Pizza(Builder<?> builder) {
        toppings = builder.toppings.clone(); // 아이템 50 참조
    }
}

 

 

▶ 빌더 패턴의 장점

• 빌더 하나로 여러 객체를 순회하면서 만들 수 있다.
• 빌더에 넘기는 매개변수에 따라 다른 객체를 만들 수도 있다.
• 객체마다 부여되는 일련번호와 같은 특정 필드는 빌더가 알아서 채우도록 할 수도 있다. (기본값 지정이 가능하다.)

 

▶ 빌더 패턴의 단점

• 빌더부터 만들어야한다. 빌더 생성 비용이 크지는 않지만 성능이 민감할 경우 문제가 될 수 있다.
• 코드가 장황하여 매개변수가 4개 이상은 되어야 값어치를 한다.