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

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

다양한 생성자를 사용하여야 할 때 , 점층적 생성자 패턴(telescoping constructor pattern)을 즐겨 사용했다.

• 점층적 필수 매개변수만 받는 생성자 , 필수 매개변수와 선택 매개변수 1개를 받는 생성자, 선택 매개변수를 2개까지 받는 생성자, … 형태로 선택 매개변수를 전부 다 받는 생성자까지 늘려가는 방식이다.

아래의 코드가 그 예이다.

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

public NutritionFacts(int servingSize, int servings, int calories, int fat){
    this(servingSize, servings, calories,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.fat = fat;
this.sodium = sodium;
this.carbohydrate = carbohydrate;
}

이 클래스의 인스턴스를 만들려면 매개변수를 모두 포함한 생성자 중 가장 짧은 것을 골라 호출하면 된다.

NutritionFacts cocaCola = new NutritionsFacts(240, 8, 100, 0, 35, 27);

보통 이런 생정자는 사용자가 설정하길 원치 않는 매개변수까지 포함하기 쉬운데, 어쩔 수 없이 그런 매개변수에도 값을 지정해주어야 한다. 앞 코드에서는 지방(fat)에 0을 넘겨주었다. 이 예에서 매개변수가 겨우 6개뿐이라 그리 나쁘보이지 않을 수 있지만, 수가 더 늘어나면 걷잡을 수 없게 된다.

점층적 생성자 패턴도 쓸 수는 있지만, 매개 변수가 많아지면 클라이언트에 작성하거나 읽기 어렵다.

단점)

• 코드를 읽을 때 각 값의 의미가 무엇인지 헷갈릴 것이고, 매개변수가 몇 개인지도 주의해서 세어 보아야 할 것이다.
• 타입이 같은 매개변수가 연달아 늘어서 있으면 찾기 어려운 버그로 이어질 수 있다. 클라이언트가 실수로 매개변수 순서를 바꿔 건네줘도 컴파일러는 알아채지 못하고, 결국 런타임에 엉뚱한 동작을 하게 됨.

자바 빈즈 패턴 - 매개 변수가 없는 생성자로 객체를 만든 후, 세터(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;

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

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

NutritionFacts cocaCola = new NutritionFacts();
        cocaCola.setServingSize(240);
        cocaCola.setServings(8);
        cocaCola.setCalories(100);
        cocaCola.setSodium(35);
        cocaCola.setCarbohydrate(27);

자바 빈즈 심각한 단점)

• 자바 빈즈 패턴에서는 객체 하나를 만들려면 메서드를 여러 개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성(consistency)이 무너진 상태에 놓이게 된다.
• 점층적 생성자 패턴에서는 매개변수들이 유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있었는데, 그 장치가 완전히 사라짐
• 일관성이 깨진 객체가 만들어지면, 버그를 심은 코드와 그 버그 때문에 런타임에 문제를 겪는 코드가 물리적으로 멀리 떨어져 있으므로 디버깅 하기도 어려움
• 자바빈즈 패턴에서는 클래스를 불변으로 만들 수 없으며 스레드 안정성을 얻으려면 프로그래머가 추가 작업을 해줘야만 한다.

이러한 단점을 완화하고자 생성이 끝난 객체를 수동으로 ‘얼리고(freezing)’, 얼리기 전에는 사용 x

하지만 이 방법은 다루기 어려워 실전에서 거의 안 씀.

이 방식을 쓴다고 해도 객체 사용 전에 프로그래머가 freeze메서드를 확실히 호출해줬는지를 컴파일러가 보증할 방법이 없어서 런타임 오류에 취약하다.

빌더 패턴(Builder pattern)

• 클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개 변수만으로 생성자(혹은 정적 팩토리)를 호출해 빌더 객체를 얻는다.
• 다음 빌더 객체가 제공하는 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정한다.
• 마지막으로 매개변수가 없는 build메서드를 호출해 필요한 객체를 얻는다.

