[Effective Java] 2장 객체 생성과 파괴 - 아이템 2. 생성자에 매개변수가 많다면 빌더를 고려하라

배상규·2023년 9월 13일
0

이펙티브 자바

목록 보기
2/12
post-thumbnail

점층적 생성자 패턴

정적 팩터리와 생성자에는 선택적 매개변수의 수가 많을 때 대응하기가 어렵다. 이럴 때 점증적 생성자 패턴을 사용할 수 있다.

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, 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;
    }

    public NutritionFacts(int servingSize, int servings) {
        this(servingSize, servings, 0, 0, 0, 0);
    }

    public NutritionFacts(int servingSize, int servings, int calories) {
        this(servingSize, servings, calories, 0, 0, 0);
    }

    public NutritionFacts(int servingSize, int servings, int calories, int fat) {
        this(servingSize, servings, calories, fat, 0, 0);
    }

    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium) {
        this(servingSize, servings, calories, fat, sodium, 0);
    }
}

하지만 매개변수 개수가 많아지면 클라이언트 코드를 작성하거나 읽기가 매우 어렵다.


자바 빈즈 패턴

public class NutritionFactsWithJavaBeansPattern {

    private int servingSize = -1; // 필수. 기본 값 없음.

    private int servings = -1; // 필수. 기본 값 없음.

    private int calories;

    private int fat;

    private int sodium;

    private int carbohydrate;

    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;
    }
}

자바빈즈 패턴은 매개변수가 많더라도 인스턴스를 쉽게 만들 수 있다. 하지만 setter 메서드를 통한 반복적인 메서들 호출과, 객체가 온전히 완성되지 않았다면 일관성이 깨질 수 있다. 이는 클래스를 불변으로 만들 수 없는 문제가 생긴다.


빌더 패턴

점층적 생성자 패턴의 안전성과 자바 빈즈 패턴의 가독성을 겸비한 빌더 패턴을 주로 사용한다. 클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수 만으로 생성자를 호출해 빌더 객체를 얻는다. 이후 빌더 객체가 제공하는 세터 메서드들로 원하는 선택 매개변수를 설정하고, 매개변수가 없는 build() 메서드를 호출해 필요한 객체를 얻는다.

public class NutritionFactsWithBuilderPattern {

    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 NutritionFactsWithBuilderPattern(Builder builder) {
        servingSize = builder.servingSize;
        servings = builder.servings;
        calories = builder.calories;
        fat = builder.fat;
        sodium = builder.sodium;
        carbohydrate = builder.carbohydrate;
    }

    public static class Builder {

        private final int servingSize;

        private final int servings;

        private int calories;

        private int fat;

        private int sodium;

        private int carbohydrate;

        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) {
            calories = val;
            return this;
        }

        public NutritionFactsWithBuilderPattern build() {
            return new NutritionFactsWithBuilderPattern(this);
        }
    }
}

NutritionFactsWithBuilderPattern 클래스는 불변하며, Builder의 Setter 메서들은 빌더 자신을 반환하기 때문에 연쇄적 호출이 가능하다. 이런 방식은 API 혹은 메서드 연쇄라고 한다.

NutritionFactsWithBuilderPattern nutritionFacts = 
    new NutritionFactsWithBuilderPattern.Builder(240, 8)
        .calories(100)
        .sodium(35)
        .build();

클러이언트는 빌더 패턴을 통해 코드를 읽기,쓰기 작업들을 편하기할 수 있다.


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

public abstract class Pizza {

    public enum Topping {
        HAM, MUSHROOM, ONION, PEPPER, SAUSAGE
    }

    final Set<Topping> toppings;

    Pizza(Builder<?> builder) {
        toppings = builder.toppings.clone();
    }

    abstract static class Builder<T extends Builder<T>> {

        private EnumSet<Topping> toppings = EnumSet.noneOf(Topping.class);

        public T addTopping(Topping topping) {
            toppings.add(topping);
            return self();
        }

        abstract Pizza build();

        protected abstract T self();
    }
}

Pizza.Bulder 클래스는 재귀적 타입 한정을 이용하는 제네릭 타입이다. 추상 메서드인 self를 더해 하위 클래스에서는 형변환하지 않고도 메서드를 연쇄를 지원할 수 있다. 하위 클래스에서는 이 추상 메서드의 반환값을 자기 자신을 주면 된다.
Pizza를 상속받는 뉴욕 피자와 칼초네 피자를 보며 좀더 살펴보자

public class NyPizza extends Pizza {

    public enum Size {
        SMALL, MEDIUM, LARGE
    }

    private final Size size; // 필수 매개변수

    private NyPizza(Builder builder) {
        super(builder);
        size = builder.size;
    }

    public static class Builder extends Pizza.Builder<Builder> {

        private final Size size;

        public Builder(Size size) {
            this.size = size;
        }

        @Override
        NyPizza build() {
            return new NyPizza(this);
        }

        @Override
        protected Builder self() {
            return this;
        }
    }

}
public class CalzonePizza extends Pizza {

    private final boolean sauceInside; // 선택 매개변수

    private CalzonePizza(Builder builder) {
        super(builder);
        sauceInside = builder.sauceInside;
    }

    public static class Builder extends Pizza.Builder<Builder> {

        private boolean sauceInside = false;

        public Builder sauceInside() {
            sauceInside = true;
            return this;
        }

        @Override
        CalzonePizza build() {
            return new CalzonePizza(this);
        }

        @Override
        protected Builder self() {
            return this;
        }
    }
}

각 하위 클래스의 빌더가 정의한 build()를 통해 하위 클래스를 반환하고 있다. NYPizza.builder는 NyPizza를 반환하고, Calzone.Builder는 Calzone 피자를 반환하다는 것이다. 하위 메서드가 상위 클래스의 메서가 반환한 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변 반환 타이핑이라고 한다. 이 기능 사용하면 클라이언트가 형변환을 할 필요가 없다.

NyPizza nyPizza = new NyPizza.Builder(Size.SMALL)
    .addTopping(Topping.SAUSAGE).addTopping(Topping.ONION).build();

CalzonePizza calzonePizza = new CalzonePizza.Builder()
    .addTopping(Topping.HAM).sauceInside().build();

클라이언트 입장에서 Pizza의 enum과 각 하위 클래스의 enum(열거형)을 혼용할 수 있 있다. 이러한 빌더 패턴은 매우 큰 유연성을 가져다 준다.


빌더 패턴 단점

  1. 빌더 객체의 생성
  2. 매개변수가 적을시 용이하다.
  3. 코드의 장황함.

결론

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

profile
기록에 성장을

0개의 댓글