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

아이템 1 의 정적 팩터리 메서드와 생성자에는 똑같은 제약이 하나 있습니다.

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

 

만약 식품의 영양 정보를 저장하는 클래스는 다음과 같은 인자가 필요할것입니다.,

• 1회 내용량
• 총 n회 제공량
• 1회 제공량당 칼로리
• 열량
• 탄수화물
• 단백질
• 지방
• 트랜스지방
• 포화지방
• 콜레스테롤
• 나트륨
• 등등

많은 선택 항목이 생기는데 대부분 제품은 이 선택 항목이 그냥 0인 경우가 많습니다.

이미지 출처 https://news.sbs.co.kr/news/endPage.do?news_id=N1003082386

 

식품의 영양 정보 클래스의 생성자 혹은 정적 팩터리 메서드는 어떤 모습일까요?

이런 상황에 점층적 생성자 패턴 (telescoping constructor pattern)을 즐겨 사용했습니다.

 

---

점층적 생성자 패턴(Telescoping Constructor Pattern)

점층적 생성자 패턴이란?

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

아래는 점층적 생성자 패턴의 예시입니다.

package item2_20210418;

public class TelescopingConstructorPatternEx1 {

}

class NutritionFacts {
    private final int servingSize;      // ml, 1회 제공량   - 필수
    private final int servings;         // 회, 총 n회 제공량 - 필수
    private final int calories;         // 1회 제공량당 열량  - 선택
    private final int fat;
    private final int sodiun;
    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 sodiun) {
        this(servingSize, servings, calories, fat, sodiun, 0);
    }


    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodiun, int carbohydrate) {
        this.servingSize = servingSize;
        this.servings = servings;
        this.calories = calories;
        this.fat = fat;
        this.sodiun = sodiun;
        this.carbohydrate = carbohydrate;
    }
}

 

보통 이런 클래스의 생성자는 사용자가 원치 않는 매개변수 까지 포함하기 쉽습니다.

예를 들어 servingSize, servings, carbohydrate 3개의 매개변수만 값을 넣어주고 나머지는 0으로 만들고싶은데

해당하는 생성자가 없기때문에 모든 매개변수에 값을 지정해줘야 합니다.

 

NutritionFacts something = new NutritionFacts(240, 8, 0, 0, 0, 27);

 

지금은 겨우 6개의 매개변수뿐이지만 매개변수가 더 많아지면 생성자를 호출하는 쪽에서 코드를 작성하기 어렵거나 읽기가 어렵습니다.

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

생성자에 매개변수의 개수가 많으면 코드를 읽을 때 각 값의 의미가 무엇인지 헷갈릴 것이고, 매개변수가 몇 개인지도 주의해서 세어보아야 할것입니다. ex) 매개변수에 10개의 값을 다 지정했는지 하나씩 세어본다.

 

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

-> 만약 생성자를 호출하는 쪽에서 매개변수의 순서를 바꿔서 보내주면 데이터가 바뀐 상태인데 컴파일러는 눈치채지 못한 상태로 실행이 됩니다. 결국 런타임에 엉뚱한 동작을 하게됩니다.

 

다음은 선택 매개변수가 많을 때 활용할 수 있는 자바빈즈 패턴(JavaBeans Pattern)에 대해 보겠습니다.

 

---

자바빈즈 패턴(JavaBeans Pattern)

매개변수가 없는 생성자로 객체를 먼저 생성하고 Setter 메서드들을 활용해서 원하는 매개변수의 값을 설정하는 방식입니다.

아래는 식품의 영양정보 클래스에 자바빈즈 패턴을 적용시킨 예제입니다.

package item2_20210418;

public class JavaBeansPatternEx1 {

    public static void main(String[] args) {
        JavaBeansNutritionFacts nutritionFacts = new JavaBeansNutritionFacts();

        nutritionFacts.setServingSize(240);
        nutritionFacts.setServings(10);
        nutritionFacts.setCalories(390);
        nutritionFacts.setFat(10);
        nutritionFacts.setSodiun(35);
        nutritionFacts.setCarbohydrate(27);
    }
}

class JavaBeansNutritionFacts {
    private int servingSize = -1;      // ml, 1회 제공량   - 필수 기본값이 존재하지 않으므로 -1로 초기화
    private int servings = -1;         // 회, 총 n회 제공량 - 필수 기본값이 존재하지 않으므로 -1로 초기화
    private int calories = 0;         // 1회 제공량당 열량  - 선택
    private int fat = 0;
    private int sodium = 0;
    private int carbohydrate = 0;

    public JavaBeansNutritionFacts() {
    }

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

    public void setCarbohydrate(int carbohydrate) {
        this.carbohydrate = carbohydrate;
    }
}

 

 

점층적 생성자 패턴에서 보이던 단점(매개변수의 순서를 헷갈린다, 개수를 헷갈린다 등등)이 자바빈즈 패턴에서는 보이지 않습니다.

하지만 자바빈즈 패턴에도 단점이 있습니다.

