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

객체 생성과 파괴, 두 번째 아이템

Posted by SungBeom on March 10, 2020 · 17 mins read

Intro

정적 팩토리와 생성자에는 똑같은 제약이 하나 있다. 선택적 매개변수가 많을 때 적절히 대응하기 어렵다는 점이다. 식품 포장의 영양정보를 표현하는 클래스를 생각해보자. 1회 내용량, 총 n회 제공량 같은 필수 항목과 1회 제공량당 칼로리, 지방, 나트륨, 탄수화물 등 선택 항목으로 이뤄진다.

점층적 생성자 패턴

프로그래머들은 이런 클래스용 생성자 혹은 정적 팩토리에 대개 점층적 생성자 패턴(telescoping constructor pattern)을 사용했다. 필수 매개변수만 받는 생성자부터 선택 매개변수를 전부 다 받는 생성자까지 늘려가는 방식이다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*
 * 점층적 생성자 패턴 - 확장하기 어렵다!
 */
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 cocaCola = new NutritionFacts(240810003527);
cs

위의 예시처럼 매개변수가 많은 경우 점층적 생성자 패턴도 쓸 수는 있지만, 매개변수 개수가 많아지면 클라이언트 코드를 작성하거나 읽기 어렵다.

자바빈즈 패턴

다른 대안인 자바빈즈 패턴(JavaBeans pattern)은 매개변수가 없는 생성자로 객체를 만든 후, 세터(setter) 메소드들을 호출해 원하는 매개변수의 값을 설정하는 방식이다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/*
 * 자바빈즈 패턴 - 일관성이 깨지고, 불변으로 만들 수 없다.
 */
public class NutritionFacts {
    // 매개변수들은 (기본값이 있다면) 기본값으로 초기화된다.
    private final int servingSize  = -1;  // 필수(기본값 없음)
    private final int servings     = -1;  // 필수(기본값 없음)
    private final int calories     = 0;
    private final int fat          = 0;
    private final int sodium       = 0;
    private final int carbohydrate = 0;
 
    public NutritionFacts() { }
    // 세터 메소드들
    public void setServingSize(int val)  { servingSize = val; }
    public void setServings(int val)     { servings = val; }
    public void setCalories(int val)     { calories = val; }
    public void setFat(int val)          { fat = val; }
    public void setSodium(int val)       { sodium = val; }
    public void setCarbohydrate(int val) { carbohydrate = val; }
}
 
 
// 사용 예시
NutritionFacts cocaCola = new NutritionFacts();
cocaCola.setServingSize(240);
cocaCola.setServings(8);
cocaCola.setCalories(100);
cocaCola.setSodium(35);
cocaCola.setCarbohydrate(27);
cs

코드가 더 길어졌으나 점층적 생성자 패턴의 단점들을 해결하고 인스턴스를 만들기 쉽다. 그 결과 더 읽기 쉬운 코드가 되었지만, 심각한 단점을 지니고 있다. 자바빈즈 패턴에서는 객체 하나를 만들려면 메소드를 여러 개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성(consistency)이 무너진 상태에 놓이게 된다. 이처럼 일관성이 무너지는 문제 때문에 자바빈즈 패턴에서는 클래스를 불변으로 만들 수 없으며 스레드 안전성을 얻으려면 프로그래머가 추가 작업을 해줘야만 한다.

빌더 패턴

다행히 우리에겐 점층적 생성자 패턴의 안전성과 자바빈즈 패턴의 가독성을 겸비한 빌더 패턴(Builder pattern)이 있다. 클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자(혹은 정적 팩토리)를 호출해 빌더 객체를 얻는다. 그런 다음 빌더 객체가 제공하는 일종의 세터 메소드들로 원하는 선택 매개변수들을 설정한다. 마지막으로 매개변수가 없는 build 메소드를 호출해 필요한 (보통은 불변인) 객체를 얻는다. 빌더는 생성할 클래스 안에 정적 멤버 클래스로 만들어두는 게 보통이다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/*
 * 빌더 패턴 - 점층적 생성자 패턴과 자바빈즈 패턴의 장점만 취했다.
 */
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 NutritionFacts build() {
            return new NutritionFacts(this);
        }
    }
 
    private NutritionFacts(Builder builder) {
        servingSize  = builder.servingSize;
        servings     = builder.servings;
        calories     = builder.calories;
        fat          = builder.fat;
        sodium       = builder.sodium;
        carbohydrate = builder.carbohydrate;
    }
}
 
 
// 사용 예시
NutritionFacts cocaCola = new NutritionFacts.Builder(2408)
    .calories(100).sodium(35).carbohydrate(27).build();
cs

NutritionFacts 클래스는 불변이며, 모든 매개변수의 기본값들을 한곳에 모아뒀다. 빌더의 세터 메소드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있는데, 이런 방식을 메소드 호출이 흐르듯 연결된다는 뜻으로 플루언트 API(fluent API) 혹은 메소드 연쇄(method chaining)라 한다. 클라이언트 코드는 쓰기 쉽고, 무엇보다도 읽기 쉽다. 빌더 패턴은 (파이썬과 스칼라에 있는) 명명된 선택적 매개변수(named optional parameters)를 흉내 낸 것이다.

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/*
 * 계층적으로 설계된 클래스와 잘 어울리는 빌더 패턴
 */
public abstract class Pizza {
    public enum Topping { HAM, MUSHROOM, ONION, PEPPER, SAUSAGE }
    final Set<Topping> toppings;
 
    abstract static class Builder<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();
 
        // 하위 클래스는 이 메소드를 재정의(overriding)하여
        // "this"를 반환하도록 해야 한다.
        protected abstract T self();
    }
 
    Pizza(Builder<?> builder) {
        toppings = builder.toppings.clone();
    }
}
cs

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// 뉴욕 피자
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;
    }
}
 
 
// 사용 예시
NyPizza pizza = new NyPizza.Builder(SMALL)
    .addTopping(SAUSAGE).addTopping(ONION).build();
cs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// 칼초네 피자
public class Calzone extends Pizza {
    private final boolean sauceInside;
 
    public static class Builder extends Pizza.Builder<Builder> {
        private boolean sauceInside = 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);
        saurceInside = builder.saurceInside;
    }
}
 
 
// 사용 예시
Calzone calzone = new Calzone.Builder()
    .addTopping(HAM).sauceInside().build();
cs

각 하위 클래스의 빌더가 정의한 build 메소드는 해당하는 구체 하위 클래스를 반환하도록 선언한다. 이 기능을 공변 반환 타이핑(covariant return typing)이라 한다. 이 기능을 이용하면 클라이언트가 형변환에 신경 쓰지 않고도 빌더를 사용할 수 있다. 또한 생성자로는 누릴 수 없는 사소한 이점으로, 빌더를 이용하면 가변인수(varags) 매개변수를 여러 개 사용할 수 있다.

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

빌더 패턴에 단점은, 객체를 만들려면 그에 앞서 빌더부터 만들어야 되는데, 빌더 생성 비용이 크지는 않지만 성능에 민감한 상황에서는 문제가 될 수 있다. 또한 점층적 생성자 패턴보다는 코드가 장황해서 매개변수가 4개 이상은 되어야 값어치를 한다. 하지만 API는 시간이 지날수록 매개변수가 많아지는 경향이 있으므로, 애초에 빌더로 시작하는 편이 나을 때가 많다.


핵심 정리

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