책 소개
[ 이펙티브 자바 3/E ] https://www.yes24.com/Product/Goods/65551284
item2 : 생성자에 매개변수가 많다면 빌더를 고려하라
정적 팩터리 메서드와 생성자는 선택적 매개변수가 많을때 적절한 대응이 어렵다.
이러한 케이스에서는 같은 방법을 사용하였다.
- 점층적 생성자 패턴 (telescoping constructor pattern)
- 자바 빈즈 패턴
- 빌더 패턴
1. 점층적 생성자 패턴
필수 매개변수 : 인스턴스 생성에 꼭 필요한 변수
선택 매개변수 : 인스턴스 생성에 있어도 되고 없어도 되는 변수
점층적 생성자 패턴
- 필수 매개 변수만 받는 생성자
- 필수 매개변수 + 선택 매개변수 1개를 받는 생성자
- 필수 매개변수 + 선택 매개변수 2개를 받는 생성자
- …
- "선택 매개변수를 전부 다 받는 생성자까지 점층적으로 늘려가는 방식"
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;
}
public static void main(String[] args) {
NutritionFacts cocaCola =
new NutritionFacts(240, 8, 100, 0, 35, 27);
}
}이 클래스의 인스턴스를 만들려면 원하는 매개변수를 모두 포함한 생성자 중에서 가장 짧은 것을 호출하면 된다. → NutritionFacts(240, 8, 100, 0, 35, 27)
단점
매개변수 개수가 많아지면 클라이언트 코드를 작성하거나 읽기 어렵다.
클라이언트가 실수로 매개변수의 순서를 바꿔 건네줘도 컴파일러는 알아차리지 못하고, 런타임에 엉뚱한 동작을 수행할 수 있다.
2. 자바 빈즈 패턴
자바 빈즈 패턴 (JavaBeans Pattern) : 매개변수가 없는 생성자로 객체를 만든 후, setter로 원하는 매개변수의 값을 설정하는 방식이다.
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);
}
}⇒ 코드가 길지만, 인스턴스를 만들기 더 쉽고, 더 읽기 쉬운 코드가 되었다.
단점
- 객체 하나를 만들려면 메서드 여러개를 호출해야한다
- 객체가 완전히 완성되기 전까지는 일관성(consistency)이 무너진 상태에 놓인다
- 점층적 생성자 패턴에서는 매개변수들이 유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있었지만 그 장치가 사라져 디버깅이 어렵다.
- 클래스를 불변으로 만들수 없어, 스레드 안정성을 얻기 위해서는 프로그래머의 추가 작업이 필요하다.
3. 빌더 패턴
빌더 패턴 : 점층적 생성자 패턴의 안전성과 자바 빈즈 패턴의 가독성을 겸비한 패턴
- 클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자를 호출해 빌더 객체를 얻는다
- 빌더 객체가 제공하는 Setter 메서드들로 원하는 선택 매개변수를 설정한다.
- 매개변수가 없는 build 매서드를 호출해 필요한 객체(불변 객체)를 얻는다.
빌더는 생성한 클래스 안에 정적 멤버 클래스로 만들어 두는 것이 보통이다.
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;
}
}⇒ 위 클래스는 불변이며, 각 setter 메서드는 자신을 반환하기 때문에 연쇄적으로 호출할 수 있다. 이를 플루언트 API(fluent API) 혹은 메서드 연쇄(method chaining)라 한다.
public static void main(String[] args) {
NutritionFacts cocaCola = new NutritionFacts.Builder(240, 8)
.calories(100).sodium(35).carbohydrate(27).build();
}위의 클라이언트 코드는 쓰기 쉽고, 읽기 쉽다.
빌더 패턴은 명명된 선택적 매개변수를 흉내낸것이다.
필더 패턴의 활용
빌더 패턴은 계층적으로 설계된 클래스와 함께 쓰기 좋다.
추상 클래스는 추상 빌더를, 구체 클래스는 구체 빌더를 갖게 한다.
아래 코드는 피자의 다양한 종류를 표현하는 계층 구조의 루트에 놓인 추상 클래스다.
public abstract class Pizza {
public enum Topping { HAM, MUSHROOM, ONION, PEPPER, SAUSAGE }
final Set<Topping> toppings;
abstract static class Builder<T extends Builder<T>> {
// T로 표현되는 타입이 Builder를 사용 가능해야 하므로, Builder를 구현한 클래스만 타입으로 사용해라
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(); // 아이템 50 참조
}
}- Pizza.Builder 클래스는 재귀적 타입 한정을 이용하는 제네릭 타입
- 이 클래스에 self()를 더해 하위 클래스는 형변환 하지 않고 메서드 연쇄를 지원할 수 있다.
뉴욕 피자
- 크기 (size)를 매개변수를 필수로 받는다.
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;
}
}칼조네 피자
- 소스를 안에 넣을지 선택(sauceInside)하는 매개변수를 필수로 받는다.
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;
}
}각 하위 클래스의 빌더가 정의한 build() 메서드는 해당하는 구체 하위 클래스를 반환하도록 선언한다.
NyPizza의 메서드(하위 클래스)가 Pizza의 메서드(상위 클래스)가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변 반환 타이핑이라 한다.
이 기능을 통해 클라이언트는 형 변환을 신경 쓰지 않고 빌더를 사용할 수 있게 된다.
빌버 패턴은 매우 유연하다. 빌더하나로 여러 객체를 순회하면 만들수도 있고, 빌더에 넘기는 매개변수에 따라 다른 객체를 만들수도 있다.
하지만 빌더부터 만들어야하기에 성능이 민감한 상황에서는 문제가 될수 있다.
점층적 생성자 패턴보다 코드가 장황하여 매개변수가 3-4개 이상 으로 많을 경우 사용하는 것이 좋다.
정리 !
생성자나 정적 팩터리가 처리해야할 매개변수가 많다면 빌더 패턴을 선택하라
빌더는 정측정 생성자보다 클라이언트의 코드를 읽고 쓰기 간결하고, 자바 빈즈보다 안전하다.
success is within reach, allow yourself time