이펙티브 자바 읽고 정리해보기 2.

아이템 2 : 생성자에 매개변수가 많다면 빌더를 고려하라

정적 팩터리와 생성자 방식은 선택적 매개변수에 관련해 동일한 제약을 공유한다. 선택 매개변수가 많아질 수록 대응이 어렵다는 점이다. 이 경우 점층적 생성자 패턴을 통해 모든 경우의 수에 해당하는 생성자를 만들어 이 경우에 대비할 수 있으나, 이는 매개변수가 많아질 수록 코드 가독성과 작성 난이도가 올라가는 것은 똑같다

다른 대안으로 자바 빈즈 패턴을 이용해 매개변수가 없는 생성자로 객체를 만든 후, 설정자를 이용해 원하는 매개변수의 값을 설정하는 것이다

public class A {
	// 기본값이 있는 경우, 매개변수는 초기화된다
	private int a = -1; // 필수; 기본값 없음
    private int b = -1; // 필수; 기본값 없음
    private int c = 0;
    private int d = 0;
    
    public A() {}
    
    public void setA(int val) { a = val; }
    public void setB(int val) { b = val; }
    public void setC(int val) { c = val; }
    public void setD(int val) { d = val; }
}

이렇게 선언한 클래스에서,

A a = new A();
a.setA(100);
a.setB(205);

이와 같이 클래스 A에 있는 선택 매개변수 a와 b만 존재하는 인스턴스를 만들 수 있다. 이의 단점으로  인스턴스 하나를 위한 메서드가 많이 필요하며, 객체가 완성되기 전까지 일관성이 무너져 있다. 점층적 생성자 패턴에서는 매개변수의 유효성을 생성자에서만 확인하면 되나, 빈즈의 경우에 일관성이 깨져 버그 코드와 런타임 시 버그 코드로 인해 오류가 발생하는 코드 간 물리적인 거리가 커져 디버깅의 난이도가 상승한다. 이렇기 때문에 자바 빈즈에서는 클래스를 불변으로 만들 수가 없어, 스레드 안정성을 얻기 위해서는 개발자의 추가 작업이 필요하다. 이를 보완하는 방법으로 생성이 끝난 객체를 수동으로 얼리고, 얼리기 전에는 사용할 수 없도록 하는 방법이 있지만 이는 실무에서 거의 쓰이지 않는다

최종 대안으로 빌더 패턴이 있다. 클라이언트는 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자를 호출해 빌더 객체를 얻는다. 그 후 빌더의 유사 설정자 메서드를 통해 선택 매개변수를 설정한 후, 마지막에 build()를 통해 객체를 얻을 수 있다

public class A {
private final int a;
    private final int b;
    private final int c;
    private final int d;

	public static class Builder {
    	// 필수
        private final int a;
        private final int b;
        
        // 선택 : 기본값으로 초기화
        private int c = 0;
        private int d = 0;
        
        public Builder(int a, int b) {
        	this.a = a;
            this.b = b;
        }
        
        public Builder c(int val) {
        	c = val; return this;
        }
        
        public Builder d(int val) {
        	d = val; return this;
        }
        
        public A build() {
        	return new A(this);
        }
    }
    
    private A(Buider builder) {
    	a = builder.a;
        b = builder.b;
        c = builder.c;
        d = builder.d;
    }
}

위와 같이 빌더 패턴이 완성된 클래스의 객체는 다음과 같이 얻을 수 있다

A a = new A.Builder(1, 2).c(3).d(4).build();

추후 매개변수의 유효성 검사는 빌더의 생성자와 메서드에서 추가하고 build 메서드가 호출하는 생성자에서 불변식을 검사할 수 있다. 거기에 불변식을 보장하기 위해 빌더로부터 해당 매개변수를 복사한 후, 해당 객체 필드도 검사할 수 있다(아이템 50). 오류가 발견되는 경우 IllegalArgumentException을 던지면 된다(아이템 75)

+ 불변식이란, 프로그램이 실행되는 동안, 또는 정해진 기간 동안 반드시 만족해야하는 조건이다. 변경을 허용할 수 있지만, 주어진 조건 내에서만 변경이 가능하다. 따라서 가변 객체에도 불변식은 존재할 수 있으며, 불변식의 극단이 불변이다

 

빌더 패턴은 계층적으로 설계된 클래스와 함께 쓰기에 좋다. 각 계층 클래스에 관련 빌더를 멤버로 정의해 추상 클래스는 추상 빌더, 구체 클래스는 구체 빌더를 갖게 한다

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(); // + 아이템 50
    }
}

Pizza.Builder 클래스는 재귀적 타입 한정(아이템 30)을 이용하는 제네릭 타입이다. 추상 메서드인 self()를 더해 하위 클래스에서 형변환하지 않고 메서드 연쇄를 지원할 수 있으며 simulated self-type 관용구라고 한다

pulbic class NyPizza extends Pizza {
	public enum Siza { SMALL, MEDIUM, LARGE }
    private final Size size;
    
    public static clasa Builder extends Pizza.Builder<Builder> {
    	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;
    }
}

pulbic class Calzone extends Pizza {
    private final boolean sauceInside;
    
    public static clasa 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;
    }
}

구체 클래스 2가지 예시이며, 각 하위 클래스의 builde 메서드는 해당 구체 하위 클래스를 반환한다. 하위 클래스의 메서드가 상위 클래스 메서드의 반환타입이 아닌 하위 타입을 반환하는 기능을 공변 반환 타이핑(covariant return typing)이라고 한다. 이로 인해 클라이언트가 형변환을 신경쓰지 않아도 된다

NyPizza nyPizza = new NyPizza.Builder(SMALL).addTopping(SAUSAGE).addTopping(ONION).build();

Calzone calzone = new Calzone.Builder().addTopping(HAM).sauceInside().build();

가변인수 매개변수를 여러개 사용할 수 있어, 적절한 메서드로 나눠 선언하거나 메서드를 여러번 호출하고 각 매개변수를 하나의 필드로 모을 수도 있다(addTopping())

 

빌더 패턴 하나로 여러 객체를 순회하며 만들 수 있고, 빌더에 넘기는 매개변수에 따라 다른 객체를 만들 수 있고, 객체 고유 일련번호 등은 빌더에서 알아서 채우게 만들 수도 있다

 

객체를 만들기 위해선, 빌더부터 만들어야되는 단점이 존재한다. 또한 점층적 생성자 패턴보다 장황하기 때문에 매개변수 4개 이상은 되어야 유의미하다. 하지만 API의 경우, 매개변수는 시간이 지날수록 증가할 가능성이 높으므로, 처음부터 정적 팩터리나 생성자로 구현하는 것보다 빌더 패턴이 좋은 선택일 수 있다