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

정적 패터리와 생성자에는 똑같은 제약이 하나 있습니다.

선택적 매개변수가 많을 때 적절히 대응하기 어렵다는 점입니다.

이런 클래스용 생성자 혹은 정적 팩터리는 어떤 모습일까요?

점층적 생성자(telescoping constructor) 패턴

프로그래머들은 이럴 때 점층적 생성자 패턴을 즐겨 사용했습니다.

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

다음 코드가 그 예입니다.

지면상 선택 매개변수가 4개까지 늘어난 코드를 예로 들었습니다.

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

}

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

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

보통 이런 생성자는 사용자가 설정하길 원치 않는 매개변수까지 포함하기 쉬운데, 어쩔 수 없이 그런 매개변수에도 값을 지정해줘야 합니다.

앞 코드에서는 지방(fat)에 0을 넘겼습니다.

 

이 예에서는 매개변수가 겨우 6개뿐이라 그리 나빠 보이지 않을 수 있지만, 수가 더 늘어나면 금세 걷잡을 수 없게 됩니다.

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

 

코드를 읽을 때 각 값의 의미가 무엇인지 헷갈릴 것이고, 매개변수가 몇 개인지도 주의해서 세어 보아야 하 것입니다.

타입이 같은 매개변수가 연달아 늘어서 있으면 찾기 어려운 버그로 이어질 수 있습니다.

클라이언트가 실수로 매개변수의 순서를 바꿔 건네줘도 컴파일러는 알아채지 못하고, 결국 런타임에 엉뚱한 동작을 하게 됩니다. (아이템 51)

자바빈스(JavaBeans) 패턴

이번에는 선택 매개변수가 많을 때 활용할 수 있는 두 번째 대안인 자바빈즈 패턴을 보겠습니다.

매개변수가 없는 생성자로 객체를 만든 후, 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 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;
    }
    
}

점층적 생성자 패턴의 단점들이 자바빈즈 패턴에서는 더 이상 보이지 않습니다.

코드가 길어지긴 했지만 인스턴스를 만들기 쉽고, 그 결과 더 읽기 쉬운 코드가 되었습니다.

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

하지만 불행히도 자바빈즈는 자신만의 심각한 단점을 지니고 있습니다.

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

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

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

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

이러한 단점을 완화하고자 생성이 끝난 객체를 수동으로 얼리고(freezing) 얼리기 전에는 사용할 수 없도록 하기도 합니다.

 

하지만 이 방법은 다루기 어려워서 실전에서는 거의 쓰이지 않습니다.

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

빌더(Builder) 패턴

점층적 생성자 패턴의 안정성과 자바빈즈 패턴의 가독성을 겸비한 빌더 패턴이 있습니다.

클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자(혹은 정적 팩터리)를 호출해 빌더 객체를 얻습니다.

그런 다음 빌더 객체가 제공하는 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정합니다.

마지막으로 매개변수가 없는 build 메서드를 호출해 드디어 우리에게 필요한 (보통은 불변인) 객체를 얻습니다.

빌더는 생성할 클래스 안에 정적 멤버 클래스로 만들어두는 게 보통입니다.

이제 빌더가 어찌 동작하는지 코드로 살펴봅시다.

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 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 sodium) {
            this.sodium = sodium;
            return this;
        }

        public Builder carbohydrate(int carbohydrate) {
            this.carbohydrate = carbohydrate;
            return this;
        }
    }

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

}

NutritionFacts 클래스는 불변이며, 모든 매개변수의 기본값들을 한곳에 모아뒀습니다.

빌더의 세터 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있습니다.

이런 방식을 메서드 호출이 흐르듯 연결된다는 뜻으로 플루언트(fluent) API 혹은 메서드 연쇄(method chaining)라 합니다.

다음은 이 클래스를 사용하는 클라이언트 코드의 모습입니다.

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

이 클라이언트 코드는 쓰기 쉽고, 무엇보다도 읽기 쉽습니다.

빌더 패턴은 파이썬과 스칼라에 있는 명명된 선택적 매개변수를 흉내냈습니다.

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

