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

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

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

 

점층적으로 생성자 패턴을 쓸 수는 있지만 매개변수의 갯수가 많아지면 많아질수록 코드를 작성하거나 읽기가 어렵다.

이렇게 선택 매개변수가 많을 때 활용할 수 있는 방법 중 하나로 자바빈즈 패턴이 있다.

매개변수가 없는 생성자로 객체를 만든 후 setter 메서드를 호출해서 값을 설정하는 방식이다.

하지만 이 방식도 객체 하나를 만드려면 메서드를 여러개 호출해야 하고 객체가 완전히 생성되기 전까지는 일관성이 무너진다.

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

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

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

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

 

세번째 대안이 있다.

점층적 생성자 패턴, 자바빈즈 패턴의 단점인 안전성과 가독성을 겸비한 빌더 패턴이 그것이다.

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

마지막으로 매개변수가 없는 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();
    }
}

 

위는 빌더 패턴을 적용한 클래스의 예시이며 main 메서드에서 선택 매개변수를 적절히 골라 객체를 생성하는 것을 볼 수 있다.

 

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

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

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

 

불변 - 어떠한 변경도 허용하지 않는다는 뜻

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

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

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

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

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

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

 

(대표적인 가변 객체로는 ArrayList, HashMap, StringBuilder, StringBuffer 등이 존재한다.

이외에도 프로그래머가 커스텀 객체를 생성하여 내부 상태를 변경할 수 있게 만든다면, 그것도 가변 객체가 된다.)

 

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

각 계층의 클래스에 관련 빌더를 멤버로 정의하자.

추상 클래스는 추상 빌더를 구체 클래스는 구체 빌더를 갖게한다.

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

 

// 코드 2-4 계층적으로 설계된 클래스와 잘 어울리는 빌더 패턴 (19쪽)

// 참고: 여기서 사용한 '시뮬레이트한 셀프 타입(simulated self-type)' 관용구는
// 빌더뿐 아니라 임의의 유동적인 계층구조를 허용한다.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 타입이 없는 자바를 위한 이 우회 방법을 simulated self-type 관용구라 한다.

 

여기에 Pizza의 하위 클래스 2개 있다. 하나는 뉴욕 피자, 다른 하나는 칼초네 피자다.

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

// 코드 2-5 뉴욕 피자 - 계층적 빌더를 활용한 하위 클래스 (20쪽)
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 + "로 토핑한 뉴욕 피자";
    }
}

// 코드 2-6 칼초네 피자 - 계층적 빌더를 활용한 하위 클래스 (20~21쪽)
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 메서드는 해당하는 구체 하위 클래스를 반환하도록 선언되어 있다.

NyPizza.Builder는 NyPizza를 반환하고 Calzone.Builder는 Calzone를 반환한다.

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

 

이러한 '계층적 빌더'를 사용하는 클라이언트의 코드도 앞선 NutritionFacts를 사용하는 코드와 다르지 않다.

따라서 아래와 같이 사용할 수 있다.

 

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

 

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

각각을 적절한 메서드로 나눠 선언하거나 메서드를 여러 번 호출하도록 한 다음 넘겨진 매개변수들을 하나의 필드로 모을 수 있다.

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

 

빌더 패턴에 장점만 있는 것은 아니다. 객체를 만들려면 그에 앞서 빌더부터 만들어야한다.

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

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

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

생성자나 정적 팩터리 방식으로 시작했다가 나중에 전환할 수도 있지만 애초에 빌더로 시작하는 편이 나을 때가 많다.

 

Lombok의 @Builder

위에서 만든 빌더 관련 클래스를 직접 만들지 않아도 해당 클래스에 어노테이션을 적용할 수 있도록 Lombok에서 해당 기능을 제공해준다.

 

@Builder
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;

 

Java14의 Record

롬복과 비슷한 기능을 하는 타입이 등장했고 16버전에 정식으로 릴리즈되었다.

아래와 같이 어노테이션을 붙이면 된다.(record 타입은 Lombok의 @Data 기능을 기본적으로 가지고 있음)

@RecordBuilder
public record NameAndAge(String name, int age){}

 

핵심 정리

생성자나 정적 팩터리가 처리해야 할 매개변수가 많다면 빌더 패턴을 선택하는 게 더 낫다.

매개변수 중 다수가 필수가 아니거나 같은 타입이면 특히 더 그렇다.

빌더는 점층적 생성자보다 클라이언트 코드를 읽고 쓰기가 훨씬 간결하고 자바빈즈보다 훨씬 안전하다.

 

출처

https://steady-coding.tistory.com/559