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

문법식·2022년 2월 2일
0

Effective Java 3/E

목록 보기
2/52

정적 팩터리와 생성자에는 똑같은 제약이 하나 있다. 선택적 매개변수가 많을 때 적절히 대응하기 어렵다는 점이다. 생성자를 이용한 초기화, 자바빈즈 패턴(Setter), 빌더 패턴을 설명하면서 앞에서 얘기한 어렵다는 점에 대해 이해하도록 하겠다.


생성자

public class NutritionFacts {
    private int servingSize;
    private int sodium;
    private int carbohydrate;
    private int servings;

    //생성자
    public NutritionFacts(int servingSize, int sodium, int carbohydrate, int servings) {
        this.servingSize = servingSize;
        this.sodium = sodium;
        this.carbohydrate = carbohydrate;
        this.servings = servings;
    }
    
    public static void main(String[] args) {
        //생성자는 코드 작성하거나 읽기가 어려움.
        NutritionFacts nutritionFacts=new NutritionFacts(1,6,10,20);
   }
}

위와 같이 NutritionFacts nutritionFacts=new NutritionFacts(1,6,10,20);로 객체를 생성한다면 지금은 매개변수가 4개라서 매개변수 첫번째 값은 servingSize를 초기화하고, 매개변수 두번째 값은 sodium을 초기화한다는 것 등을 알기 쉽지만, 매개변수가 엄청 많아진다면 몇 번째 매개변수가 객체의 어느 필드를 초기화하는지 알기가 어렵다. 그래서 생성자를 이용하여 객체를 생성할 때는 매개변수 개수가 많아진다면 클라이언트 코드를 작성하거나 읽기가 어렵다.


자바빈즈 패턴(Setter)

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

public class NutritionFacts {
    private int servingSize;
    private int sodium;
    private int carbohydrate;
    private int servings;

    //Setter
    public NutritionFacts() {
    }
    public void setServingSize(int servingSize) {
        this.servingSize = servingSize;
    }
    public void setSodium(int sodium) {
        this.sodium = sodium;
    }
    public void setCarbohydrate(int carbohydrate) {
        this.carbohydrate = carbohydrate;
    }
    public void setServings(int servings) {
        this.servings = servings;
    }
    
    public static void main(String[] args) {
        /*
        * Setter의 장점은 무엇을 초기화하는지 명확하다는 것이다.
        * 그러나 단점은 코드가 장황하고, 자바빈이 중간에 사용하는 경우 안정적이지 않은 상태로 사용될 여지가 있다.
        * 또한 Setter가 있어서 불변 클래스로 만들지 못한다는 치명적인 단점이 있다.
        * 스레드 안정성을 보장하려면 추가적인 수고(locking 같은)가 필요하다.
        * 이러한 단점을 완화하려면 freezing을 사용할 수 있는데 실전에서 거의 쓰지 않는다. 백기선님도 잘 모른다고 한다.
        */
        NutritionFacts cocaCola=new NutritionFacts();
        cocaCola.setServingSize(240);
        cocaCola.setServings(8);
        cocaCola.setCarbohydrate(27);
        cocaCola.setSodium(35);
   }
}

생성자에서의 단점은 더 이상 보이지 않는다. 코드가 길어지긴 했지만 객체를 생성하기 쉽고, 그 결과 더 읽기 쉬운 코드가 되었다.
하지만 불행히도 자바빈즈는 자신만의 심각한 단점을 지니고 있다. 자바빈즈 패턴에서는 객체 하나를 만들려면 메소드(Setter)를 여러 개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성이 무너진 상태에 놓이게 된다. 일관성이 깨진 객체가 만들어지면, 버그를 심은 코드와 그 버그 때문에 런타임에 문제를 겪는 코드가 물리적으로 멀리 떨어져 있을 것이므로 디버깅도 만만치 않다. 즉, 어떤 객체를 Setter를 사용해서 값을 변경한 버그 코드랑 그렇게 변경되서 런타임에 문제를 겪는 코드가 서로 다른 위치에 있다면 이를 디버깅으로 해결하기가 어렵다는 얘기이다. 이처럼 일관성이 무너지는 문제 때문에 자바빈즈 패턴에서는 클래스를 불변으로 만들 수 없으며 스레드 안정성을 위해 프로그래머가 추가 작업을 해주어야 한다.


빌더 패턴

빌더 패턴은 생성자의 안정성과 자바빈즈 패턴(Setter)의 가독성, 이 두 가지 장점을 모두 겸비한 방법이다.

public class NutritionFacts {
    private int servingSize;
    private int sodium;
    private int carbohydrate;
    private int servings;

    //Builder
    public static class Builder {
        // 필수 매개변수
        private final int servingSize;
        private final int servings;

