[이펙티브자바] Item 2. 생성자에 매개변수가 많다면 빌더를 고려하라

 

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

 

⛔ 기존 문제점

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

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

보통 필수 매개변수와 선택 매개변수가 있을 때 필수 매개변수와 선택 매개변수를 1개 받는 생성자, 2개 받는 생성자, 3개 받는 생성자 등의 형태로 선택 매개변수를 전부 다 받는 생성자까지 늘려가는 방식을 사용한다.

하지만 이런 생성자는 매개변수 개수가 많아지면

- 클라이언트 코드를 작성하거나 읽기 어렵고,

- 코드를 읽을 때 각 값의 의미가 무엇인지 헷갈리고,

- 매개변수가 몇 개인지 주의해서 세어보아야 하고,

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

 

🔎 첫 번째 대안, 자바빈즈 패턴 (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 carbogydrate= 0;
    
    public NutritionFacts() { }
    
    // setter method
    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 setCarbogydrate(int val){carbogydrate = val;}
}

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

 

💡 자바빈즈 패턴의 장점

코드가 길어지긴 했지만

1. 인스턴스를 만들기 쉽고,

2. 그 결과 더 읽기 쉬운 코드가 되었다.

 

💡 자바빈즈 패턴의 단점

1. 객체 하나를 만들려면 메서드를 여러 개 호출해야 하고,

2. 객체가 완전히 생성되기 전까지는 일관성이 무너진 상태에 놓이게 된다.

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

4. 이 처럼 일관성이 무너지는 문제 때문에 자바빈즈 패턴에서는 클래스를 불변으로 만들 수 없으며

5. 스레드 안전성을 얻으려면 프로그래머가 추가 작업을 해줘야 한다.

6. 따라서 생성이 끝난 객체를 수동으로 '얼리고(freezing)', 얼리기 전에는 사용할 수 없도록 하기도 하지만

6-1. 그럼에도 불구하고 객체 사용 전에 프로그래머가 freeze 메서드를 확실히 호출해줬는지를 컴파일러가 보증할 방법이 없다.

6-2. 따라서 런타임 오류에 취약하다.

 

🔎 두 번째 대안, 빌더 패턴(Builder pattern)

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

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

 

빌더 패턴의 흐름은 다음과 같다.

1. 클라이언트는 필수 매개 변수만으로 생성자를 호출해 빌더 객체를 얻는다.

2. 빌더 객체가 제공하는 세터 메서드들로 원하는 선택 매개변수들을 설정한다.

3. 매개변수가 없는 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 cocaCola = 
		new NutritionFacts.Builder(240, 8)
                .calories(100)
                .sodium(35)
                .carbohydrate(27)
                .build();

위와 같이 빌더 패턴으로 클래스를 작성하면

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

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

이런 방식을 플루언트 API(fluent API) 혹은 메서드 연쇄 (method chaining)라 한다.

 

이러한 빌더 패턴은

1. 클라이언트가 쓰기 쉽고, 읽기 쉽다.

2. 유효성 검사도 빌더의 생성자와 메서드에서 입력 매개변수를 검사하고, build 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식을 검사하면 잘못된 매개변수를 최대한 일찍 발견할 수 있다.

 

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

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

추상 클래스는 추상 빌더를, 구체 클래스는 구체 빌더를 갖게 한다.

 

재귀적 타입 한정을 이용하는 제네릭 타입의 클래스가 있다고 가정하자.

여기에 추상 메서드인 self를 더해 재정의하여 "this"를 반환하도록 한다.

public abstract class Pizza{
	...
    abstract static class Builder<T extends Builder<T>>{
    	...
        return self();
    }
    //하위 클래스는 이 메서드를 재정의(override)하여
    //"this"를 반환하도록 해야 한다.
    protected abstract T self();
    
    ...
}

그러면 하위 클래스에서는 형 변환하지 않고도 메서드 연쇄를 지원할 수 있다.

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

 

이 Pizza 클래스의 하위 클래스가 2개 있다.

두 개의 하위 클래스의 필수 매개변수가 다를 때는 다음과 같이 사용한다.

public class NyPizza extends Pizza{
	...
    
    public static class Builder extends Pizza.Builder<Builder>{
    	...
        @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{
	...
    
    public static class Builder extends Pizza.Builder<Builder>{
    	...
        @Override
        public Calzone build(){
        	return new Calzone(this);
        }
        @Override
        protected Builder self() { 
        	return this;
        }
    }   
   	private Calzone(Builder builder){
    	super(builder);
        sauceInside = builder.sauceInside;
    }
}

이처럼 하위 클래스의 빌더가 정의한 build 메서드는 해당하는 구체 하위 클래스를 반환하도록 선언한다.

하위 클래스의 메서드가 상위 클래스의 메서드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변 반환 타이핑(convariant return typing)이라 한다.

이 기능을 이용하면 클라이언트가 형 변환에 신경 쓰지 않고도 빌더를 사용할 수 있다.

 

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

클라이언트는 기존 빌드와 사용하는 방법이 다르지 않다.

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

 

👍 빌더 패턴의 장점

- 상당히 유연하다.

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

- 객체마다 부여되는 일련번호와 같은 특정 필드는 빌더가 알아서 채우도록 할 수도 있다.

 

👎 빌더 패턴의 단점

- 객체를 만들려면, 그에 앞서 빌더부터 만들어야 한다.

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

- 점층적 생성자 패턴보다는 코드가 장황해서 매개변수가 4개 이상은 되어야 가치 있다.

 

💡 정리!

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