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

June·2022년 3월 23일
1

[이펙티브자바]

목록 보기
2/72

점층적 생성자 패턴

정적 팩터리와 생성자는 선택적 매개변수가 많을 때 적절히 대응하기 어렵다.

필드 매개변수만 받는 생성자, 필수 매개변수와 선택 매개변수 1개를 받는 생성자, 선택 매개변수를 2개 받는 생성자... 식으로 생성자를 늘려나가는 점층적 생성자 패턴을 이때까지 사용했다.

// 코드 2-3 빌더 패턴 - 점층적 생성자 패턴과 자바빈즈 패턴의 장점만 취했다. (17~18쪽)
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 servigs) {
        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);
    }
    ...
}

이럴 떄는 사용자가 원치 않는 매개변수까지 포함된 생성자여도 값을 지정해줘야 한다.

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

  • 코드를 작성할 때 각 값의 의미가 무엇인지 헷갈린다.
  • 타입이 같은 매개변수가 연달아 있으면 어려운 버그가 된다.
  • 매개변수 순서를 바꿔 전달할 수도 있다.

자바빈즈 패턴

매개변수가 없는 생성자로 객체를 만든 후 세터 메서드들을 호출해 원하는 매개변수 값을 설정하는 방식이다.
이 방식은 심각한 단점이 있다. 자바빈즈 패턴에서는 객체 하나를 만들려면 메서드를 여러 개 호출해야 하고 객체가 완전히 완성되기 전까지는 일관성이 무너진 상태에 놓인다.

클래스를 불변으로 만들 수 없으며 스레드 안정성을 얻으려면 추가 작업이 필요하다.

빌더 패턴

필요한 객체를 직접 만드는 대신, 필요 매개변수만으로 생성자를 호출해 빌더 객체를 얻는다. 그 다음 빌더 객체가 제공하는 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정한다. 마지막으로 매개변수가 없는 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 NurtritionFacts build() {
            return new NutritionFacts(this);
        }
    }
    
    private NutritionFacts(Builder builder) {
        servingSize = builder.servingSize;
        servings = builders.servings;
        calories = builder.calories;
        fat = builder.fat;
        sodium = builder.sodiuml
        carbohydrate = builder.carbohydrate;
    }
}

빌더의 세터 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다. 이런 방식을 메서드호출이 흐르듯 연결된다는 뜻으로 플루언트 API 혹은 메서드 연쇄라고 한다.

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

빌더 패턴은 명명된 선택적 매개변수를 흉내낸 것이다.

위의 코드에서 유효성 검사 코드는 생략했는데, 최대한 일찍 발견하려면 빌더의 생성자와 메서드에서 입력 매개변수를 검사하고, build 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식을 검사하자.

불변식(invariant)은 프로그램이 실행되는 동안, 혹은 정해진 기간 동안 반드시 만족해야 하는 조건을 말한다. 다시 말해 변경을 허용할 수 있으나 주어진 조건 내에서만 허용한다는 뜻이다. 예컨대 리스트의 크기는 반드시 0 이상이어야 하니, 만약 한순간이라도 음수 값이 된다면 불변식이 깨진 것이다.

빌더 패턴은 계층적으로 설계된 클래스와 함께 쓰기에 좋다. 각 계층의 클래스에 관련 빌더를 멤버로 정의하자. 추상 클래스는 추상 빌더를, 구체 클래스는 구체 빌더를 갖게 한다.

public abstract class Pizza {
    public enum Topping {HAM, MUSHROOM, ONOION, 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 Poizza builder();
        
        // 하위 클래스는 이 메서드를 오버라이드하여
        // this를 반환하도록 해야 한다.
        protected abstract T self();
    }
    
    Pizza(Builder<?> builder) {
        toppings = builder.toppings.clone();
    }
}

Pizza.Builder 클래스는 재귀적 타입 한정(아이템 30)을 이용하는 제네릭 타입이다. 여기에 추상 메서드 self를 더해 하위 클래스에서는 형변환 하지 않고도 메서드 연쇄를 지원할 수 있다.

Pizza의 하위 클래스 뉴욕 피자와 칼초네 피자가 있다. 뉴욕 피자는 크기 매개변수를 필수로 받고, 칼초네 피자는 소스를 안에 넣을지 선택하는 매개변수를 필수로 받는다.

뉴욕 피자

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 sauceInsize = 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);
        size = builder.sauceInside;
    }
}

각 하위 클래스의 빌더가 정의한 빌드 메서드는 해당하는 구체 하위 클래스를 반환하도록 선언한다. NyPizza.BuilderNyPizza를 반환하고, Calzone.BuidlerCalzone를 반환한다는 뜻이다.

하위 클래스의 메서드가 상위 클래스의 메서드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능공변 반환 타이핑이라 한다. 이 기능을 이용하면 클라이언트가 형변환에 신경 쓰지 않고도 빌더를 사용할 수 있다.

체스 미션 때 각 말들이 구체 클래스 인스턴스 생성해서 반환 가능한지 생각해보기

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

빌더 패턴은 유연해서 빌더 하나로 여러 객체를 순회하면서 만들 수 있고, 빌더에 넘기는 매개변수에 따라 다른 객체를 만들 수도 있다. 객체마다 부여되는 일련변호와 같은 특정 필드는 빌더가 알아서 채우도록 할 수도 있다.

빌더패턴의 단점도 있다. 객체를 만들려면 그에 앞서 빌터부터 만들어야 한다. 빌더 생성 비용이 크지 않지만 성능이 민감한 상황에서 문제가 될 수도 있다. 또한 코드가 장황해서 매개변수가 4개 이상은 되어야 값어치를 한다.

이해 안된 부분 스터디 후에 채워넣기.

0개의 댓글