// 코드 2-3 빌더 패턴 - 점층적 생성자 패턴과 자바빈즈 패턴의 장점만 취했다. (17~18쪽)
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 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;
    }

    public static void main(String[] args) {
        NutritionFacts cocaCola = new NutritionFacts.Builder(240, 8)
                .calories(100).sodium(35).carbohydrate(27).build();
    }
}

NutritionFacts 클래스는 불변이며, 모든 매개변수의 기본값들을 한곳에 모아 뒀다. 빌더의 세터 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다.

이런 방식을 메서드 호출이 흐르듯 연결된다는 뜻으로 플루언트 API (fluent API)혹은 메서드 연쇄(method chaining)라 한다. 다음은 이 클래스를 사용하는 클라이언트의 모습이다.

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

이 클라이언트 코드는 쓰기 쉽고, 무엇보다도 읽기 쉽다. 빌더 패턴은(파이썬과 스칼라에 있는) 명명된 선택적 매개변수(named optional parameters)를 흉내 낸 것이다.

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

검사해서 잘못된 점을 발견하면 어떤 매개변수가 잘못되었는지 자세히 알려주는 메시지를 담아 IllegalArgumentException을 던지면 된다.

불변(immutable 혹은 immutability)

• 어떠한 변경도 허용하지 않는다는 뜻으로, 주로 변경을 허용하는 가변(mutable) 객체와 구분하는 용도로 쓰임.
• String 객체는 한번 만들어지면 절대 값을 바꿀 수 없는 불변 객체

불변식(invariant)

• 프로그램이 실행되는 동안, 혹은 정해진 기간 동안 반드시 만족해야 하는 조건을 말한다. 다시 말해 변경을 허용할 수 있으나 주어진 조건 내에서만 허용한다는 뜻이다. 예컨대 리스트의 크기는 반드시 0이상이어야 하니, 만약 한순간이라도 음수 값이 된다면 불변식이 깨진 것이다.
• Period클래스에서 start필드의 값은 반드시 end 값보다 앞서야 하므로, 두 값이 역전되면 불변식이 깨진 것이다.

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

import java.util.EnumSet;
import java.util.Objects;
import java.util.Set;

public 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();
        }
        //하위 클래스에서 반드시 재정의 
        //this 반환하도록 하자.
        abstract T self();
        abstract Pizza build();
    }
    Pizza(Builder<?> builder){
        toppings =builder.toppings.clone();
    }
}

pizza

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

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

import java.util.Objects;

class NyPizza extends Pizza{
    public enum Size {SMALL, MEDIUM, LARGE}
    private final Size size;
    private 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;
    }
}

NyPizza

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

NyPizza.build는 NyPizza를 반환하고 Calzone.Builder는 Calzone을 반환한다는 뜻이다.

하위 클래스의 메서드가 상위 클래스 메서드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변반환 타이핑(covariant return typing)이라고 한다. 이 기능을 사용하면 클라이언트가 형변환에 신경쓰지 않고도 빌더를 사용할 수 있다.

이러한 ‘계층적 빌더’를 사용하는 클라이언트의 코드도 앞서 영양정보 빌더를 사용하는 코드와 다르지 않다.

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

CalZone 피자

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

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

생성자로는 누릴수 없는 사소한 이점으로, 빌더를 이용하면 가변인수(varags)매개변수를 여러 개 사용할 수 있다. 각각을 적절한 메서드로 나눠 선언하면 된다.

메서드를 여러 번 호출하도록 하고 각 호출 때 넘겨진 매개변수들을 하나의 필드로 모을 수 있다.

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

빌더 패턴 단점)

• 빌더 생성 비용이 크지는 않지만 성능에 민감한 상황에서는 문제가 될 수 있음.
• 점층적 생성자 패턴보다는 코드가 장황해서 매개변수가 4개 이상은 되어야 값어치를 한다. 하지만 API는 시간이 지날수록 매개변수가 증가하는 것을 잊지 말자~!