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

생성자에 매개변수가 많다면 빌더를 고려하라

점층적 생성자 패턴

public class User {
    private final int age;   // 필수
    private final int phoneNumber;   // 필수
    private final int weight;   // 선택
    private final int tall;   // 선택
    private final int birthday;   // 선택
}

생성자와 정적 팩토리 메서드는 똑같은 제약이 하나 있다. 바로, 위 코드와 같이 선택적 매개변수가 많을 때 적절히 대응하기 어렵다는 점이다.

위와 같은 클래스용 생성자 혹은 정적 팩토리 메서드를 위해 프로그래머들은 점층적 생성자 패턴을 즐겨 사용했다. 필수 매개 변수만 받는 생성자, 필수 매개변수와 선택 매개변수 1개를 받는 생성자, 선택 매개변수 2개까지 받는 생성자, ... 형태로 선택 매개변수를 전부 다 받는 생성자까지 늘려가는 방식이다.

 

public class User {
    private final int age;   // 필수
    private final int phoneNumber;   // 필수
    private final int weight;   // 선택
    private final int tall;   // 선택
    private final int birthday;   // 선택

    public User(int age, int phoneNumber) {
        this.age = age;
        this.phoneNumber = phoneNumber;
    }

    public User(int age, int phoneNumber, int weight) {
        this.age = age;
        this.phoneNumber = phoneNumber;
        this.weight = weight;
    }

    public User(int age, int phoneNumber, int weight, int tall) {
        this.age = age;
        this.phoneNumber = phoneNumber;
        this.weight = weight;
        this.tall = tall;
    }

    public User(int age, int phoneNumber, int weight, int tall, int birthday) {
        this.age = age;
        this.phoneNumber = phoneNumber;
        this.weight = weight;
        this.tall = tall;
        this.birthday = birthday;
    }
}

위 소스코드가 점층적 생성자 패턴을 활용한 예이다. User 클래스의 인스턴스를 만들기 위해서는 원하는 매개변수를 모두 포함한 생성자 중 가장 짧은 것을 골라 호출하면 된다.

 

이러한 점층적 생성자 패턴도 사용 가능하지만, 매개변수의 개수가 많아지면 클라이언트 코드를 작성하거나 읽기 어려워지게 된다.

 

자바 빈즈 패턴

public class User {
    private int age = -1;   // 필수, 기본값 없음
    private int phoneNumber = -1;   // 필수, 기본값 없음
    private int weight;   // 선택
    private int tall;   // 선택
    private int birthday;   // 선택

    /** 기본 생성자 */
    public User() {}

    /** setter 메서드들 */
    public void setAge(final int age) { this.age = age; }
    public void setPhoneNumber(final int phoneNumber) { this.phoneNumber = phoneNumber; }
    public void setWeight(int weight) { this.weight = weight; }
    public void setTall(int tall) { this.tall = tall; }
    public void setBirthday(int birthday) { this.birthday = birthday; }
}

자바 빈즈 패턴을 사용함으로써, 점층적 생성자 패턴의 단점들이 더 이상 보이지 않게 되었다. 코드가 길어지긴 했지만 인스턴스를 만들기 쉬워졌고, 그 결과 더 읽기 쉬운 코드가 되었다.

 

public class Main {
    public static void main(String[] args) {
        User user = new User();
        user.setAge(25);
        user.setPhoneNumber(0101234567);
        user.setWeight(65);
        user.setTall(175);
        user.setBirthday(0715);
    }
}

하지만, 불행히도 자바 빈즈는 심각한 단점을 지니고 있다. 자바 빈즈 패턴에는 객체 하나를 만들려면 메서드를 여러 개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성이 무너진 상태에 놓이게 된다.

점층적 생성자 패턴에서는 매개변수들이 유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있었는데, 그 장치가 완전히 사라진 것이다. 일관성이 깨진 객체가 만들어지면, 발생한 문제에 대한 디버깅 또한 쉽지 않을 것이다.

 

빌더 패턴

public class User {
    private final int age;
    private final int phoneNumber;
    private int weight;
    private int tall;
    private int birthday;

    private User(Builder builder) {
        this.age = builder.age;
        this.phoneNumber = builder.phoneNumber;
        this.weight = builder.weight;
        this.tall = builder.tall;
        this.birthday = builder.birthday;
    }

    public static class Builder {
        private final int age;
        private final int phoneNumber;
        private int weight;
        private int tall;
        private int birthday;

        public Builder(int age, int phoneNumber) {
            this.age = age;
            this.phoneNumber = phoneNumber;
        }

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

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

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

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

위에서 언급한 점층적 사용자 패턴과 자바 빈즈 패턴의 단점을 보완하기 위한 대안이 존재한다. 점층적 생성자 패턴의 안전성과 자바 빈즈 패턴의 가독성을 겸비한 빌더 패턴이다. 

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

 

public class Main {
    public static void main(String[] args) {
        User user = new User.Builder(25, 0101234567)
                .weight(65)
                .tall(175)
                .birthday(0715)
                .build();
    }
}

위 소스코드는 User 클래스를 사용하는 예이다. User 클래스는 불변이며, 모든 매개변수의 기본값들을 한 곳에 모아 뒀다. 빌더의 세터 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다. 이런 방식을 메서드 호출이 흐르듯 연결된다는 뜻으로 플루언트 API 또는 메서드 연쇄라고 한다.

 

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

 

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>> {
        EnumSet<Topping> toppings = EnumSet.noneOf(Topping.class);

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

        abstract Pizza build();

        protected abstract T self();   // 하위 클래스는 이 메서드를 재정의하여, "this"를 반환하도록 해야 한다.
    }
}

위 소스코드는 피자의 다양한 종류를 표현하는 계층구조의 루트에 놓인 추상 클래스이다.

 

public class NyPizza extends Pizza {
    public enum Size {SMALL, MEDIUM, LARGE}
    private final Size size;

    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 = Objects.requireNonNull(size);
        }

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

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

위 소스코드는 Pizza 클래스의 하위 클래스인 NyPizza이다. 하위 클래스의 빌더가 정의한 build() 메서드는 해당하는 구체 하위 클래스를 반환하도록 선언한다. NyPizza.Builder는 NyPizza를 반환한다는 뜻이다.

 

public class Main {
    public static void main(String[] args) {
        Pizza pizza = new NyPizza.Builder(NyPizza.Size.SMALL)
                .addTopping(Pizza.Topping.SAUSAGE)
                .addTopping(Pizza.Topping.ONION)
                .build();

    }
}

위에서 정의한 계층적 빌더를 사용하는 소스코드도 앞선 User 클래스의 빌더를 사용하는 코드와 다르지 않다. 생성자로는 누릴 수 없는 사소한 이점으로, 빌더를 이용하면 가변 인수 매개변수를 여러 개 사용할 수 있다.

 

최종 정리

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

---

출처

ㆍ 이펙티브 자바 Effective Java 3/E. 조슈아 블로크 저자(글) · 개앞맵시(이복연) 번역

ㆍ https://github.com/woowacourse-study/2022-effective-java/blob/main/02%EC%9E%A5/%EC%95%84%EC%9D%B4%ED%85%9C_02/%EC%83%9D%EC%84%B1%EC%9E%90%EC%97%90_%EB%A7%A4%EA%B0%9C%EB%B3%80%EC%88%98%EA%B0%80_%EB%A7%8E%EB%8B%A4%EB%A9%B4_%EB%B9%8C%EB%8D%94%EB%A5%BC_%EA%B3%A0%EB%A0%A4%ED%95%98%EB%9D%BC.md