생성자에 매개변수가 많다면 빌더를 고려해라
기존의 생성자나 팩토리 메소드는 매개변수의 양이 많아지면 이를 컨트롤하기 어려웠다. 멤버변수의 양이 늘어나면 이를 수습하기가 어려워지기 때문이다. 이런 경우 우리는 빌더 패턴을 사용할 수 있다.
public clas 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 fianl 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(Builder builder) {
servingSize = builder.servingSize;
servings = builder.servings;
calories = builder.calories;
fat = builder.fat;
sodium = builder.sodium;
carbohydrate = builder.carbohydrate;
}
}이 클래스는 기본적으로 불변이며, 모든 매개변수의 기본값들을 한곳에 모아뒀다. 빌더의 setter 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다. 이런 방식을 메서드 호출이 흐르듯 연결된다는 뜻으로 플루언트 API 혹은 메서드 연쇄라 한다. 이것은 파이썬과 스칼라의 명명된 선택적 매개변수를 흉내낸 것이다.
NutritionFacts cocaCola = new NutritionFacts.Builder(240, 8) // 1) 빌더 객체 반환
.calories(100)
.sodium(35)
.carbohydrate(27) // 2) setter 메서드들로 매개변수 설정
.build(); //(3) 필요객체 반환계층적인 클래스와 쓰기
빌더 패턴은 계층적으로 설계된 클래스와 함꼐 쓰기에 좋다. 각 계층의 클래스에 관련 빌더를 멤버로 정의하고, 추상 클래스는 추상 빌더를, 구체 클래스는 구체 빌더를 갖게 한다. 다음은 피자의 다양한 종류를 표현하는 계층구조의 루트에 놓인 추상 클래스다.
public abstract class Pizza {
public enum Topping { HAM, MUSHROOM, ONION, PEPPER , SUSAGE };
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.requestNonNull(topping));
return self();
}
abstract Pizza build();
// 하위 클래스는 이 메서드를 재정의하여
// this를 반환하도록 해야한다.
protected abstract T self();
}
Pizza(Builder<?> builder) {
toppings = builder.toppings.clone();
}
}Pizza.Builder 클래스는 제네릭 타입이며, 추상 메서드인 self를 더해 하위 클래스에서 형변환을 하지 않고도 메서드 연쇄를 지원할 수 있다. self 타입이 없는 자바를 위한 이 우회방법을 시뮬레이트한 셀프타입 관용구라고 한다.
Pizza의 하위 클래스로 뉴욕 피자와 칼초네 피자가 있다. 뉴욕 피자는 크기 매개변수를 필수로 받고, 칼초네 피자는 소스를 넣을지 선택하는 매개변수를 필수로 받는다.
public class NyPizza extends Pizza {
public enum Size {SMALL, MEDIUM, LARGE};
private final Size size;
public statc 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 statc class Builder extends Pizza.Builder<Builder> {
private boolean sauceInside = false; //default
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;
}
}각 하위 클래스의 빌더가 정의한 build() 메서드는 해당하는 구체 하위 클래스를 반환하도록 선언하여NyPizza.Builder는 NyPizza를, Calzone.Builder는 Calzone은 반환하도록 한다. 하위 클래스의 메서드가 상위 클래스의 메서드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변반환 타이핑이라 한다. 이런 식으로 사용하면 클라이언트가 형변환에 신경 쓰지 않고도 빌더를 사용할 수 있다.
이런 계층적 빌더를 사용하는 클라이언트의 코드도 영양정보 빌더를 사용하는 코드와 다르지 않다. 클라이언트에서 열거 타입 상수를 정적 임포트하고 가정하고 작성한 것이다.
NyPizza pizza = new NyPizza.Builder(SMALL).addTopping(SAUSAGE).addTopping(ONION).build();
Calzone calzone = new Calzone.Builder.addTopping(HAM).sauceInside().builder();특징
- 매개변수가 4개 이상은 되어야 값어치를 하는 패턴이다.
- 매개변수 중 다수가 필수가 아니거나 같은 타입일 때 쓰면 좋다.
- 빌더는 점층적 생성자보다 클라이언트 코드를 읽고 쓰기 훨씬 간결하고, 자바빈즈보다 훨씬 안전하다.
