ITEM 2 : 생성자에 매개변수가 많다면 빌더를 고려하라

 

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

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

 

생성자 패턴 1. 점층적 생성자 패턴

 

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

즉, 필수 인자를 받는 생성자를 정의한 후, 선택적 인자를 하나씩 추가해가며 정의하는 것이다.

 

package org.example.item02;

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

 

 

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

 

e.g. 지방 매개변수에 0을 넘기는 경우

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

 

• 매개변수가 겨우 6개뿐이라 그리 나빠보이지 않을 수 있지만, 매개변수가 더 늘어날 수록 클라이언트 코드를 작성하기 어려워지고, 가독성이 떨어진다.
• 클라이언트가 실수로 매개변수의 순서를 바꿔 건네줘도 컴파일러는 알아채지 못하고, 런타임에 엉뚱한 동작을 하게 된다(item 51)

 

생성자 패턴 2. JavaBeans Pattern

 

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

 

package org.example.item02;

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() {
    }
    // setter
    public void setServingSize(int val) { servingSize = val;}

    public void setServings(int val) { servings = val;}

    public void setCalories(int val) { this.calories = val;}

    public void setFat(int val) { this.fat = val;}

    public void setSodium(int val) { this.sodium = val;}

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

 

자바빈즈 패턴은 점층적 생성자 패턴의 단점을 보완해 인스턴스 생성이 쉽고, 더 가독성이 좋아졌다.

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

 

하지만, 자바빈즈 패턴에서는 객체 하나를 만드려면 메서드를 여러 개 호출해야하고, 객체가 완전히 생성되기 전까지는 일관성(consistency)이 무너진 상태에 있게 된다. 점층적 생성자 패턴에서는 매개변수들이 유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있었는데, 그 장치가 완전히 사라진 것이다.

 

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

 

일관성이 깨지므로 자바빈즈 패턴에서는 클래스를 불변으로 만들 수 없으며(item 17), 스레드 안정성을 얻으려면 개발자가 추가 작업을 해줘야한다. 이러한 단점을 보완하기 위해 freeze 메서드를 사용할 수 있으나, freeze 메서드를 확실히 호출해줬는지 컴파일러가 보증할 방법이 없어 런타임 오류에 취약하다.

 

생성자 패턴 3. Builder Pattern

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

 

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

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

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

        public Builder carbohydrate(int val) {
            this.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;
    }
}

 

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

그런 다음 빌더 객체가 제공하는 일종의 setter 메서드들로 원하는 선택 매개변수들을 설정한다. 마지막으로 매개변수가 없는 build()메서드를 호출해 드디어 우리에게 필요한 (보통은 불변인) 객체를 얻는다.

 

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

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

 

NutritionFacts 클래스는 불변이며, 모든 매개변수의 기본값들을 한곳에 모아뒀다, 빌더의 세터 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다. 이런 방식을 메서드 호출이 흐르듯 연결된다는 듯으로 fluent API or method chaining이라 한다.

 

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

 

불변 : 어떠한 변경도 허용하지 않는다. 대표적으로 String 객체는 한번 만들어지면 절대 값을 바꿀 수 없는 불변 객체
불변식 : 프로그램이 실행되는 동안(혹은 정해진 기간) 반드시 만족해야하는 조건을 말한다. 변경을 허용할 수 는 있으나, 주어진 조건 내에서만 허용한다는 뜻이다.

 

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

 

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

• 추상 클래스는 추상 빌더
• 구체 클래스는 구체 빌더

아래 코드는 피자의 다양한 종류를 표현하는 계층구조의 루트에 놓인 추상 클래스다

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

// Pizza 클래스는 계층적 빌더 패턴을 사용하여 피자 객체를 생성하는 예제이다.
public 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 생성자
    Pizza(Builder<?> builder) {
        toppings = builder.toppings.clone();  // Clone을 통해 불변성 유지 (Item 50 참조)
    }
}

 

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

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

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

import java.util.Objects;

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; // 필드 초기화
    }
}

// 칼초네 피자 클래스
public class Calzone extends Pizza {
    private final boolean sauceInside; // 속에 소스가 들어가는지 여부

    // 칼초네 피자를 생성하는 빌더 클래스
    public static class Builder extends Pizza.Builder<Builder> {
        private boolean sauceInside = false; // 소스 기본값은 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); // 부모 클래스의 생성자 호출
        this.sauceInside = builder.sauceInside; // 필드 초기화
    }
}

 

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

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

 

import static org.example.item02.NyPizza.Size.SMALL;
import static org.example.item02.Pizza.Topping.*;

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

 

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

• 각각을 적절한 메서드로 나눠 선언하면 된다.
• 메서드를 여러번 호출하도록 하고, 각 호출 때 넘겨진 매개변수들을 하나의 필드로 모을 수도 있다(e.g. addTopping())

 

빌더 패턴은 빌더 하나로 여러 객체를 만들 수 있고, 빌더에 넘기는 매개변수에 따라 다른 객체를 만들 수 있으므로 매우 유연하다.
하지만 객체를 만들려면, 그에 앞서 빌더부터 만들어야한다. 또한, 성능에 민감한 상황에서는 빌더 생성 비용이 문제가 될 수 있다. 또한 매개변수가 4개 이상이 되어야 값어치를 한다.
즉, 인자가 많은 생성자나 정적 팩터리가 필요한 클래스를 설계할 때, 대부분의 인자가 선택적 인자인 상황에 유용하다. 빌더는 점층적 생성자보다 간결하고, 자바빈즈보다 훨씬 안전하다.