[JAVA] 빌더 패턴(Builder Pattern)에 대해 알아보자

빌더 패턴은 디자인 패턴 중 하나로써 의도는 생성과 표현의 분리입니다.

그런데 이렇게만 쓰면 감이 잘 안올 수 있으니 실제 사례를 말해보겠습니다.

내 경우 map 에 담아서 데이터를 활용한 경우가 많은데 코드가 간단할 경우 상관없었지만 로직이 복잡할수록 관리가 잘 안되었습니다. 가령 처음 Map에 testCode 라는 키에 값을 넣었는데, 해당 키값을 계속 재활용 하다보니 로직의 마지막에는 testCode에 어떤 것이 들어있는지 재차 확인을 해야할 때가 있었습니다. 혹은 필요한 키=값이 있어야하는데 그게 있는지 없는지 애매한 경우도 포함해서 Map 안에 어떤 값들이 있는지 파악이 안되는 경우도 종종 있었고요. 이런경우 만들때는 관련 로직을 계속 머릿속에 담아두기에 수월하게 만들다가 유지보수 or 개선해야 할 때 대부분 잊어버려 데이터흐름을 일일히 따라가는데 어려움을 겪기도 했고요. 그래서 차선책으로 Map을 새로 생성하여 관리하는 방법을 쓰기도 했는데, 보다 직관적인 것으로 변경할 필요성이 있어 빌더 패턴을 사용하게 되었습니다.

그럼 이제 어떻게 사용하는지 알아보겠습니다. 다음 유저정보를 담는 객체가 있습니다.

/**
*  다음과 같이 객체를 만듭니다.
*/
public class UserInfo {
   private String name;
   private int age;
   private String addr;

   public UserInfo(String name, int age, String addr){
       this.name = name;
       this.age = age;
       this.addr = addr;
   }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getAddr() {
        return addr;
    }

    public void setAddr(String addr) {
        this.addr = addr;
    }

    public String getUserInfo(){
       return String.format("name: %s, age: %d, addr: %s", name, age, addr);
    }
}

객체를 사용할 때 다음과 같이 합니다.

UserInfo userInfo = new UserInfo("테스터", 25, "서울시 강남구");
System.out.println(userInfo.getUserInfo());

// 결과 => name: 테스터, age: 25, addr: 서울시 강남구

만약 위의 예제에서 주소를 입력하지 않는다면 다음과 같이 생성할 수 있습니다.

UserInfo userInfo2 = new UserInfo("테스터", 25, null);
System.out.println(userInfo2.getUserInfo());

// 결과 => name: 테스터, age: 25, addr: null

다만 이렇게하면 null 을 입력하는 것은 모양새가 좋지 않으니 추가로 생성자를 만들어 주는 방법이 있겠네요.

그런데 만약 요건이 자주 변경된다면 매번 생성자를 만드는 것도 일이 될 것입니다.

그래서 이런 상황을 피하기 위해 좀 더 직관적인 객체를 만들 수 있게 돕는 것이 바로 빌더 패턴 입니다.

빌더 패턴을 적용 시에는 다음의 효과를 기대할 수 있습니다.

1) 불필요한 생성자 제거

2) 데이터의 순서에 상관없이 객체 생성 가능

3) 명시적 선언으로 이해하기 쉬움.

다음은 빌더 패턴을 적용한 빌더클래스를 만들어 보겠습니다.

/**
* 위에서 사용한 UserInfo 클래스에 빌더 패턴을 적용한 클래스
*/
public class UserInfoBuilder {
    private String name;
    private int age;
    private String addr;

    public UserInfoBuilder setName(String name){
        this.name = name;
        return this;
    }

    public UserInfoBuilder setAge(int age){
        this.age = age;
        return this;
    }

    public UserInfoBuilder setAddr(String addr){
        this.addr = addr;
        return this;
    }

    public UserInfo build(){
        return new UserInfo(name, age, addr);
    }
}

객체를 다음과 같이 사용합니다.

UserInfoBuilder userInfoBuilder = new UserInfoBuilder();
UserInfo userInfo3 = userInfoBuilder
        .setName("테스터3")
        .setAddr("주소")
        .setAge(26)
        .build();

System.out.println(userInfo3.getUserInfo());

// 결과 => name: 테스터3, age: 26, addr: 주소

여기서 좋은점은 생성자를 이용해 만든게 아니기 때문에 순서를 마음대로 해도 된다는 점입니다. 

여기서 아쉬운 것이 하나 있는데, 대상클래스와 그것을 연결할 빌더클래스 2개를 생성해야 합니다. 혹은 내부클래스로도 가능하긴 하지만요. 하지만 그것보다 코드를 압도적으로 줄여주는 플러그인이 있는데 바로 Lombok 입니다.

(링크) lombok 설정하기
http://lemontia.tistory.com/445

UserInfo 클래스와 닮은 클래스를 다음과 같이 새로 추가해보겠습니다.

import lombok.Builder;
import lombok.Data;

@Data
@Builder
public class UserInfoLombok {
    private String name;
    private int age;
    private String addr;
}

사용하는 방법은 아래와 같습니다

UserInfoLombok userInfoLombok = UserInfoLombok.builder()
        .name("Lombok 적용")
        .addr("주소 테스트")
        .build();

System.out.println(userInfoLombok);

// 결과=> UserInfoLombok(name=Lombok 적용, age=0, addr=주소 테스트)

코드가 훨씬 간단해 졌습니다. 그리고 lombok 을 사용하면 추가기능을 기대할 수 있는데요

특정 변수에 기본값을 설정할 수 있습니다.

@Data
@Builder
public class UserInfoLombok {
    private String name;
    @Builder.Default private int age = 30;
    private String addr;
}

UserInfoLombok userInfoLombok = UserInfoLombok.builder()
        .name("Lombok 적용")
        .addr("주소 테스트")
        .build();

// 결과=> UserInfoLombok(name=Lombok 적용, age=30, addr=주소 테스트)