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

이펙티브 자바(출처: yes24)

정적 팩토리와 생성자에 선택적 매개변수가 많을 때 적절히 대응하기 어렵다

정적 팩토리 메서드와 생성자의 공통된 제약 → 선택적 매개변수가 많을 때 적절히 대응하기 어려움

[예시] 식품 포장의 영양정보를 표현하는 클래스

• 영양정보
  • 필수항목: 1회 내용량, 총 n회 제공량, 1회 제공량당 칼로리 등
  • 선택항목: 총 지방, 트랜스지방, 포화지방, 콜레스테롤, 나트륨 등
    → 대부분 제품은 이 선택 항목 중 대다수의 값이 0

→ 프로그래머들은 이럴 때 점층적 생성자 패턴(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;
    }
}

• 이 클래스의 인스턴스를 만들려면 원하는 매개변수를 모두 포함한 생성자 중 가장 짧은 것을 골라 호출하면 된다.

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

• 사용자가 설정하길 원치 않는 매개변수까지 포함하기 쉬운데 어쩔 수 없이 그런 매개변수에도 값을 지정해줘야 한다.
  → 이 경우 지방(fat)에 0을 넘김 → 수가 더 늘어나면 걷잡을 수 없게 됨

---

단점

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

코드를 읽을 때 각 값의 의미가 무엇인지 헷갈릴 것이고, 매개변수가 몇 개인지도 주의해서 세어 보아야 할 것이다.

클라이언트가 실수로 매개변수의 순서를 바꿔 건네줘도 컴파일러는 알아채지 못하고, 결국 런타임에 엉뚱한 동작을 하게 된다(아이템 51).

---

자바빈즈 패턴(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() { }
	// 세터 메서드들
	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; }
}

장점

• 점층적 생성자  패턴의 단점들이 자바빈즈 패턴에서는 더 이상 보이지 않는다.
• 코드가 길어지긴 했지만 인스턴스를 만들기 쉽고, 그 결과 더 일기 쉬운 코드가 되었다.

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

단점

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

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

보완

• 이러한 단점을 완화하고자 생성이 끝난 객체를 수동으로 얼리고(freezing) 얼리기 전에는 사용할 수 없도록 하기로 함
  → 다루기 어렵고 런타임 오류에 취약해 실전에서 사용 X
• 세 번째 대안으로 점층적 생성자 패턴의 안전성과 자바빈즈 패턴의 가독성을 겸비한 빌더 패턴(Builder pattern) 등장

---

빌더 패턴(Builder pattern) - 점층적 생성자 패턴의 안전성 + 자바빈즈 패턴의 가독성

특징

• 클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자(혹은 정적 팩토리)를 호출해 빌더를 얻는다.
• 그다음 빌더 객체가 제공하는 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정한다.
• 마지막으로 매개변수가 없는 build 메서드를 호출해 필요한(보통은 불변인) 객체를 얻는다.
• 빌더는 생성할 클래스 안에 정적 멤버 클래스로 만들어두는 게 보통이다.

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

• NutritionFacts 클래스는 불변
• 모든 매개변수의 기본값들을 한곳에 모아둠
• 빌더의 세터 메서드들은 빌더 자신을 반환 → 연쇄적으로 호출 가능
  → 메서드 연결이 흐르듯 연결된다 → 플루언트 API(fluent API) 또는 메서드 연쇄(method chaining)라 부름.

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

• 쓰기 쉽고 읽기 쉽다.
• 빌더 패턴은 (파이썬과 스칼라에 있는) 명명된 선택적 매개변수(named optional parameters)를 흉내낸 것
• 잘못된 매개변수를 최대한 일찍 발견하려면?
  • 빌더의 생성자와 메서드에서 입력 매개변수를 검사
  • build 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식(invariant)을 검사
