[effective java] item 2. 생성자에 매개변수가 많다면 빌더를 고려하라

정적 팩토리 메서드와 생성자의 제약 : 선택적 매개변수가 많을 때 대응하기가 어렵다.

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

 

식품 포장의 영양정보를 표현하는 클래스를 예시로 살펴봅시다.

영양정보는 1회 내용량, 총 n회 제공량, 1회 제공량 당 칼로리 같은 필수 항목 몇 개와 총 지방, 트랜스지방, 포화지방, 콜레스테롤, 나트륨 등 총 20개가 넘는 선택 항목으로 이뤄집니다. 그런데 대부분 제품은 이 선택 항목 중 대다수의 값이 그냥 0입니다. 

 

대안 1. 점층적 생성자 패턴(telescoping constructor pattern)

우선 먼저, 이런 클래스를 생성할 때, 점층적 생성자 패턴(telescoping constructor pattern) 을 사용해봅시다.

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

 

예시 - 점층적 생성자 패턴 : 확장하기가 어렵다 (p. 14~15)

public class NutritionFacts {
    private final int servingSize;  // (mL, 1회 제공량)     필수
    private final int servings;     // (회, 총 n회 제공량)  필수
    private final int calories;     // (1회 제공량당)       선택
    private final int fat;          // (g/1회 제공량)       선택
    private final int sodium;       // (mg/1회 제공량)      선택
    private final int carbohydrate; // (g/1회 제공량)       선택

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

 

호출

    public static void main(String[] args) {
        NutritionFacts cocaCola = new NutritionFacts(240, 8, 100, 0, 35, 27);
    }

 

문제점

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

• 사용자가 설정하길 원치 않는 매개변수에도 값을 지정해야 한다. (앞 코드에는 지방(fat)에 0을 넘겼다.)
• 코드를 읽을 때 각 값의 의미가 무엇인지 헷갈린다.
• 매개변수의 갯수를 주의깊게 세어보아야 한다. 
• 타입이 같은 매개변수가 연달아 있다면 찾기 어려운 버그로 이어질 수 있다. 클라이언트가 실수로 매개변수의 순서를 바꿔 건네줘도 컴파일러는 알아채지 못하고, 결국 런타임에 엉뚱한 동작을 하게 된다.

 

 

 

대안 2. 자바 빈즈 패턴(JavaBeans Pattern)

다음은 두 번째 대안인 자바빈즈 패턴(JavaBeans pattern)을 살펴봅시다.

매개변수가 없는 생성자로 객체를 만든 후, 세터(setter) 메서드들을 호출해 원하는 매개변수의 값을 설정하는 방식입니다.

 

예시 - 자바 빈즈 패턴 : 일관성이 깨진다, 불변으로 만들 수 없다. (p. 16)

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

 

호출