공격에 대비해 이런 불변식을 보장하려면 빌더로부터 매개변수를 복사한 후 해당 객체 필드들도 검사해야 합니다.(아이템 50)

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

불변(immutable 혹은 immutability) vs 불변식(invariant)

불변은 어떠한 변경도 허용하지 않는다는 뜻으로, 주로 변경을 허용하는 가변 객체와 구분하는 용도로 쓰입니다.

대표적으로 String 객체는 한 번 만들어지면 절대 값을 바꿀 수 없는 불변 객체입니다.

한편 불변식은 프로그램이 실행되는 동안, 혹은 정해진 기간 동안 반드시 만족해야 하는 조건을 말합니다.

다시 말해 변경을 허용할 수는 있으나 주어진 조건 내에서만 허용한다는 뜻입니다.

예를 들어 리스트의 크기는 반드시 0 이상이어야 하니, 만약 한 순간이라도 음수 값이 된다면 불변식이 깨진 것입니다.

또한, 기간을 표현하는 Period 클래스에서 start 필드의 값은 반드시 end 필드의 값보다 앞서야 하므로, 두 값이 역전되면 역시 불변식이 깨진 것입니다. (아이템 50)

따라서 가변 객체에도 불변식은 존재할 수 있으며, 넓게 보면 불변은 불변식의 극단적인 예라 할 수 있습니다.

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

각 계층의 클래스에 관련 빌더를 멤버로 정의해봅시다.

추상 클래스는 추상 빌더를, 구체 클래스는 구체 빌더를 갖게 합니다.

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

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

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

        // 하위 클래스는 이 메서드를 재정의(overriding)하며
        // "this"를 반환하도록 해야 한다.
        protected abstract T self();
    }

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

Pizza.Builder 클래스는 재귀적 타입 한정(아이템 30)을 이용하는 제네릭 타입입니다.

여기에 추상 메서드인 self를 더해 하위 클래스에서는 형변환하지 않고도 메서드 연쇄를 지원할 수 있습니다.

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

여기 Pizza의 하위 클래스가 2개 있습니다.

하나는 일반적인 뉴욕 피자이고, 다른 하나는 칼초네 피자입니다.

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

뉴욕 피자

import java.util.Objects;

public class NYPizza extends Pizza {
    public enum Size { SMALL, MEDIUM, LAGRE }
    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;
    }
}

칼초네 피자

import java.util.Objects;

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

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

NYPizza.Builder는 NYPizza를 반환하고, Calzone.Builder는 Calzone를 반환한다는 뜻입니다.

하위 클래스의 메서드가 상위 클래스의 메서드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변 반환 타이핑이라 합니다.

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

이러한 '계층적 빌더'를 사용하는 클라이언트의 코드도 앞선 영양정보 빌더를 사용하는 코드를 다르지 않습니다.

다음의 클라이언트 측 코드 예는 열거 타입 상수를 정적 임포트했다고 가정하고 작성했습니다.

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

생성자로는 누릴 수 없는 사소한 이점으로, 빌더를 이용하면 가변인수 매개변수를 여러 개 사용할 수 있습니다.

각각을 적절한 메서드로 나눠 선언하면 됩니다.

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

위 코드에서 addTopping 메서드가 이렇게 구현한 예입니다.

빌더 패턴은 상당히 유연합니다.

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

객체마다 부여되는 일련번호와 같은 특정 필드는 빌더가 알아서 채우도록 할 수도 있습니다.

빌더 패턴의 단점

빌더 패턴에 장점만 있는 것은 아닙니다.

객체를 만들려면, 그에 앞서 빌더부터 만들어야 합니다.

빌더 생성 비용이 크지는 않지만 성능에 민감한 상황에서는 문제가 될 수 있습니다.

또한 점층적 생성자 패턴보다는 코드가 장황해서 매개변수가 4개 이상은 되어야 값어치를 합니다.

하지만 API는 시간이 지날수록 매개변수가 많아지는 경향이 있음을 명심합시다.

그러니 애초에 빌더로 시작하는 편이 나을 때가 많습니다.

정리

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