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

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

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

예를 들어, 식품 영양 정보를 표현하는 클래스는 1회 내용량, n회 제공량, 1회 제공량당 칼로리 같은 필수 항목과 지방, 트랜스지방, 포화지방, 콜레스테롤 나트륨 등등 20개가 넘는 선택항목으로 이루어진다.
그런데 대부분 제품은 이 선택항목 중 대다수의 값이 그냥 0이다.
이런 클래스용 생성자 혹은 정적 팩토리는 프로그래머들은 점층적 생성자 패턴(telescoping constructor pattern)을 사용했다. 

필수 매개변수만 받는 생성자, 필수 + 선택 1개, 필수 + 선택 2개 ... 과 같은 형태로 전부다 받는 생성자 까지 늘려가는 방식이다.  

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

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

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

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

선택 매개변수가 많을 때 활용할 수 있는 두 번째 대안으로 자바빈즈 패턴이 있다.
매개변수가 없는 생성자로 객체를 생성 후 세터 메서드들을 호출해 원하는 매개변수의 값을 설정하는 방법이다.
점층적 생성자 패턴의 단점들이 자바빈즈 패턴에서는 보이지 않는다.
코드가 길어지긴 하지만 인스턴스를 만들기 쉽고, 더 읽기 쉬운 코드가 되었다.

하지만 자바빈즈 패턴에서는 객체 하나를 만들려면 메서드를 여러 개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성(consistency)이 무너진 상태에 놓이게 된다.

점층적 생성자 패턴에서는 매개변수들이 유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있었는데, 그 장치가 완전히 사라진 것이다.

일관성이 깨진 객체가 만들어지면, 버그를 심은 코드와 그 버그 때문에 런타임에 문제를 겪는 코드가 물리적으로 멀리 떨어져 있을 것이므로 디버깅도 쉽지 않다.

이처럼 일관성이 무너지는 문제 때문에 자바빈즈 패턴에서는 클래스를 불변으로 만들 수 없으며 스레드 안정성을 얻으려면 프로그래머가 추가 작업을 해줘야만한다.

점층적 생성자 패턴의 안정성과 자바빈즈 패턴의 가독성의 장점을 살린 빌더 패턴을 사용하면 된다.

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

 

public class NutritionFacts {
    private final int servingSize;
    private final int serving;
    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 serving;

        // 선택 매개변수
        private int calories;
        private int fat;
        private int sodium;
        private int carbohydrate;

        public Builder(int servingSize, int serving){
            this.servingSize = servingSize;
            this.serving = serving;
        }

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

    public NutritionFacts(Builder builder) {
        this.servingSize = builder.servingSize;
        this.serving = builder.serving;
        this.calories = builder.calories;
        this.fat = builder.fat;
        this.sodium = builder.sodium;
        this.carbohydrate = builder.carbohydrate;
    }
}

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

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

NutritionFacts 클래스를 사용하는 클라이언트 코드의 모습이다.
이 코드는 쓰기 쉽고, 무엇보다 읽기 쉽다.

빌더 패턴은 (파이썬과 스칼라에 있는) 명명된 선택적 매개변수(named optional parameters)를 흉내낸것이다.
빌더 패턴은 계층적으로 설계된 클래스와 함께 쓰기 좋다.

다음은 피자의 다양한 종류를 표현하는 계층 구조의 루트에 놓인 추상 클래스다.

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

public abstract class Pizza {

    final Set<Topping> toppings;

    Pizza(Builder<?> builder) {
        toppings = builder.toppings.clone();
    }

    public enum Topping {HAM, MUSHROOM, ONION, PEPPER, SAUSAGE}

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

}

Pizze.Builder 클래스는 재귀적 타입 한정을 이용하는 제네릭 타입이다.
여기에 추상 메서드인 self를 더해 하위 클래스에서는 형변환하지 않고도 메서드 연쇄를 지원할 수 있다.
self 타입이 없는 자바를 위한 이 우회 방법을 시뮬레이트한 셀프타입(simulated self-type) 관용구라 한다.

 

이 Pizze의 하위 클래스 2개가 있다.
뉴욕 피자는 크키(size)를 필수 매개변수로 받고, 칼쵸네(calzone)는 소스를 안에 넣을지 선택하는 변수(sauceInside)를 필수로 받는다.

import java.util.Objects;

public class NyPizza extends Pizza {

    private final Size size;

    private NyPizza(Builder builder) {
        super(builder);
        this.size = builder.size;
    }

    public enum Size {SMALL, MEDIUM, LARGE}

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

        private final Size size;

        public Builder(Size size) {
            this.size = Objects.requireNonNull(size);
        }

        @Override
        NyPizza build() {
            return new NyPizza(this);
        }

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

 

public class Calzone extends Pizza {

    private final boolean sauceInside;

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

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

        private boolean sauceInside = false; // 기본값

        public Builder sauceInside() {
            sauceInside = true;
            return this;
        }

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

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

}

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

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

이러한 '계층적 빌더'를 사용하는 클라이언트의 코드도 앞선 영양정보 빌더를 사용하는 코드와 다르지 않다.
또한, 생성자로는 누릴 수 없는 사소한 이점으로, 빌더를 이용하면 가변인수(varargs) 매개변수를 여러개 사용할 수 있다.
각각을 적절한 메서드로 나눠 선언하면 된다.
아니면 메서드를 여러번 호출하도록 하고 각 호출 때 넘겨진 매개변수들을 하나의 필드로 모을 수도 있다.
appTopping 메서드가 이렇게 구현한 예시다.

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

객체마다 부여되는 일련번호와 같은 특정 필드는 빌더가 알아서 채우도록 할 수도 있다.
빌더 패턴에 장점만 있는 것은 아니다.
객체를 만들려면, 그에 앞서 빌더부터 만들어야한다. 빌더 생성 비용이 크지는 않지만 성능에 민감한 상황에서는 문제가 될 수 있다.
또한, 점층적 생성자 패턴보다는 코드가 장황해서 매개변수가 4개 이상은 되어야 제대로 된 값어치를 한다고 한다.

하지만 API는 시간이 지날수록 매개변수가 많아지는 경향이 있고 생성자나 정적 팩토리 방식으로 시작했다가 나중에 매개변수가 많아지면 빌더 패턴으로 전환할 수도 있지만, 이전에 만들어둔 생성자와 정적 팩토리가 도드라져 보일 수 있기 때문에 빌더로 시작하는 편이 나을 때가 많다.


핵심 정리

생성자나 정적 팩토리가 처리해야 할 매개변수가 많다면 빌더 패턴을 선택하는 게 더 낫다.
매개 변수 중 다수가 필수가 아니거나 같은 타입이면 더욱 그렇다.
빌더는 점층적 생성자보다 클라이언트 코드를 읽고 쓰기가 쉽고, 자바빈즈 패턴보다 훨씬 안전하다.