이펙티브 자바(Effective Java) 아이템 2 - 생성자에 매개변수가 많다면 빌더를 고려하라

 

 

 

점층적 생성자 패턴(Telescoping constructor pattern)

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 nutritionFacts = new NutritionFacts(240, 8, 100, 0, 35, 27);

• 필수 매개변수와 선택 매개변수를 받는 생성자를 점차 늘려가는 방식이다. 지속적으로 매개변수가 늘어나기에 코드의 관리가 점점 어려워진다.

• 생성자에 매개변수가 많아지는 경우, 사용자가 설정하길 원치 않는 매개변수까지 포함되는 상황이 발생한다. 또한 인스턴스를 만들기도 어려워진다.

 

자바빈즈 패턴(JavaBeans pattern)

public class NutritionFacts {
    // 매개변수들은 (기본 값이 있다면) 기본값으로 초기화 된다.
    private int servingSize = -1; // (ml, 1회 제공량) 필수; 기본 값 없음
    private int servings = -1; // (회, 총 n회 제공량) 필수; 기본 값 없음
    private int calories = 0; // (1회 제공량당) 선택
    private int fat = 0; // (g/1회 제공량) 선택
    private int sodium = 0; // (mg/1회 제공량) 선택
    private int carbohydrate = 0; // (g/1회 제공량) 선택

    public void setServingSize(int servingSize) {
        this.servingSize = servingSize;
    }

    public void setServings(int servings) {
        this.servings = servings;
    }

    public void setCalories(int calories) {
        this.calories = calories;
    }

    public void setFat(int fat) {
        this.fat = fat;
    }

    public void setSodium(int sodium) {
        this.sodium = sodium;
    }

    public void setCarbohydrate(int carbohydrate) {
        this.carbohydrate = carbohydrate;
    }
}

//이 클래스의 인스턴스를 만들려면 기본 생성자로 만들고 원하는 매개변수를 세터로 설정해준다.
NutritionFacts nutritionFacts = new NutritionFacts();
nutritionFacts.setServingSize(240);
nutritionFacts.setServings(8);
nutritionFacts.setCalories(100);
nutritionFacts.setSodium(35);
nutritionFacts.setCarbohydrate(27);

• 매개변수가 없는 생성자로 객체를 만든 후, 세터 메서드들을 호출해 매개변수의 값을 설정하는 방식이다.

• 점층적 생성자 패턴에서 발생하던 문제는 보이지 않으나 객체 하나를 만들려면 메서드를 여러 개 호출해야하고 객체가 완전히 생성되기 전까지는 일관성이 무너진 상태에 놓이게 된다.

• 점층적 생성자 패턴에서는 매개변수들이 유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있었는데 자바빈즈 패턴에서는 일관성이 깨진 객체로 인하여 런타임에 문제가 발생할 수 있다.

 

빌더 패턴(Builder pattern)

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;

    //빌더 클래스에서 설정된 값으로 객체생성
    private NutritionFacts(Builder builder) {
        this.servingSize = builder.servingSize;
        this.servings = builder.servings;
        this.calories = builder.calories;
        this.fat = builder.fat;
        this.sodium = builder.sodium;
        this.carbohydrate = builder.carbohydrate;
    }

    public static class Builder {
        //필수 매개변수
        private final int servingSize; // (ml, 1회 제공량) 필수; 기본 값 없음
        private final int servings; // (회, 총 n회 제공량) 필수; 기본 값 없음
        //선택 매개변수는 기본 값으로 초기화한다.
        private int calories = 0; // (1회 제공량당) 선택
        private int fat = 0; // (g/1회 제공량) 선택
        private int sodium = 0; // (mg/1회 제공량) 선택
        private int carbohydrate = 0; // (g/1회 제공량) 선택

        public Builder(int servingSize, int servings) {
            this.servingSize = servingSize;
            this.servings = servings;
        }

        public Builder calories(int calories) {
            this.calories = calories;
            return this;
        }

        public Builder fat(int fat) {
            this.fat = fat;
            return this;
        }

        public Builder sodium(int sodium) {
            this.sodium = sodium;
            return this;
        }

        public Builder carbohydrate(int carbohydrate) {
            this.carbohydrate = carbohydrate;
            return this;
        }

        public NutritionFacts build() {
            return new NutritionFacts(this);
        }
    }
}
//이 클래스의 인스턴스를 만들려면 빌더에서 값을 설정한 후, build 메서드를 통해서 객체를 생성한다.
NutritionFacts cocaCola = new NutritionFacts.Builder(240, 8)
                .calories(100)
                .sodium(35)
                .carbohydrate(27)
                .build();

• 점층적 생성자 패턴의 안전성과 자바빈즈 패턴의 가독성을 겸비한 패턴이다.

• 클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자(혹은 정적 팩토리)를 호출해 빌더 객체를 얻는다. 그런 다음 빌더 객체가 제공하는 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정한다. 마지막으로 build 메서드를 호출해 실제로 필요한 객체를 얻는 방식이다.

• 빌더를 이용하면 가변 인수 매개변수를 여러 개 사용할 수 있다.

• 빌더 생성 비용이 크지는 않지만 성능에 민감한 상황에서는 문제가 될 수 있다. 객체를 만들려면 빌더 부터 만들어야 하기 때문이다.

• 또한 점층적 생성자 패턴보다는 코드가 장황해서 매개변수가 4개 이상은 되어야 값어치를 한다. 하지만 API는 시간이 지날수록 매개변수가 많아지는 경향이 있기에 처음부터 빌더 패턴으로 시작하는 편이 좋은 경우가 많다.

 

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

 

 

참고

조슈아 블로크, 이복연 옮김, 이펙티브 자바 EFFECTIVE JAVA 3/E, 프로그래밍 인사이트