        // 선택 매개변수 - 기본값으로 초기화한다.
        private int sodium        = 0;
        private int carbohydrate  = 0;

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

        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;
        sodium       = builder.sodium;
        carbohydrate = builder.carbohydrate;
    }
    public static void main(String[] args) {
        /*
        * 빌더 패턴은 생성자의 안정성과 자바빈(Setter)의 가독성 두 가지 장점을 모두 겸비한 방법이다.
        * 빌더 패턴은 만들려는 객체를 바로 만들지 않고 클라이언트는 빌더에 필수적인 매개변수를 주면서 호출해 Builder 객체를 얻는다.
        * 그 다음 Builder 객체가 제공하는 Setter와 비슷한 메소드를 사용해서 부가적인 필드를 채워넣는다.
        * 최종적으로 build 라는 메소드를 호출해서 만들려는 객체를 생성한다.
        */
        NutritionFacts hamburger=new Builder(240, 8)
                .carbohydrate(20).sodium(20).build();
   }
}

클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자(혹은 정적 팩터리)를 호출해 빌더 객체를 얻는다. 그 다음 빌더 객체가 제공하는 일종의 Setter메소드들로 원하는 선택 매개변수들으 설정한다. 마지막으로 매개변수가 없는 build()를 호출해 드디어 우리에게 필요한 객체를 얻는다.
빌더의 Setter메소드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다. 이런 방식을 플루언트 API(fluent API)혹은 메소드 연쇄(method chaining)이라 한다. 메인 함수에서 NutritionFacts hamburger=new Builder(240, 8).carbohydrate(20).sodium(20).build(); 코드가 메소드 연쇄를 사용한 코드이다.

빌더 패턴은 계층적으로 설계된 클래스와 함께 쓰기에 좋다. 추상 클래스는 추상 빌더를, 구체 클래스는 구체 빌더를 갖게 한다.

추상 클래스

public abstract class Pizza {
    public enum Topping{
        HAM, MUSHROOM, ONION
    }
    final EnumSet<Topping> toppings;

    //Builder 클래스가 자기 자신의 하위 타입을 받는 Builder 임. 이것을 재귀적인 타입 한정을 이용하는 제너릭 타입이라고 한다.
    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();
        }

        //Covariant 리턴 타입을 위한 준비 작업
        abstract Pizza build();

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

구체 클래스

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

        // 하위 클래스의 메소드가 상위 클래스의 메소드가 정의한 반환 타입이 아닌,
        // 그 하위 타입을 반환하는 기능을 공변 반환 타이핑(covariant return typing)이라 한다.
        @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 PizzaClient {
    public static void main(String[] args) {
        NyPizza nyPizza=new NyPizza.Builder(NyPizza.Size.LARGE)
                .addTopping(Pizza.Topping.HAM)
                .addTopping(Pizza.Topping.ONION)
                .build();
    }
}

추상 클래스는 Builder<T extends Builder<T>>같이 정의하여 Builder 클래스가 자기 자신의 하위 타입을 받는 Builder 로 정의한다. 이것을 재귀적인 타입 한정을 이용하는 제너릭 타입이라고 한다. 여기에 추상 메소드인 self를 더해 하위 클래스에서는 형변환 하지 않고도 메소드 연쇄를 지원할 수 있다. 즉, 각 하위 클래스의 빌더가 정의한 build 메소드는 해당하는 구체 하위 클래스를 반환하도록 선언한다. NyPizza.BuilderNyPizza를 반환한다는 뜻이다. 하위 클래스의 메소드가 상위 클래스의 메소드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변 반환 타이핑(covariant return typing)이라 한다. 이 기능을 이용하면 클라이언트가 형변환에 신경쓰지 않고 빌더를 사용할 수 있다.

빌더를 사용할 때 생성자로는 누릴 수 없는 사소한 이점이 있다. 빌더를 이용하면 가변인수 매개변수를 여러 개 사용할 수 있다. 각각을 적절한 메소드로 나눠 선언하면 된다. 아니면 메소드를 여러 번 호출하도록 하고 각 호출 때 넘겨진 매개변수들을 하나의 필드로 모을 수 있다. 메인 클래스의 main 함수에서 addTopping메소드가 이렇게 구현한 예다.

빌더 패턴은 상당히 유연하다. 빌더 하나로 여러 객체를 순회하면서 만들 수 있고, 빌더에 넘기는 매개변수에 따라 다른 객체를 만들 수 있다. 그러나 빌더 패턴에 장점만 있는 것은 아니다. 객체를 만들려면, 그에 앞서 빌더부터 만들어야 한다. 빌더 생성 비용이 크지는 않지만 성능에 민감한 상황에서는 문제가 될 수 있다. 또한, 생성자보다 코드가 장황해서 매개변수가 4개 이상은 되어야 값어치를 한다. 하지만 API는 시간이 지날수록 매개변수가 많아지는 경향이 있음을 명심하자.

profile
백엔드

0개의 댓글