[Effective_Java] Item 2 : 생성자에 매개변수가 많다면 빌더를 고려하라.

이전에 설명했던 정적 팩토리와 생성자에는 공통적인 제약이 존재합니다. 바로,

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

는 것입니다.

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

점층적 생성자 패턴

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

아래는 식품 포장의 영양정보를 표현하는 클래스입니다. 이때 점층적 생성자 패턴을 적용시켜 작성했습니다.

// 점층적 생성자 패턴 - 확장하기 어렵다!
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);
    }

}

하지만, 이 방식은

매개변수가 많아지면 클라이언트 코드를 작성하거나 읽기 어렵다.

는 명확한 단점이 존재합니다.

매개변수가 몇 개인지 주의해서 세어 보아야 하고, 타입이 같은 매개변수가 연달아 늘어서 있으면 찾기도 어려울 뿐더러, 실수로 순서를 바꿔 건네주면 엉뚱한 동작을 하거나 버그로 이어질 가능성이 매우 크기 때문이죠.

두 번째 대안으로는 자바빈즈 패턴(JavaBeans Pattern)이 있습니다.

자바빈즈 패턴(JavaBeans Pattern)

자바빈즈 패턴은,

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

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

이전의 점층적 생성자 패턴의 단점들은 보이지 않습니다.

하지만, 여기도 치명적인 단점이 존재합니다. 바로,

객체 하나를 만들기위해 메서드를 여러 개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성이 무너진 상태에 놓이게 된다.

는 것입니다. 이 때문에, 자바빈즈 패턴에서는 클래스를 불변으로 만들 수 없습니다.

이러한 모든 문제들을 해결하기 위해 점층적 생성자 패턴의 안전성과 자바빈즈 패턴의 가독성을 겸비한 빌더 패턴(Builder Pattern) 을 사용합니다.

빌더 패턴(Builder Pattern)

빌더 패턴(Builder Pattern)에선 다음과 같은 과정을 통해 객체를 얻습니다.

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

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

3. 매개변수가 없는 build 메서드를 호출해 필요한(보통은 불변인) 객체를 얻습니다.

빌더(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;

    // Builder -> 정적 맴버 클래스
    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;

        // 1번 과정 : 필수 매개변수만으로 생성자를 호출
        public Builder(int servingSize, int servings) {
            this.servingSize = servingSize;
            this.servings    = servings;
        }

        // 2번 과정 : Setter 메서드들로 원하는 선택 매개변수들을 설정
        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; }

        // 3번 과정 : 매개변수가 없는 build 메서드를 호출
        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();
    }
}

위 Builder의 setter 메서드들은 builder 자신을 반환(return this)하기 때문에 연쇄적으로 호출이 가능한 것입니다.

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

장점

이 빌더 패턴을 사용한 클라이언트 코드는

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

는 확실한 장점이 존재합니다. 또한, 객체마다 부여되는 일렬번호와 같은 특정 필드는 빌더가 알아서 채우도록 할 수도 있겠죠.

단점

하지만, 빌더 패턴에 장점만 있는 것은 아닙니다.
객체를 만들기 위해 그에 앞서 빌더부터 만들어야 합니다. 빌더 생성 비용이 크지는 않지만 성능에 민감한 상황에서는 문제가 될 수도 있겠죠.

💡정리

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