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

이 글은 공부를 하면서 알게 된 내용들을 기록하는 글 입니다. 오류나 고쳐야 할 사항들이 있다면 지적 부탁드립니다!

 

1. 생성자와 정적 팩터리 메서드의 한계

🤔 생성자와 정적 팩터리 메서드가 가지고 있는 제약으로 인해 Builder 패턴이 탄생했다!

객체를 생성할 때, 선택적 매개변수가 많은 경우 적절히 대응하기가 어렵다.
예를 들어 `영양 성분` 클래스에 `1회 제공량`, `칼로리`, `총 지방`, `트랜스 지방`, `포화 지방`, `단백질`, `나트륨` 이라는 멤버 변수가 있다고 가정하자.

public class NutritionFacts {
    private final int servingSize;
    private final int calories;
    private final int transFat;
    private final int saturatedFat;
    private final int protein;
    private final int sodium;
}

하지만 여기서 문제가 발생한다.
각 제품마다 포함되는 영양 성분이 다 다른데, 이러한 점을 반영하려면 생성자던 정적 팩터리 메서드던 상관없이 생성하는 메서드를 여러 개 만들어야 한다는 것이다.

이에 대해 우리는 세 가지의 해결책을 가지고 있다.
첫 번째로 `점층적 생성자 패턴`, 두 번째는 `자바 빈즈 패턴`  마지막으로는 `빌더 패턴`이다.
각 해결책이 어떤 특징을 가지고 있고 그래서 왜 빌더 패턴을 사용해야 하는지 알아보자!

 

 

💡 해결책 1 - 점층적 생성자 패턴(telescoping constructor pattern)

점층적 생성자 패턴이란 생성자를 매개변수의 개수만큼 구성하는 패턴을 말한다.

public class NutritionFacts {
    private final int servingSize;
    private final int calories;
    private final int transFat;
    private final int protein;
    private final int sodium;

    public NutritionFacts(int servingSize, int calories) {
        this.servingSize = servingSize;
        this.calories = calories;
    }

    public NutritionFacts(int servingSize, int calories, int transFat){
        this.servingSize = servingSize;
        this.calories = calories;
        this.transFat = transFat;
    }

    public NutritionFacts(int servingSize, int calories, int transFat, int protein, int sodium){
        this.servingSize = servingSize;
        this.calories = calories;
        this.transFat = transFat;
        this.protein = protein;
        this.sodium = sodium;
    }
}

위의 코드처럼 조건에 따라서 생성자에 전달하는 값이 달라진다면 → 조건에 맞춰서 생성자를 생성해야 할 것이고 → 그 결과 생성자의 수가 늘어날 것이다.

이는 심각한 단점들이 몇 개 있다.

1. 만일 매개변수의 수가 더 늘어난다면, 점층적 생성자 패턴을 사용한 위의 코드보다 가독성이 더욱 안 좋아질 것이다.
2. 코드를 읽을 때 각 값의 의미가 무엇인지도 헷갈릴 것이고, 매개변수가 많아질 떄에는 더욱 복잡해질 것이다.
3. 타입이 같은 매개변수가 여러 개 있는 경우 찾기 어려운 버그로 이어질 수 있다.
4. 클라이언트가 실수로 매개변수의 순서의 바꿔 건네줘도 컴파일러는 알아채지 못하고 런타임 에러로 이어진다.

이를 보완하기 위해 나타난 패턴이 `자바 빈스 패턴(Java bean pattern)`다.

 

 

💡 해결책 2 - 자바 빈즈 패턴(Java bean pattern)

매개변수가 없는 생성자로 객체를 만든 후, setter 메서드를 호출해 매개변수의 값을 설정하는 방식

public class NutritionFacts {
    private final int servingSize;
    private final int calories;
    private final int transFat;
    private final int protein;
    private final int sodium;

    public NutritionFacts() { }

    public void setServingSize(int val) { servingSize = val; }
    public void setCalories(int val) { calories = val; }
    public void setTransFat(int val) { transFat = val; }
    public void setProtein(int val) { protein = val; }
    public void setSodium(int val) {sodium = val; } 
}

NutritionFacts nutrition = new NutritionFacts();
nutrition.setServingSize(100);
nutrition.setCalories(324);
nutrition.setTransFat(60);
nutrition.setProtein(17);
nutrition.setSodium(100);

확실히 `점층적 생성자 패턴`에서 볼 수 있었던 단점들(수 많은 생성자 메서드들)이 보이지 않는다.
코드가 조금 더 길어지긴 했지만, 인스턴스를 만들기 쉬우며 더 읽기 쉬운 코드가 되었다.

하지만 `자바 빈즈 패턴`는 심각한 단점이 있다.

