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

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

위의 코드를 살펴보자. 일반적으로 음식에 들어가는 영양성분 클래스인데 대부분은 0으로 들어가는 것들이 많은 도메인이다. 그래서 프로그래머들은 이럴 때 점층적 생성자 패턴(telescoping constructor pattern)을 즐겨 사용했다.

점층적 생성자 패턴을 사용할 수 있지만 보기만 해도 클라이언트 코드를 작성하거나 읽기 어렵다는 단점이 있다.

코드를 읽을 때 각 매개변수가 어떤 의미인지 살펴보는 것도 헷갈리고 갯수도 주의해서 작성해야 할 것이다.

예로, 변수의 순서를 바꿔서 건네줘도 컴파일러는 알아채지 못하고 엉뚱하게 동작하여 버그가 생기게 된다.

다음의 대안은 자바빈즈 패턴(JavaBeans pattern)이다.

매개변수가 없는 생성자로 객체를 만든 후에 setter로 매개변수의 값을 설정하는 방식이다.

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

	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; }
	public void setCarbohydrate(int val) { carbohydrate = val; }
}

이는 점층적 생성자 패턴이 가지고 있던 단점이 보이지 않는다.

하지만 객체를 생성하게 되면 메소드를 여러 개 호출해야 하고 객체가 완전히 생성되기 전까지는 일관성(consistency)가 무너진 상태에 놓이게 된다는 단점이 있다.

위의 예시에서는 매개변수의 유효성을 체크하여 넣어주기만 하면 됐는데 여기서는 장치가 없어진 셈이다.

일관성이 깨진 객체가 만들어지게 되면 버그가 발생한 코드와 런타임에 문제를 일으키는 코드가 물리적으로 떨어져있기 때문에 디버깅에 많은 애로사항이 생길 것이다.

그리고 자바빈즈 패턴은 mutable하기 때문에 Thread-safe하지 않다. synchronized 키워드를 붙이는 방안이 있지만 불편할 것이다.

→ freeze를 해서 단점을 보완하는 방법이 있다고는 하는데 휴먼에러가 존재하는 것 같고 잘 사용하지 않는 것 같다..

마지막 이 모든 것들의 대안인 빌더 패턴(Builder Pattern)이 있다!!

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

NutritionFacts 클래스는 불변(immutable)이고 빌더의 세터 메소드들은 빌더 자신을 반환하기 때문에 연쇄적 호출이 가능하다.

이런 방식을 물 흐르듯이 연결된다고 해서 플루언트 API(Fluent API) 혹은 메소드 연쇄(method chaining)라 한다.

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

이처럼 필수 매개변수인 servingSize, servings만 builder의 매개변수에 넣고 나머지 선택적 매개변수는 메소드 연쇄를 통해 값을 설정해준다. 하지 않을 시 위의 빌더 예시처럼 0으로 반환이 된다.

여기서 유효성 검증 부분이 빠졌는데 객체 필드를 검사해서 잘못된 점을 IllegalArgumentException으로 던지면 된다.

불변(immutable)은 어떠한 변경도 허용하지 않는다는 뜻으로 변경을 허용하는 가변 객체와 구별하는 용도로 사용된다. 대표적으로 String은 immutable 객체이다.
불변식(invariant)는 프로그램이 실행되는 동안, 만족해야 하는 조건을 말한다. 변경을 허용할 수 있으나 예를 들어 리스트는 항상 크기가 0 이상이어야 하니 음수가 잠깐이라도 된다면 불변식이 깨진 것이다.

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

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

Pizza.Builder 클래스는 재귀적 타입 한정을 활용하고 있다. this로 반환하지 않고 self()로 우회하여 각각의 하위 메소드에서 처리를 위임시킨다. 이렇게 하면 하위 메소드에서도 메소드 연쇄를 문제 없이 처리 가능하다!

(이러한 우회 방법을 Simulated self-type 관용구라고 부른다.)

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

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

-----------------------------------------------------------------

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 ? "안" : "바깥");
    }
}

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

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

NyPizza pizza = new NyPizza.Builder(SMALL)
				.addTopping(SAUSAGE).addTopping(ONION).build();
Calzone calzone = new Calzone.Builder()
				.addTopping(HAM).sauceInside().build();

빌더는 생성자와는 달리 유연하게 가변인수 여러개를 사용할 수 있다.

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

빌더 패턴에는 장점만 있는 것이 아니다!

• 빌더부터 생성해야 함 → 생성비용이 크지 않지만 성능이 민감한 상황에서는 문제가 될 수 있다.
• 코드가 장황하기 때문에 매개변수가 4개 이상 될 때부터 이점이 커진다!

→ 하지만 API는 시간이 지날수록 매개변수가 점점 많아지므로 처음에 정적 팩토리나 생성자로 시작했는데 나중에 빌더를 만들어야 하는 경우가 많으므로 애초에 빌더로 시작하는 것이 나을 때가 많다!

핵심 정리
생성자, 정적 팩토리가 처리할 매개변수가 많다면 빌더를 고려하라! 매개 변수 대다수가 필수가 아니거나 같은 타입이면 더더욱 그렇다! 빌더는 점층적 생성자, 자바빈즈 패턴보다 코드를 읽고 쓰기 간결하고 훨씬 안전하다!