• 공격에 대비해 이런 불변식을 보장하려면 빌더로부터 매개변수를 복사한 후 해당 객체 필드들도 검사해야 한다(아이템 50).
• 검사 후 잘못된 점을 발견 시 어떤 매개변수가 잘못되었는지를 자세히 알려주는 메세지를 담아 IllegalArgumentException을 던지면 된다(아이템 75).

불변(immutable 또는 immutability)이란?
의미: 어떠한 변경도 허용하지 않는다.
용도: 변경을 허용하는 가변(mutable) 객체와 구분하는 용도
[예시] String 객체는 한번 만들어지면 절대 값을 바꿀 수 없는 불변 객체

불변식(invariant)이란?
의미: 프로그램이 실행되는 동안(혹은 정해진 기간 동안) 반드시 만족해야 하는 조건. 변경을 허용할 수는 있으나 주어진 조건 내에서만 허용한다는 듯
[예시 1] 리스트의 크기는 반드시 0 이상이어야 하니, 만약 한순간이라도 음수 값이 된다면 불변식이 깨진 것
[예시 2] Period 클래스에서 start 필드의 값은 반드시 end 필드의 값보다 앞서야 하므로, 두 값이 역전되면 불변식이 깨진 것
(아이템 50 참조)
따라서 가변 객체에도 불변식은 존재할 수 있으며, 넓게 보면 불변은 불변식의 극단적인 예라고 할 수 있다.

---

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

• 각 계층의 클래스에 관련 빌더를 멤버로 정의하자.
• 추성 클래스는 추상 빌더, 구체 클래스(concrete class)는 구체 빌더를 갖게 한다.

[예시] 피자의 다양한 종류를 표현하는 계층구조의 루트에 놓인 추상 클래스

public abstract class Pizza {
    public enum Topping {HAM, MUSHROOM, ONION, PEPPER, SAUSAUGE}
    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 타입이 없는 자바를 위한 이 우회 방법을 시뮬레이트한 셀프 타입(simulate self-type) 관용구라 함

---

Pizza의 하위 클래스 - 일반적인 뉴욕 피자

• 뉴욕 피자는 크기(size) 매개변수를 필수로 받는다.

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

---

칼초네 피자

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

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

• 각 하위 클래스의 빌더가 정의한 build 메서드는 해당하는 구체 하위 클래스를 반환하도록 선언
  • NyPizza.Builder는 NyPizza 반환
  • Calzone.Builder는 Calzone를 반환
• 공변 반환 타이핑(covariant return typing)이란?
  • 하위 클래스의 메서드가 상위 클래스의 메서드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능
  • 이 기능 이용 시 클라이언트가 형변환에 신경 쓰지 않고도 빌더 사용 가능

[예시] 클라이언트측 코드

• 열거 타입 상수를 정적 임포트했다고 가정

public class Main {
    NyPizza pizza = new NyPizza.Builder(SMALL)
            .addTopping(SAUSAUGE).addTopping(ONION).build();
    Calzone calzone = new Calzone.Builder()
            .addTopping(HAM).sauceInside().build();
}

• 생성자로는 누릴 수 없는 사소한 이점으로 빌더를 이용하면 가변인수(varargs) 매개변수를 여러 개 사용 가능
• 각각을 적절한 메서드로 나눠 선언하면 된다.
• 또는 메서드를 여러 번 호출하도록 하고 각 호출 때 넘겨진 매개변수들을 하나의 필드로 모을 수도 있다. → 예) addTopping 메서드

---

빌더 패턴은 유연하다

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

---

빌더 패턴의 단점

• 객체를 만들려면 그에 앞서 빌더부터 만들어야 한다. 생성 비용이 크지 않지만 성능에 민감한 상황에서는 문제 발생 가능
• 점층적 생성자 패턴보다는 코드가 장황해서 매개변수가 4개 이상은 되어야 값어치를 한다.
  → API는 시간이 지날수록 매개변수가 많아지는 경향이 있음을 명심!

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

---

참고자료

이펙티브 자바 Effective Java 3/E - 조슈아 블로크 저/개앞맵시 역