1. 객체가 완전히 생성되기 이전까지는 일관성(consistency)가 무너진 상태에 놓인다.
2. 각 프로퍼티들에 대해 setter 메서드들이 모두 선언되어있기 때문에 불변으로 만들 수 없다.
3. setter가 열려있기 때문에 의도치 않게 혹은 고의적으로 외부에서 setter를 통해 객체의 값을 수정할 수 있다. 캡슐화/정보은닉을 지킬 수 없게 된다.
4. 스레드 안전성을 얻기 위해서는 프로그래머가 추가 작업을 해주어야 한다.

이러한 단점을 모두 보완하고, 점층적 생성자 패턴의 안전성과 자바 빈즈 패턴의 가독성이라는 장점을 가지고 탄생한 것이 바로 `Builder pattern`이다.

 

 

💡 해결책 3 - 빌더 패턴(Builder pattern)

필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자(or 정적 팩터리 메서드)를 호출하여 빌더 객체를 얻고,
setter 메서드를 이용하여 원하는 값을 추가적으로 설정, 마지막으로 build() 메서드를 호출하여 필요한 객체를 얻는 패턴을 말한다.

public class NutritionFacts {
    private final int servingSize;
    private final int calories;
    private final int transFat;
    private final int protein;
    private final int sodium;

    public static class Builder {
        private final int servingSize;
        private final int calories;

        private int transFat;
        private int protein;
        private int sodium;

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

        public Builder transFat(int val) {
            calories = val;
            return this;
        }

        public Builder protein(int val) {
            protein = val;
            return this;
        }

        public Builder sodium(int val) {
            sodium = val;
            return this;
        }

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

    private NutritionFacts(Builder builder) {
        this.servingSize = builder.servingSize;
        this.calories = builder.calories;
        this.transFat = builder.transFat;
        this.protein = builder.protein;
        this.sodium = builder.sodium;
    }
}

위의 코드를 사용하는 클라이언트 코드는 밑과 같이 작성할 수 있다

NutritionFacts pepsi = new NutritionFacts().Builder(240, 8)
        .transFat(12)
        .protein(3)
        .sodium(35)
        .build();

 

`Build pattern`은 여러가지 장점이 있다.

1. 우선 `점층적 생성자 패턴`에서의 수 많은 생성자와 그에 파생되는 다양한 단점들을 보완할 수 있다.
2. 거기에 `Java bean pattern`에서의 setter 메서드도 존재하지 않기 때문에 `불변 객체`로 만들 수 있으며, 동시에 캡슐화와 정보 은닉도 지킬 수 있다.
3. 생성자(정적 팩터리 메서드)와는 달리 멤버 변수가 선언된 순서대로 변수를 설정하지 않아도 된다.
4. `Nutrition` 클래스에서는 `sodium`이 제일 마지막에 선언된 변수이지만, `.sodium()`의 위치는 이에 영향을 받지 않는다.

Builder 클래스의 setter 메서드를 통해 값을 설정하고, `Builder 자기 자신 객체` 반환함으로서 연쇄적인 호출이 가능하게 되었다.
자기 자신을 반환하기 때문에 연쇄적인 호출이 가능하고, 이러한 방식을 `Fluent API` 혹은 `Method chaining`이라고 한다.

---

2. Builder pattern에서의 유효성 검사

`Builder` 클래스를 내부에 직접 구현하는 경우,
1️⃣ Builder 클래스의 메서드에 입력된 매개변수를 검사하고 2️⃣ build()에서 호출하는 생성자에서 한 번 더 검사할 수 있다.
각 변수마다 설정하는 메서드가 따로 있으므로, 검증을 하는 도중 문제가 발생했을 때 어떤 매개변수가 잘못되었는지 자세히 알려주기 용이하다.

---

3. 계층 구조(상속 관계)에서의 Build pattern

`Builder 패턴`은 계층적으로 설계된 클래스와 함께 사용하면 그 시너지가 늘어난다.

각 계층의 클래스에 관련 빌더를 멤버로 정한다. 이 때, 추상 클래스는 추상 빌더(abstract builder)를, 구체 클래스는 구체 빌더(concrete builder)를 갖게 한다.

---

✅Spring에서의 Builder pattern 적용

이런 Builder pattern에도 단점은 존재한다.
바로 각 클래스마다 `Builder` 클래스를 내부에 생성해주어야 한다는 것이다. 즉, 보일러 플레이트(Boilerplate) 코드가 발생한다.

Spring에서는 `Lombok` 라이브러리를 사용하여 이를 손쉽게 생성할 수 있다.

```java
@Builder
public class NutritionFacts {
private final int servingSize;
private final int calories;
private final int transFat;
private final int protein;
private final int sodium;
}

---

✅ 참고 자료 & 링크

- Effective Java 책