Effective Java - Item 2
Updated:
Effective Java
Item 2. 생성자에 매개변수가 많다면 빌더를 고려하라
점층적 생성자 패턴(telescoping constructor pattern)
정적 팩터리 메서드와 생성자 모두 선택적 매개변수가 많을때 적절히 대응하기 어렵다.
일반적으로 여러개의 필수 매개변수와 선택 매개변수를 받을 때 점층적 생성자 패턴을 사용하였다.
점층적 생성자 패턴
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;
}
}
위와 같은 패턴은 사용자가 설정하길 원치 않는 매개변수까지 포함하기 쉬운데, 어쩔 수 없이 그런 매개변수에도 값을 지정해줘야 한다.
또한 클라이언트 실수로 매개변수의 순서를 바꿔 건네주어도 컴파일러가 알아채지 못하고, 찾기 어려운 버그로 이어질 수 있다.
즉 매개변수 개수가 많아지면 클라이언트 코드를 작성하거나 읽기 어렵다
자바빈즈 패턴(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() {}
// Setter 매서드들
public void setServingSize(int servingSize) { this.servingSize = servingSize; }
public void setServings(int servings) { this.servings = servings; }
public void setCalories(int calories) { this.calories = calories; }
public void setFat(int fat) { this.fat = fat; }
public void setSodium(int sodium) { this.sodium = sodium; }
public void setCarbohydrate(int carbohydrate) { this.carbohydrate = carbohydrate;}
}
점진적 생성자 패턴의 단점이 보이지 않음.
코드가 길어지지만, 인스턴스를 만들기 쉽고, 그 결과 더 읽기 쉬운 코드가 되었다.
자바빈즈 사용
NutritionFacts cocaCola = new NutritionFacts();
cocaCola.setServingSize(240);
cocaCola.setServings(8);
cocaCola.setCalories(100);
cocaCola.setSodium(35);
cocaCola.setCarbohydrate(27);
하지만 자바빈즈는 자신만의 심각한 단점을 가지고 있다.
자바빈즈 패턴에서는 객체 하나를 만들려면 메서드를 여러 개 호출해야 하고, 객체가 완전히 생성되기 전까지는 일관성(consistency)이 무너진 상태에 놓인다.
객체 일관성이 깨진다는 것이란, 한번 객체를 생성할때, 그 객체가 변할 여지가 존재한다는 뜻이다.
즉, set메서드는 언제 어디서든 사용 할 수 있다는 장점이 있지만, 객체의 불변성이 깨진다.
스레드 작업에 큰 단점이 될 수 있을 뿐더러, 컴파일러 오류는 아니지만, 우리가 원하지 않는 결과물이 만들어 질 수 있는것이다.
위 문제 때문에 자바빈즈 패턴에서는 클래스를 Immutable으로 만들 수 없으며 스레드 안전성을 얻으려면 프로그래머가 추가 작업을 해줘야만 한다.
빌더 패턴(Builder pattern)
점층적 생성자 패턴의 안전성과 자바빈즈 패턴의 가독성의 장점을 가지고 있는 패턴이다.
클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자(혹은 정적 팩토링 메소드)를 호출해 빌더 객체를 만든다.
public class BuilderPattern {
public static 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.servings = servings;
this.servingSize = servingSize;
}
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);
}
}
// NutritionFacts 생성자
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();
}
}
이 클라이언트 코드는 쓰기 쉽고, 읽기 쉽다.
NutritionFacts 클래스는 Immutable이며, 모든 매개변수의 기본값들을 한곳에 모아두었다.
빌더의 세터 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출 할 수 있다.
이런 방식을 매서드 호출이 흐르듯 연결된다는 뜻으로 Fluent Api 혹은 메소드 연쇄(Method chaining) 이라고 한다.
유효성 검사 코드는 생략하였고, 잘못된 매개변수를 최대한 일찍 발견하려면 빌더의 생성자와 매서드에서 입력 매개변수를 검사한다.
빌더 패턴의 단점
- 객체를 만들려면, 그에 앞서 빌더부터 만들어야한다. 이는 빌더 생성 비용이 크지는 않지만 성능에 민감한 상황에서는 문제가 될 수 있다.
- 점층적 생성자 패턴보다 코드가 장황해서 매개변수가 4개 이상은 되어야 값어치를 한다.
- 하지만 API는 시간이 지날수록 매개변수가 많아지는 경향이 있으므로, 애초에 빌더로 시작하는 편이 나을때가 많다.
정리
생성자나 정적 팩터리가 처리해야 할 매개변수가 많다면 빌더 패턴을 선택하는 게 더 낫다.
매개변수 중 다수가 필수가 아니거나 같은 타입이면 특히 더 그렇다.
빌더는 점층적 생성자보다 클라이언트 코드를 읽고 쓰기가 훨씬 간결하고, 자바빈즈보다 훨씬 안전하다.
출처
Joshua Bloch. Effective Java 3/E. n.p.: 인사이트, 2018년 11월 1일.
“Java - Builder 패턴 적용하기.,” 개발자 홀로 서기, https://mommoo.tistory.com/54.
