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

저자 : 조슈아 블로크 / 출판사 : 인사이트(insight)

 

 

생성자나 정적 팩터리 메서드를 사용할 때 제약이 하나 있다.
선택적 매개변수가 많을 때 적절히 대응하기 어렵다는 점이다.

 

 

1. 점층적 생성자 패턴(telescoping constructor pattern)

 

식품 포장의 영양정보를 표현하는 클래스를 생각해보자.

 

영양정보는 소수의 필수항목과 다수의 선택항목으로 이뤄진다.

 

그런데 대부분 제품은 이 선택 항목중 대다수의 값이 그냥 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, fat, 0);
    }
    
    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium) {
    	this(servingSize, servings, fat, sodium, 0);
    }
    
    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium, int carbohydrate) {
    	this(servingSize, servings, fat, sodium, carbohydrate 0);
    }
}

 

점층적 생성자 패턴의 문제점은 사용자가 설정하기 원치 않는 매개변수까지도 값을 지정해줘야 한다는 것이다.

 

그리고 전달하는 매개변수의 의미도 무엇인지 헷갈리고 매개변수가 몇 개인지도 주의해서 세어보아야 한다.

 

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

 

이 예에서는 매개변수가 '겨우' 6개뿐이라 그리 나빠보이지 않을 수 있지만 수가 더 늘어나면 금세 걷잡을 수 없게 된다.

 

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

 

 

2. 자바빈즈 패턴(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() { }
    
    // 세터 메서드들
    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)이 무너진 상태에 놓이게 된다.

 

점층적 생성자 패턴에서는 매개변수들이 유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있었는데 그 장치가 완전히 사라진 것이다.

 

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

 

다행히 우리에겐 세 번째 대안이 있다.

 

점층적 생성자 패턴의 안전성과 자바 빈즈 패턴의 가독성을 겸비한 빌더 패턴(Builder Pattern) 이다.

 

3. 빌더 패턴(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 NutritionsFacts 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)를 흉내낸 것이다.

 

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

 

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

 

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

 

피자를 예로 든 코드를 살펴보자.

 

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();
        
        // 하위 클래스는 이 메서드를 재정의(overriding)하여
        // "this"를 반환하도록 해야 한다.
        protected abstract T self();
    }
    
    Pizza(Builder<?> builder) {
    	toppings = builder.toppings.clone();
    }
}

 

이제 Pizza 의 하위 클래스를 만들어보자.

 

뉴욕 피자는 크기(size) 매개변수를 필수로 받고 칼초네 피자는 소스를 안에 넣을지 선택(sauceInsice)하는 매개변수를 필수로 받는다.

 

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 를 반환한다는 뜻이다.

 

이러한 '계층적 빌더' 를 사용하는 클라이언트의 코드도 앞선 영양정보 빌더를 사용하는 코드와 다르지 않다.

 

아래는 클라이언트측 코드이다.

 

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

 

빌더는 유연하지만 단점도 있고 주의할 점도 있다.

 

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

 

하지만 API는 시간이 지날수록 매개변수가 많아지는 경향이 있음을 명심하자.

 

그러니 애초에 빌더로 시작하는 편이 나을 때가 많다.