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

초코칩·2024년 2월 26일
Java이팩티브 자바
0

Java

목록 보기
6/14
post-thumbnail

정적 팩터리와 생성자에는 똑같은 제약이 있다. 선택적 매개변수가 많을 때 적절히 대응하기 어렵다는 점이다. 여런 선택 항목이 있더라도, 몇 개를 제외하고는 나머지를 설정하고 싶지 않을 수도 있다.

점층적 생성자 패턴(telescoping constructor pattern)

클래스용 생성자 혹은 정적 팩터리에서는 점층적 생성자 패턴을 사용했다. 점층적 생성자 패턴(telescoping constructor pattern)은 필수 매개변수만 받는 생성자, 필수 매개변수와 선택 매개변수 1개를 받는 생성자, 선택 매개변수 2개까지 받는 생성자, ... 형태로 선택 매개변수를 전부 다 받는 생성자까지 늘려가는 방식이다. 다음 코드가 그 예시이다.

public class NutitionFacts {
	private final int servingSize;
    private final int servings;
    private final int calories;
    // ...
    
    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(240, 8, 100, 0, 35, 27);

단점

이 방식에는 다음과 같은 단점이 있다.

  • 설정하기 원치 않은 매개변수까지 포함해서 값을 설정해 넘겨야 한다.
  • 매개변수가 많아지면 클라언트 코드를 작성하거나 읽기 어렵다.
  • 매개변수의 순서를 바꿔 건네주어 런타임에 엉뚱하게 동작할 수도 있다.
  • 확장하기 어렵다.

자바빈즈 패턴

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


public class NutitionFacts {
	private final int servingSize;
    private final int servings;
    private final int calories;
    // ...
    
    public NutitionFacts() {}
    public void setServingSize(int val) {servingSize = val;}
    // ...
}

자바빈즈 패턴에서는 점층적 생성자 패턴의 단점을 보완한다.

단점

  • 객체 하나를 만들려면 메서드를 여러 개 호출해야 한다.
  • 객체가 완전히 생성되기 전까지는 일관성이 무너진 상태에 놓이게 된다.
    • 버그를 심은 코드와 그 버그 때문에 런타임에 문제를 겪는다.
  • 클래스를 불변으로 만들 수 없다.

불변으로 만들기 위해 freeze 메서드를 구현할 수 있으나, 사용하기 어렵다.

빌더 패턴

빌더 패턴은 점층적 생성자 패턴의 안정성과 자바 빈즈 패턴의 가독성을 겸비했다. 클라이언트는 필요한 객체를 직접 만드는 대신, 매개변수만으로 생성자(혹은 정적 팩터리)를 호출해 빌더 객체를 얻는다. 그런 다음 빌더 객체가 제공하는 일종의 setter 메서드들로 원하는 선택 매개변수들을 설정한다. 마지막으로 매개변수가 없는 build 메서드를 호출해 필요한 객체를 얻는다.

빌더는 생성할 클래스 안에 정적 멤버 클래스로 만드는 것이 일반적이다.


public class NutitionFacts {
	private final int servingSize;
    private final int servings;
    private final int calories;
    // ...
    
    public static class Builder {
    	// 필수 매개변수
        private final int servingSize;
        private final int servings;
        // 선택 매개변수
        private int calories = 0;
        private int fat = 0;
        private int sodium = 0;
        
        public Builder(int servingSize, int servings){
        	this.servingSize = servingSize;
            this.servings = servings;
        }
        public Builder calories(int val){
        	calories = val; return this;
        }
        
        // builders ...
        public NutritionFacts build() {
        	return new NutritionFacts(this);
        }
    }
    
    private NutritionFacts(Builder builder){
    	servingSize = builder.servingSize;
    	servings = builder.servings;
        // ...
    }
}

NutritionFacts 클래스는 불변이며, 모든 매개변수의 기본값들이 한곳에 존재한다. 빌더의 세터 메서드들은 빌더 자신을 반환하기 때문에 메서드 체이닝 방식으로 연쇄 호출이 가능하다.

장점

유효성 검사

잘못된 매개변수를 일찍 발견하려면 생성자와 메서드에서 입력 매개변수를 검사하고, build 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식을 검사할 수 있다. 검사해서 잘못된 점을 발견하면 어떤 매개변수가 잘못되었는지를 알려주는 예외를 던지면 된다.

불변식을 보장하기 위해 빌더로부터 매개변수를 복사해 해당 객체 필드들로 검사할 수 있다.

계층 클래스

빌더 패턴은 계층적으로 설계된 클래스와 함께 쓰기에 좋다.

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

위 this를 반환하는 메서드는 self 타입이 없는 자바를 위한 우회 방법이며, 시뮬레이트한 셀프 타입 (simulated self-type) 관용구라 한다.

Pizza의 하위 클래스가 NyPizza와 Calzone 2개 있다. 뉴욕 피자는 크기 매개변수를 필수로 받고, 칼조네 피자는 sauceInside를 매개변수를 필수로 받는다.

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

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

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

가변인수 사용

생성자로는 누릴 수 없는 가변인수 매개변수를 여러 개 사용할 수 있다. 적절한 메서드로 나눠 선언하면 된다. 또는 메서드를 여러 번 호출하도록하고 각 호출 때 넘겨진 매개변수들을 하나의 필드로 모을 수도 있다.

단점

  • 객체를 만들려면 빌더를 만들어야하고, 빌더 생성 비용이 크지는 않지만 성능에 민감한 상황에서는 문제가 될 수 있다.
  • 점층적 생성자 패턴보다 코드가 장황해서 매개변수가 4개 이상은 되어야 가치가 있다.
    • 대안: Lombok @Builder

정리

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

profile
초코칩
초코칩처럼 달콤한 코드를 짜자
이전 포스트

[이펙티브 자바] 1. 생성자 대신 정적 팩터리 메서드를 고려하라.

다음 포스트

[이팩티브 자바] 3. private 생성자나 열거 타입으로 싱글턴임을 보증하라.

0개의 댓글