생성자와 매개변수의 제약
정적 팩터리 메서드와 생성자는 선택적 매개변수가 많을 때 적절히 대응하기 어렵다는 공통점이 있다. 이런 제약이 있을 때 유용한 방법이 [점층적 생성자 패턴]이다.
점층적 생성자 패턴
필수 매개변수 1개와 선택 매개변수를 1개 받는 생성자, 필수 매개변수 1개와 선택 매개변수를 2개까지 받는 생성자... 이런 방식으로 선택 매개변수를 모두 받는 생성자까지 매개변수를 늘려가는 방식이다.
[점층적 생성자 패턴 사용 경우]
public class PersonInformation {
private String name; // 필수
private int age; // 필수
private String address;
private String number;
private String email;
public PersonInformation(final String name, final int age) {
this(name, age, null);
}
public PersonInformation(final String name, final int age, final String address, final String number) {
this(name, age, address, null);
}
public PersonInformation(final String name, final int age, final String address, final String number, final String email) {
this(name, age, address, number, null);
}
public PersonInformation(final String name, final int age, final String address, final String number, final String email) {
this.name = name;
this.age = age;
this.address = address;
this.number = number;
this.email = email;
}
}
...
PersonInformation personInformation = new PersonInformation("이름",25, "서울시","010-xxxx-xxxx","asdf@naver.com"); // 인스턴스 생성보통 이런 생성자는 사용자가 설정하길 원치 않는 매개변수까지 값을 지정해줘야 한다. 이런 코드의 경우 위의 예시처럼 매개변수가 적을경우에는 나쁘지 않아 보이지만 매개변수가 많아지면 코드를 작성하거나 읽기 어려워 질 수 있다.
코드의 각 값의 의미가 헷갈릴 수 있고, 매개변수 개수도 확인해야 할 수 있다. 또한 매개변수의 순서를 바꿔 건내줘도 컴파일러는 알아채지 못하고 런타임에 잘못된 동작을 할 수도 있기 때문이다.
이렇게 매개변수가 많을 때 활용할 수 있는 대안으로 [자바빈즈 패턴] 이 있다.
자바빈즈 패턴(JavaBeans pattern)
자바빈즈 패턴은 매개변수가 없는 생성자로 객체를 만든 후, 세터(setter) 메서드들을 호출해 원하는 매개변수의 값을 설정하는 방식이다.
[자바빈즈 패턴 사용 경우]
public class PersonInformation {
private String name;
private int age;
private String address;
private String number;
private String email;
public PersonInformation() {
}
public void setName(final String name) {
this.name = name;
}
public void setAge(final int age) {
this.age = age;
}
public void setAddress(final String address) {
this.address = address;
}
public void setNumber(final String number) {
this.number = number;
}
public void setEmail(final String email) {
this.email = email;
}
}
...
PersonInformation personInformation = new PersonInformation();
personInformation.setName("토마스");
personInformation.setAge(20);
personInformation.setAddress("서울특별시");
personInformation.setNumber("010-xxxx-xxxx");
personInformation.setEmail("asdf@naver.com");
// 인스턴스 생성하지만, 이런 자바빈즈 패턴 을 이용할 경우 심각한 단점이 있다. 객체 하나를 만드는데 여러 메서드를 호출해야하고, 객체가 완전히 생성되기 전까지는 일관성(consistency) 이 무너진 상태에 놓이게 된다.
점층적 생성자 패턴 에서는 매개변수들이 유효한지를 생성자에서만 확인하면 일관성을 유지할 수 있는데 그 장치가 사라진 것이다. 이처럼 일관성이 떨어지는 문제 때문에 자바빈즈 패턴 에서는 클래스를 불변 으로 만들 수 없다.
이런 점층적 생성자 패턴과 자바빈즈 패턴의 단점들을 보완하고 이들의 장점을 겸비한 대안이 빌더 패턴 이다.
빌더 패턴(Builder pattern)
빌더 패턴 구현 방법
첫 번째, 클라이언트는 필요한 객체를 직접 만드는 대신, 필수 매개변수만으로 생성자 (혹은 정적 팩터리)를 호출해 빌더 객체를 얻는다.
두 번째, 빌더 객체가 제공하는 세터 매서드를 이용해 원하는 선택 매개변수들을 설정한다.
세 번째, 매개변수가 없는 build 메서드를 호출해 필요한 (보통은 불변인) 객체를 얻는다. (빌더는 생성할 클래스 안에 정적 멤버 클래스로 만들어 두는것이 보통이다.)
[빌더 패턴 사용 경우]
public class PersonInformation {
private String name; // 필수
private int age; // 필수
private String address;
private String number;
private String email;
public static class Builder {
private final String name; // 필수
private final int age; // 필수
private String address = "";
private String number = "";
private String email = "";
public Builder(final String name, final int age) {
// 유효성 검사 위치
this.name = name;
this.age = age;
}
public Builder address(final String val) {
// 유효성 검사 위치
address = val;
return this;
}
public Builder number(final String val) {
// 유효성 검사 위치
number = val;
return this;
}
public Builder email(final String val) {
// 유효성 검사 위치
email = val;
return this;
}
public PersonInformation build() {
return new PersonInformation(this);
}
}
private PersonInformation(Builder builder) {
name = builder.name;
age = builder.age;
address = builder.address;
number = builder.number;
email = builder.email;
}
public static PersonInformationBuilder builder(String name, int age){
return new PersonInformationBuilder(name, age);
}
}
...
PersonInformation personInformation = PersonInformation.builder("이름1",11)
.address("서울특별시...")
.number("010-xxxx-xxxx")
.email("asdf@naver.com")
.build(); // 객체생성 (읽고 쓰기 쉽다)PersonInformation 클래스는 불변이며, 모든 매개변수의 기본값들을 한곳에 모아 두었다. 빌더의 세터 메서드들은 빌더 자신을 반환하기 때문에 연쇄적으로 호출이 가능하다. 이런 방식을 메서드 연쇄(mehtod chaining) 이라고 한다.
빌더패턴 유효성 검사
첫 번째, 잘못된 매개변수 발견
빌더의 생성자와 메서드에서 입력 매개변수를 검사하고, build 메서드가 호출하는 생성자에서 여러 매개변수에 걸친 불변식을 검사해야 한다.
[빌더 패턴 유효성 검사]
public Builder number(final String val) {
if (val == null || val.equals("")) {
throw new IllegalArgumentException("phoneNumber is empty!");
}
phoneNumber = val;
return this;
}두 번째, 공격에 대비한 불변식 보장
빌더로부터 매개변수를 복사한 후 해당 객체 필드들도 검사해야 한다. 검사 후 잘못된 점을 발견하면 어떤 매개변수가 잘못되었는지를 알려주는 메시지를 담아 IllegalArgumentException을 던지면 된다.
빌더 패턴은 계층적으로 설계된 클래스와 함께 사용하기 좋다.
각 계층의 클래스에 관련 빌더를 멤버로 정의하자.
추상 클래스는 추상 빌더를, 구체 클래스는 구체 빌더를 갖게 한다.
[빌더 패턴 추상 클래스 사용 경우]
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();
// 하위클래스에서 이 메서드를 Overrideing 하여 this를 반환하도록 해야 한다.
protected abstract T self();
}
Pizza(Builder<?> builder){
toppings = builder.toppings.clone();
}
}Pizza.Builder 클래스는 재귀적 타입 한정 을 이용하는 제네릭 타입이다. 여기서 추상 메서드인 self를 더해 하위 클래스에서는 형변환하지 않고도 메서드 연쇄를 지원할 수 있다. self 타입이 없는 자바를 위한 이 우회 방법을 시뮬레이트한 셀프 타입 관용구(simulated self-type)라고 한다.
[Pizza의 하위 클래스 뉴욕 피자]
public class NewYorkPizza extends Pizza {
//Pizza의 하위 클래스 - 뉴욕피자
private final Size size;
// 크기 매개변수를 필수로 받는다.
public enum Size {
SMALL,
MEDIUM,
LARGE
}
public static class Builder extends Pizza.Builder<Builder> {
private final Size size;
public Builder(final Size size) {
this.size = Objects.requireNonNull(size);
}
@Override
public NewYorkPizza build() {
return new NewYorkPizza(this);
// 하위 클래스의 빌더가 정의한 build 메서드는 구체 하위 클래스를 반환한다. (NewYorkPizza.Builder는 NewYorkPizza 반환)
}
@Override
protected Builder self() {
return this;
}
}
NewYorkPizza(final Builder builder) {
super(builder);
size = builder.size;
}
}[Pizza의 하위 클래스 칼초네 피자]
public class Calzone extends Pizza{
//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);
// 하위 클래스의 빌더가 정의한 build 메서드는 구체 하위 클래스를 반환한다. (Calzone.Builder는 Calzone반환)
}
@Override
protected Builder self(){
return this;
}
}
private Calzone(Builder builder){
super(builder);
sauceInside = builder.sauceInside;
}
}각 하위클래스의 빌더가 정의한 build 메서드는 해당하는 구체 하위 클래스를 반환하도록 선언한다. 하위 클래스의 메서드가 상위 클래스의 메서드가 정의한 반환 타입이 아닌, 그 하위 타입을 반환하는 기능을 공변 반환 타이핑 이라 한다. 이 기능을 이용하면 클라이언트가 형변환에 신경 쓰지 않고도 빌더를 사용할 수 있다.
[계층적 빌더를 사용하는 클라이언트 코드]
NewYorkPizza newYorkPizza = new NewYorkPizza.Builder(NewYorkPizza.Size.SMALL)
.addTopping(Pizza.Topping.SAUSAGE)
.addTopping(Pizza.Topping.ONION)
.build();
Calzone calzone = new Calzone.Builder()
.addTopping(Pizza.Topping.HAM)
.sauceInside()
.build();이처럼 빌더를 이용하면 가변인수 매개변수를 여러 개 사용할 수 있다.Pizza 추상 클래스의 addToping메서드가 이렇게 구현되어 있다. 빌더 패턴은 상당히 유연하다. 빌더 하나로 여러 객체를 순회하면서 만들 수 있고, 빌더에 넘기는 매개변수에 따라 다른 객체를 만들 수도 있다.
빌더 패턴의 단점
빌더 패턴에도 단점이 있다,
첫 번째, 객체를 만들기에 앞서 빌더부터 만들어야 한다는 것이다.
두 번째, 성능에 민감한 상황에서는 빌더 생성 비용이 문제가 될 수 있다.
세 번째, 코드가 점층적 생성자 패턴보다 길어 매개변수가 4개 이상되어야 값어치를 한다.
정리
생성자나 정적 팩터리가 처리해야 할 매개변수가 많다면 빌더 패턴을 선택하는 것이 좋다. 비록 빌더 패턴이 매개변수가 많아야 값어치를 한다지만 API는 시간이 지날수록 매개변수가 많아지는 경향이 있음을 명심해야 한다.
정적 팩터리 메서드와 생성자는 매개변수가 많아질 경우 유연하게 처리하지 못한다는 단점이 있다. 이에 대한 대안으로 점층적 생성자 패턴과 자바빈즈 패턴이 있다.
점층적 생성자 패턴은 오버로딩을 통해 여러 생성자를 이용하는 방법이다. 매개변수가 많아지면 매개변수의 개수 그리고 순서가 복잡해지기 때문에 코드를 작성하거나 읽기가 어려워진다.
자바빈즈 패턴은 setter메소드를 이용해 값을 설정하는 방법이다. 객체 하나를 만드는데 여러 setter메서드를 호출해야하고, 객체 생성 후 setter메서드로 값을 변경할 수 있어 객체의 일관된 상태를 유지하지 못할 수 있다.
이 둘의 단점을 보완한 방법이 빌더 패턴이다. 빌더 패턴은 원하는 객체를 바로 생성하는 대신 클라이언트는 모든 필수 매개변수를 갖는 생성자(또는 정적 팩터리 메서드)를 호출하여 빌더 객체를 얻고 빌더 객체의 세터 메서드를 호출해 필요한 선택 매개변수 값을 설정해주는 방식으로 사용한다.
(정적 팩터리 메서드를 사용함으로써 new 키워드를 사용하여 객체 생성을 하지 않아도 된다. new 키워드 사용시 생성자와 헷갈릴 수 있다.)
따라서, 매개변수가 많거나(4개)이상 또는 앞으로 많아질 가능성이 있다면 빌더 패턴을 사용하는 것이 좋다. 빌더 패턴을 사용함으로써 매개변수가 추가되는 상황에 직면하여도 기존 코드를 수정하지 않아도 될 수 있고 각 데이터를 추가할 때 호출되는 메소드 명을 통해 가독성을 향상시킬 수 있다. 또한 setter를 사용하지 않음으로써 객체 불변성을 확보할 수 있다.
[Reference]
이펙티브자바 아이템 2. 생성자에 매개변수가 많다면 빌더를 고려하라
이펙티브자바 3판 아이템 2. 생성자에 매개변수가 많다면 빌더를 고려하라
기계인간-빌더패턴
