빌더 패턴이 필요한 이유
정적 팩터리와 생성자는 선택적 매개변수가 많을 때 적절히 대응하기가 어렵다. 선택적 매개변수가 많은 클래스를 생성하는 다양한 방법을 살펴보고 왜 빌더 패턴이 다양한 매개변수를 처리하기에 유리한지 알아보자.
점층적 생성자 패턴
// 코드 2-1: 점층적 생성자 패턴은 확장하기 어렵다! (14~15쪽)
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 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;
}
public static void main(String[] args) {
NutritionFacts coke =
new NutritionFacts(240, 8, 100, 0, 35, 27);
}
}
NutritionFacts는 필수 필드2개와 선택 필드 4개로 이루어진 클래스다. 필수 필드 2개만 받는 생성자부터 모든 필드 6개를 받는 생성자까지 총 5개의 생성자를 만들었다. 사용자는 원하는 매개변수를 포함한 생성자 중 가장 짧은 것을 골라 호출하면 된다. 그러나 고른 생성자에 원치 않는 매개변수가 있어도 값을 넘겨줘야 한다. 무엇보다 매개변수 개수가 많아질수록 생성자가 걷잡을 수 없이 늘어나서 확장이 어렵고 클라이언트 코드도 읽기 힘들어지게 된다.
자바빈즈 패턴
// 코드 2-2 자바빈즈 패턴 - 일관성이 깨지고, 불변으로 만들 수 없다. (16쪽)
public class NutritionFacts {
// 매개변수들은 (기본값이 있다면) 기본값으로 초기화된다.
private int servingSize = -1; // 필수; 기본값 없음
private int servings = -1; // 필수; 기본값 없음
private int calories = 0;
private int fat = 0;
private int sodium = 0;
private int carbohydrate = 0;
public NutritionFacts() { }
// Setters
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; }
public static void main(String[] args) {
NutritionFacts cocaCola = new NutritionFacts();
cocaCola.setServingSize(240);
cocaCola.setServings(8);
cocaCola.setCalories(100);
cocaCola.setSodium(35);
cocaCola.setCarbohydrate(27);
}
}
빈 생성자로 객체를 만들고 세터 메서드를 호출하여 값을 초기화 해준다. 그러나 객체 하나를 만들 기 위해 메서드를 여러개 호출해야 하고 모든 필드의 값을 set하기 전까지 객체의 일관성(consistency)이 무너진 상태에 놓이게 된다. 또한 필드의 값을 수정할 수 있는 메서드를 만들었기 때문에 객체의 불변성을 유지할 수 없다.
빌더 패턴
// 코드 2-3 빌더 패턴 - 점층적 생성자 패턴과 자바빈즈 패턴의 장점만 취했다. (17~18쪽)
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;
}
public static void main(String[] args) {
NutritionFacts cocaCola = new NutritionFacts.Builder(240, 8)
.calories(100).sodium(35).carbohydrate(27).build();
}
}클라이언트는 필수 매개변수만으로 생성자(혹은 정적 팩터리)를 호출해 빌더 객체를 얻는다. 빌더 객체는 생성할 객체와 똑같은 필드들을 가지고 있다. 그 다음 빌더 객체의 일종의 세터 메서드들로 원하는 선택 매개변수들을 설정한다. 세터 메서드들을 필드의 이름과 똑같이 지어주면 클라이언트 입장에서 직관적으로 사용할 수 있다. 세터메서드들은 자기 자신(빌더 객체)를 반환해서 메서드 체이닝 방식(method chaining)으로 사용할 수 있게끔 한다.
원하는 필드들을 모두 설정해줬다면 build() 메서드를 호출한다. 빌더가 생성할 클래스의 생성자를 자신을 매개변수로 넘겨서 호출한다. 생성자에서는 빌더의 필드와 동일한 값으로 필드들을 초기화 한다. 보통 빌더는 생성할 클래스의 정적 멤버 클래스로 만들어둔다.
유효성 검사는 build() 메서드가 호출하는 생성자에서 여러 매개변수의 불변식(invariant)을 검사한다. 불변식(invariant)은 불변(immutable)보다 더 큰 의미를 가진다. 불변식은 정해진 기간동안 반드시 만족해야하는 조건을 말한다. 예를 들어 리스트의 크기는 항상 0이상 이어야 한다. 불변은 불변식의 극단적인 예다.
빌더 패턴 + 계층적 클래스
빌더 패턴은 계층적으로 설계된 클래스와 함께 쓰기 좋다. 추상 클래스는 추상 빌더를, 구체 클래스는 구체 빌더를 가진다.
Pizza.Builder 클래스는 재귀적 타입 한정 을 이용하는 제네릭 타입이다.
추상 메서드 self()는 self 타입이 없는 자바를 위한 우회 방법인 시뮬레이트한 셀프 타입(simulated self-type) 이다. 자식 클래스는 self() 메서드에서 자기 자신을 반환하게 재정의함으로써 형변환 없이 추상 클래스의 빌더를 사용할 수 있게 된다.
하위 클래스의 build()는 상위 클래스가 아닌 구체 하위 클래스를 반환한다. 이런 기능을 공변 변환 타이핑(covariant return typing) 이라고 한다. 클라이언트가 형변환 없이 빌더를 사용할 수 있게 된다.
빌더 패턴을 사용하면 addTopping 메서드 처럼 여러번에 걸쳐 가변인수(varargs) 매개변수를 여러 개 사용할 수 있다.
import java.util.EnumSet;
import java.util.Objects;
import java.util.Set;
// 코드 2-4 계층적으로 설계된 클래스와 잘 어울리는 빌더 패턴 (19쪽)
// 참고: 여기서 사용한 '시뮬레이트한 셀프 타입(simulated self-type)' 관용구는
// 빌더뿐 아니라 임의의 유동적인 계층구조를 허용한다.
public abstract class Pizza {
public enum Topping { HAM, MUSHROOM, ONION, PEPPER, SAUSAGE }
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();
// 하위 클래스는 이 메서드를 재정의하여 "this"를 반환하도록 해야 한다.
protected abstract T self();
}
Pizza(Builder<?> builder) {
toppings = builder.toppings.clone();
}
}import java.util.Objects;
// 코드 2-5: 계층적 빌더를 활용한 하위 클래스 (20쪽)
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;
}
}public class PizzaTest {
public static void main(String[] args) {
NyPizza pizza = new NyPizza.Builder(SMALL)
.addTopping(SAUSAGE).addTopping(ONION).build();
Calzone calzone = new Calzone.Builder()
.addTopping(HAM).sauceInside().build();
System.out.println("pizza = " + pizza);
System.out.println("calzone = " + calzone);
}
}빌더 패턴은 생성자에서 매개변수를 4개 이상 받을 때 그 값어치를 한다. API는 시간이 지날수록 매개변수가 많아지는 경향이 있어 애초에 빌더로 시작하는 편이 나을 때가 많다.
그러나 객체를 만들기 앞서 빌더부터 만들어야 하기 때문에 성능이 민감한 상황에서 문제가 될 수도 있다.
