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

• 정적 팩터리 / 생성자의 제약 : 선택적 매개변수가 많을 때 적절히 대응하기 어렵다

ex) 식품 포장의 영양정보를 표현하는 클래스 - 20개가 넘는 선택 항목, 대다수의 값은 그냥 0 - 이런 경우 대응 어려움

• 이런 경우, 대부분의 프로그래머는 점층적 생성자 패턴을 즐겨 사용

점층적 생성자 패턴 : 필수 매개변수와 선택 매개변수 1개를 받는 생성자, 선택 매개변수를 2개까지 받는 생성자, ... 등의 형태로 선태 매개변수를 전부다 받는 생성자까지 늘려가는 방식

// 점층적 생성자 패턴 - 확장하기 어렵다
public class NutirionFacts {
	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 NutritioFacts(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 fact)
    	this(servingSize, servings, calories, fat, 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);

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

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

-- 코드를 읽을 때 각 값의 의미가 무엇인지 헷갈린다

-- 매개변수가 몇 개인지도 주의해서 세어 보아야 할 것

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

• 선택 매개변수가 많을 때 활용할 수 있는 두 번째 대안 : 자바빈즈 패턴 (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.setCaories(100);
cocaCola.setSodium(35);
cocaCola.setCarbohydrate(27);

• 자바빈즈 패턴의 단점

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

-- 점층적 생성자 패턴에서는 매개변수들이유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있었는데, 그 장치가 완전히 사라졌다.자바빈즈 패턴에서는 클래스를 불변을 만들 수 없으며

-- 일관성이 깨진 객체 생성 때문에 버그가 발생할 수 있고, 디버깅이 만만치 않다.

-- 이러한 문제 때문에 자바빈즈 패턴에서는 클래스를 불변으로 만들 수 없으며 스레드 안전성을 얻으려면 프로그래머가 추가 작업을 해줘야만 한다.

--> 단점 완화를 위해 생성이 끝난 객체를 수동으로 얼리고 (freezing) 얼리기 전에는 사용할 수 없도록 하기도 된다.

but, 어려워서 실전에서는 거의 쓰이지 않는다. 이 방법을 쓰려면, ,객체 사용 전에 프로그래머가 freeze 메서드를 확실히 호출해줬는지를 컴파일러가 보증할 방법이 없어서 런타임 오류에 취약

• 세 번째 대안 : 빌더 패턴 (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(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 = var;
            return this;
        }
        
        public Builder carbohydrate(int val) {
        	carbohydrate = val;
            return 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 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식(invarient)를 검사.

• 공격에 대비해 이러한 불변식을 보장하려면 빌더로부터 매개변수를 복사한 후 해당 객체 필드들도 검사해야 함.
  --> 잘못된 점을 발견하면 어떤 매개변수가 잘못되었는지를 자세히 알려주는 IllegalArgumentException 사용

불변(immutable / immutability) : 어떠한 변경도 허용하지 않는다
-- 변경을 허용하는 가변(mutable) 객체와 구분하는 용도로 사용
-- ex) String 객체 - 한번 만들어지면 절대 값을 바꿀 수 없는 불변 객체


불변식(invarient) : 프로그램이 실행되는 동안, 혹은 정해진 기간 동안 반드시 만족해야 하는 조건
-- 변경을 허용할 수는 있으나 주어진 조건 내에서만 허용


가변 객체에도 불변식은 존재할 수 있으며, 넓게 보면 불변은 불변식의 극단적인 예시4

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

// 계층적으로 설계된 클래스와 잘 어울리는 빌더 패턴
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();
        
        // 하위 클래스는 이 메서드를 재정의(Overridng) 하여 "this"를 반환하도록 해야 한다.
        protected abstract T self(); // 추상 메서드
	}
    
    Pizza(Builder<?> builder) {
   		toppings = builder.toppings.clone();
   	}
}

// enum : 열거 타입 : 서로 연관된 상수의 집합을 저장하는 자료형
// EnumSet : enum 클래스로 작동하기 위해 특화된 Set 컬렉션(데이터를 중복 저장할 수 없고, 순서가 보장되지 않는 자료구조)
// EnumSet. noneOf (Class elementType) : 지정된 요소형을 사용해 빈 상태(empty)의 enum 세트를 작성
// Objects.requireNonNull() : non-null을 표시하는 역할
-- 사용 이유 : explicity (명시성) / fail fast (빠른 실패)
-- 관련 이론 : https://velog.io/@rockpago/Objects.requireNonNull

• Pizza.Builder 클래스는 재귀적 타입 한정을 이용하는 제네릭 타입
  -- 추상 메서드인 self를 더해 하위 클래스에서 형변환을 하지 않고도 메서드 연쇄를 지원 할 수 있다.

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

// 뉴욕 피자
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; // 기본값
        
        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) : 하위클래스의 메서드가 하위 타입을 반환하는 기능
  -- 이 기능을 이용하여 클라이언트가 형변환에 신경 쓰지 않고도 빌더를 사용하게 할 수 있다.

// Client Code
NyPizza pizza = new NyPizza.Builder(SMALL).addTopping(SAUSAGE).addToping(ONION).build();
Calzone.Builder().addToping(HAM).sauceInside().build();

• 빌더 이용 시, 가변인수(varags) 매개변수를 여러 개 사용할 수 있다. - 생성자는 누릴 수 없는 이점
  -- 각각을 적절한 메서드로 나누어 선언하면 된다. 또는, 메서드를 여러 번 호출하도록 하고 각 호출 때 넘겨진 매개변수들을 하나의 필드로 모을 수도 있다.
  ex) 위의 계층적 빌더 패턴 코드의 addToping 메서드가 이렇게 구현함

• 빌더 패턴은 유연하다. : 빌더 하나로 여러 객체를 순회하면서 만들 수 있고, 빌더에 넘기는 매개변수에 따라 다른 객체를 만들 수도 있다.

• 빌더 패턴의 단점
  -- 객체를 만들려면 빌더부터 만들어야 한다. --> 이는 성능에 민감한 상황에 문제가 될 수 있다.
  -- 코드가 장황해서 매개변수가 4개 이상은 되는게 좋다.

생성자나 정적 팩터리가 처리해야 할 매개변수가 많다면 빌더 패턴을 선택하는 게 더 낫다.

매개변수 중 다수가 필수가 아니거나 같은 타입일 경우 더욱 빌더 패턴이 낫다.
빌더는 점층적 생성자보다 클라이언트 코드를 읽고 쓰기 훨씬 간결하고, 자바빈즈보다 훨씬 안전하다.