    public static void main(String[] args) {
        NutritionFacts cocaCola = new NutritionFacts();
        cocaCola.setServingSize(240);
        cocaCola.setServings(8);
        cocaCola.setCalories(100);
        cocaCola.setSodium(35);
        cocaCola.setCarbohydrate(27);
    }

 

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

 

문제점 - 일관성이 깨진다.

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

 

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

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

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

 

해결책? - freeze

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

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

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

 

 

 

대안 3. 빌더 패턴(Builder Pattern)

다행히 우리에겐 세 번째 대안이 있습니다.

점층적 생성자 패턴의 안전성과 자바 빈즈 패턴의 가독성을 겸비한 빌더 패턴(Builder Pattern)입니다.

다음과 같은 순서로 동작합니다.

1. 클라이언트는 필요한 객체를 직접 생성하는 대신, 필수 매개변수만으로 생성자(혹은 정적 팩토리)를 호출하여 빌더 객체를 얻는다. 
2. 빌더 객체가 제공하는 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정한다.
3. build 메서드를 호출하여 우리에게 필요한 (보통은 불변인) 객체를 얻는다.

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

예시를 살펴봅시다.

 

예시 - 빌더 패턴 : 점층적 생성자 패턴의 안정성 + 자바 빈즈 패턴의 가독성 (p.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)라 합니다. 
• 이 클라이언트 코드는 쓰기 쉽고, 무엇보다도 읽기 쉽습니다.

 

참고
빌더 패턴은 (파이썬과 스칼라에 있는) 명명된 선택적 매개변수(named optional parameters)를 흉내낸 것이다.

참고 매개변수 유효성 검사
잘못된 매개변수를 최대한 일찍 발견하려면 빌더의 생성자와 메서드에서 입력 매개변수를 검사하고, build 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식(invariant)을 검사하자.
공격에 대비해 이런 불변식을 보장하려면 빌더로부터 매개변수를 복사한 후 해당 객체 필드들도 검사해야 한다.
검새해서 잘못된 점을 발견하면 어떤 매개변수가 잘못되었는지를 자세히 알려주는 메시지를 담아 IllegalArgumentException을 던지면 된다.

참고 불변(immutable 혹은 immutability)
어떠한 변형도 허용되지 않는다는 뜻이다. 대표적으로 String 객체는 한번 만들어지면 절대 값을 바꿀 수 없는 불변 객체다.

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

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

 

 

빌더 패턴의 장점

1. 계층적으로 설계된 클래스와 함께 쓰기 좋다.

예시로 추상 클래스 pizza와 하위 클래스가 2개가 있습니다.

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

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

 

계층적으로 설계된 클래스와 잘 어울리는 빌더 패턴 (p. 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 클래스는 재귀적 타입 한정을 이용하는 제너릭 타입입니다. 
• 여기에 추상 메서드인 self를 더해 하위 클래스에서는 형변환을 하지 않고도 메서드 연쇄를 지원할 수 있습니다.
• self 타입이 없는 자바를 위한 이 우회 방법을 시뮬레이트한 셀프 타입(simulated self-type) 관용구라 합니다. 

 

뉴욕 피자 - 계층적 빌더를 활용한 하위 클래스 (p. 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 + "로 토핑한 뉴욕 피자";
    }
}

 

칼초네 피자 - 계층적 빌더를 활용한 하위 클래스 (p. 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.Builer는 Calzone를 반환합니다.
• 하위 클래스의 메서드가 상위 클래스의 메서드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변 반환 타이핑(covariant return typing)이라 합니다.
• 이 기능을 이용하면 클라이언트가 형변환에 신경쓰지 않고 빌더를 사용할 수 있습니다.

 

호출

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

• 앞선 영양정보 빌더를 사용하는 코드와 다르지 않습니다.
• 열거 타입 상수를 정적 임포트했다고 가정하고 작성했습니다.

 

 

2. 가변인수(varargs) 매개변수를 여러 개 사용할 수 있다.

이 부분은 이해가 가지 않는다...다시 공부해서 정리하기

 

정리

• 빌더 패턴은 상당히 유연합니다.
• 빌더 하나로 여러 객체를 순회하면서 만들 수 있습니다.
• 빌더에 넘기는 매개변수에 따라 다른 객체를 만들 수도 있습니다. 
• 객체마다 부여되는 일련번호와 같은 특정 필드는 빌더가 알아서 채우도록 할 수도 있습니다. 

 

 

빌더 패턴의 단점

• 객체를 만들기 전에 빌더부터 만들어야 합니다.  
  빌더 생성 비용이 크진 않지만, 성능에 민감한 상황에서는 문제가 될 수 있습니다. 
• 점층적 생성자 패턴보다 코드가 장황해서 매개변수가 4개 이상은 되어야 값어치를 합니다.
• 하지만, API는 시간이 지날수록 매개변수가 많아지는 경향이 있음을 명시합시다. 
• 생성자나 정적 팩토리 방식으로 시작했다가 나중에 매개변수가 많아지면 빌더 패턴으로 전환할 수도 있지만, 이전에 만들어준 생성자와 정적 팩토리가 아주 도드라져 보일 것입니다. 그러니 애초에 빌더로 시작하는 편이 나을 때가 많습니다.

 

 

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

 

 

---

출처

https://www.yes24.com/Product/Goods/65551284

이펙티브 자바 Effective Java 3/E - YES24