• 자바빈즈 패턴에서는 객체 하나를 만들려면 메서드를 여러개 호출해야 합니다.
• 객체가 완전히 생성되기 전까지는 일관성(consistency)이 무너진 상태에 놓이게 됩니다.
• 일관성이 무너진 상태이기 때문에 자바빈즈 패턴에서는 클레스를 불변으로 만들 수 없습니다.
  • 따라서 스레드 안정성을 얻으려면 프로그래머가 추가 작업을 해줘야합니다.

---

빌더 패턴 (Builder Pattern)

점층적 생성자의 안정성(일관성)과 자바빈즈 패턴의 가독성을 겸비한 것이 빌더패턴입니다.

빌더패턴은 클라이언트는 필요한 객체를 직접 만드는 대신, 아래와 같은 과정으로 객체의 인스턴스를 생성합니다.

• 필수 매개변수만으로 생성자(혹은 정적 팩터리)를 호출해 빌더 객체를 얻습니다.
• 그런다음 빌더 객체가 제공하는 일종의 Setter메서드들로 선택 매개변수들을 설정합니다.
• 마지막으로 build 메서드를 호출해서 객체의 인스턴스를 얻습니다.

빌더는 생성할 클래스 안에 정적 멤버 클래스(static Class)로 만들어두는 게 일반적입니다. 

아래는 식품의 영양 정보 클래스의 생성을 빌더 패턴을 사용하는 예입니다.

package item2_20210418;

public class BuilderPatternEx1 {
    public static void main(String[] args) {
        BuilderNutritionFacts nutritionFacts = new BuilderNutritionFacts
                .Builder(240, 10)
                .calrories(80)
                .fat(10)
                .sodium(35)
                .carbohydrate(27)
                .build();
    }
}


class BuilderNutritionFacts {
    private final int servingSize;      // ml, 1회 제공량   - 필수 기본값이 존재하지 않으므로 -1로 초기화
    private final int servings;         // 회, 총 n회 제공량 - 필수 기본값이 존재하지 않으므로 -1로 초기화
    private final int calories;         // 1회 제공량당 열량  - 선택
    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;
        private int fat;
        private int sodium;
        private int carbohydrate;

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

        public Builder calrories(int value) {
            this.calories = value;
            return this;
        }

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

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

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

        public BuilderNutritionFacts build() {
            return new BuilderNutritionFacts(this);
        }
    }

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

 

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

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

연쇄적 호출을 이용한 빌더 패턴 호출

=> BuilderNutritionFacts cocaCola =
new BuilderNutritionFacts.Builder(240,10)
.calrories(80)
.fat(10)
.sodium(75)
.carbohydrate(35)
.builder();

이런 방식을 메서드 호출이 물 흐르듯 연결된다는 뜻으로 플루언트 API(Fluent API) 또는 메서드 연쇄(method chaining)라 합니다.
빌더 패턴은 (파이썬과 스칼라에 있는) 명명된 선택적 매개변수(named optional parameters)를 흉내낸 것입니다.

 

잘못된 매개변수를 최대한 일찍 발견하려면

빌더의 생성자와 메서드에서 입력 매개변수를 검사하고

builder 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식(invariant)을 검사합니다. 

-> 불변식을 보장하려면 빌더로부터 매개변수를 복사한 후 해당 객체 필드들도 검사해야 합니다.(아이템 50. 적시에 방어적 복사본을 만들어라)

검사 중 잘못된 점을 반견하면 어떤 매개변수가 잘못되었는지를 알려주는 메세지와 함께 IllegalArgumentException을 던지면 됩니다.

---

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

각 계층의 클래스에 관련 빌더를 멤버로 정의합니다.

• 추상 클래스는 추상 빌더를 갖게합니다.
• 구체 클래스(concrete class)는 구체 빌더를 갖게 합니다.

다음은 Pizza 클래스와 하위 클래스 NewYorkPizza, CalzonePizza 의 예제입니다.

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

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

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

 

package item2_20210418;

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

public class BuilderPatternEx2 {
}

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 참조
    }
}

class NewYorkPizza 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 NewYorkPizza build() {
            return new NewYorkPizza(this);
        }

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

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

class CalzonePizza 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 CalzonePizza build() {
            return new CalzonePizza(this);
        }

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

    private CalzonePizza(Builder builder) {
        super(builder);
        sauceInside = builder.sauceInside;
    }
}

 

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

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

 

다음은 Pizza 하위 클래스의 인스턴스를 생성하는 코드입니다. 식품 영양정보 클래스의 인스턴스를 생성하는 Builder 를 사용하는 코드와 다르지 않습니다.

• NewYorkPizza newYorkPizza = new NewYorkPizza.Builder(SMALL),addTopping(SAUSAGE).addTopping(ONION).build();
• CalzonePizza calzonePizza = new CalzonePizza.Builder().addTopping(HAM).sauceInside().build();

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

 

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

---

빌더 패턴의 단점

객체를 만들려면, 그에 앞서 빌더부터 만들어야 한다는 것은 빌더 패턴의 단점이 될 수 있습니다.

 

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

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

하지만 API는 시간이 지날수록 매개변수가 많아지는 경향이 있으므로 시작부터 빌더패턴을 사용하는게 좋은 선택이 될 수 있습니다.