[이펙티브 자바] 생성자에 매개변수가 많을 때 효율적인 해결 방법

 

정적 팩토리와 생성자에는 같은 제약이 있다.

선택적 매개변수가 많을 때는 적절한 대응이 어렵다는 것이다.

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

영양정보는 1회 내용량, n회 제공량, 1회당 칼로리 등등 20개가 넘는 선택항목이 있다.

하지만 대부분 제품은 이 선택 항목 중 대다수의 값이 0으로 설정된다.

 

이런 클래스의 생성자나 정적 팩토리에서는

기존적으로 점층적 생성자 패턴을 즐겨 사용했다.

필수 매개변수만 받는 생성자, 필수 매개 변수와 선택 매개변수를 1개 받는 생성자, 2개까지 받는 생성자 등등....

이런 형태로 매개 변수를 전부 다 받는 생성자까지 늘려가는 방식이다.

 

아래 클래스를 예시로 보자.

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 calories){
	this(servingSize,servings,calories,0);
}

...중략

public NutritionFacts(int servingSize,int calories, int servings, int fat,int sodium, int carbohydrate){
    this.servingSize = servingSize;
    this.calories = calories;
    this.servings = servings;
    this.sodium = sodium;
    this.carbohydrate = carbohydrate;
}

 

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

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

 

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

매개변수의 위치, 개수 등등 고려할 사항이 많다..! 

 

//자바 빈즈 패턴
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) { calories = val; } 
    public void setFat(int val) { fat = val; } 
    public void setSodium(int val) { sodium = val; } 
    public void setCarbohydrate(int val) { carbohydrate = val; } 
    
}

점층적 생성자 패턴의 단점들이 자바 빈즈에서는 잘 보이지 않는다.

코드가 길어지긴 했지만 인스턴스를 만들기 쉽고 그 결과 더 읽기 쉬은 코드가 되었다.

 

하지만, 자바빈즈만의 큰 단점이 있다.

자바빈즈 패턴에서는 객체 하나를 만들려면 메서드를 여러개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성이 무너진 상태가 된다. 점층적 생성자 패턴에서는 매개변수들이 유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있었는데 그 장치가 없어진 것이다. 이렇게 일관성이 깨진 객체가 만들어지면 버그를 심은 코드와 그 버그 때문에 런타임에 문제를 겪는 코드가 물리적으로 멀리 떨어져 있을 것이므로 디버깅도 만만치 않다.

 

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

이러한 단점을 완화하고자 생성이 끝난 객체를 수동으로 얼리고, 얼리기 전에는 사용할 수 없도록 하기도 하지만 이 방법은 다루기 어려워서 실전에서는 거의 쓰이지 않는다.

 

따라서 우리는 점층적 생성자 패턴의 안전성과 자바빈즈 패턴의 가독성을 겸비한 빌더패턴을 사용할 수 있다.

클라이언트는 필요한 객체를 직접 만드는 대신 필수 매개변수만으로 생성자를 호출해 빌더 객체를 얻는다.

그런 다음 빌더 객체가 제공하는 일종의 세터메서드로 선택 매개변수들을 설정한다.

 

마지막으로, 매개변수가 없는 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 caloies = 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 클래스는 불변이며, 모든 매개변수의 기본 값들을 한 곳에 모아 뒀다.

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

이런 방식을 메서드 호출이 흐르듯 연결된다는 뜻의  fluent API 혹은 method chaining 이라고 한다.

해당 클래스를 클라이언트에서 호출하는 예시를 보자.

 

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

클라이언트가 코드를 사용하기 쉽고, 가시성이 좋은 것을 알 수 있다.

위의 코드에서는 유효성 검사 코드가 생략됬지만, 실제 코드를 설계할 때는 유효한 매개변수를 받도록 검증 코드를 작성하도록 하자.

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

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

다양한 피자 종류를 표현하는 예시를 들어 보도록 하자.

 

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.topping.clone();
    }

}

여기서 Pizza.Builder 클래스는 재귀적 타입 한정을 이용하는 제네릭 타입이다.

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

 

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

하나는 일반적인 뉴욕피자이고, 다른 하나는 칼초네 피자다.

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

 

뉴욕피자

public class NyPizza extends Pizza{
    public enum Size{SMALL, MIDIUM, 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 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 이라고 한다. 이 기능을 이용하면 클라이언트가 형변환에 신경 쓰지 않고도 빌더를 사용할 수 있다.

 

이러한 계층적 빌더를 사용하는 예시를 보자.

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

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

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

 

 

 

 

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

 

 

참고 : 이펙티브 자바 Effective Java 3/E