빌더 패턴(Builder Pattern)

Entity, Dto에서 자주 사용하는 @Builder 어노테이션의 역할과 의미를 확실히 이해하고 싶어 정리해보았다.

 

빌더 패턴

- 객체를 생성할 때 사용하는 디자인 패턴이다. 생성자에서 인자가 많을 때 빌더 패턴의 사용을 고려해볼 수 있다.

- 클래스를 설계할 때 필수로 받아야 할 인자와 선택적으로 받아야 할 인자가 존재한다면 클래스의 객체를 생성할 때, 사용할 수 있는 디자인 패턴은 점층적 생성자 패턴, 자바 빈즈 패턴, 빌더 패턴으로 총 3가지가 있다.

 

먼저 점층적 생성자 패턴부터 알아보자

 

 

점층적 생성자 패턴

- 생성자로 데이터를 받아 객체를 생성한다.

- User 객체 생성 시, 필수 값은 id, userName이며 선택 값은 nickName, age다.

public class User {

    private int id;           //ID(필수)
    private String userName;  //이름(필수)
    private String nickname;  //별명(선택) 
    private int age;          //나이(선택)

    public User(int id, String userName){
        this(id, userName, null, 0);
    }

    public User(int id, String userName, String nickname){
        this(id, userName, nickname, 0);
    }

    public User(int id, String userName, String nickname, int age){
        this.id = id;
        this.userName = userName;
        this.nickname = nickname;
        this.age = age;
    }

User user = new User(1, "emily", "emily11", 22);

점층적 생성자 패턴의 단점은 다음과 같다.

  ⦁ 매개변수 조합이 많을 수록 생성자 수가 많아진다. → 가독성 저하, 비효율적 코드

  ⦁ 생성자 호출시, 매개변수의 위치를 알고 있어야 한다.

 

 

자바 빈즈 패턴

- 점층적 생성자 패턴의 단점을 보완한 패턴이다.

- 기본 생성자로 객체를 만든 후에 setter 메서드로 매개변수를 주입하는 방법이다.

public class User {

    private int id;           //ID(필수)
    private String userName;  //이름(필수)
    private String nickname;  //별명(선택) 
    private int age;          //나이(선택)

    public User(){
    }

    public void setId(int id){
        this.id = id;
    }

    public void setUserName(String userName){
        this.userName = userName;
    }
    
    public void setNickname(String nickname){
        this.nickname = nickname;
    }
    
    public void setAge(int age){
        this.age = age;
    }
}

User user = new User();
user.setId(1);
user.setUserName("Emily");
user.setNickname("Emily11");
user.setAge(22);

점층적 생성자 패턴에 비해 가독성이 좋고 setter 메서드로 원하는 매개변수의 값을 설정할 수 있다.

그러나 코드 양이 늘어나고, 객체를 한 번의 메서드 호출로 생성할 수 없게 되며 객체의 일관성이 깨진다.

 

객체의 일관성이 깨진다는 것은 매개변수가 하나 추가될 때마다 인스턴스가 변한다는 것이다.

일관성이 무너지므로 불변 클래스로 만드는 것도 불가능하다. 따라서 객체가 의도와 다르게 변할 가능성이 있다.

 

 

빌더 패턴

- 점층적 생성자 패턴과 자바 빈즈 패턴의 장점을 결합한 객체 생성 패턴이다.

- 정보는 자바 빈즈 패턴처럼 받으며 가독성을 높이고, 객체는 점층적 생성자 패턴처럼 생성하며 객체의 일관성을 유지한다.

- 별도의 Builder 클래스를 만들어 필수변수는 생성자로, 선택변수는 메서드로 받은 후, build 메서드로 인스턴스를 리턴하며 객체를 생성한다.

public class User {

    private int id;           //ID(필수)
    private String userName;  //이름(필수)
    private String nickname;  //별명(선택) 
    private int age;          //나이(선택)

    public static class Builder(){
    	private int id;           
        private String userName;  
        private String nickname;  
        private int age; 
        
        //필수변수는 Builder 생성자로 주입
        public Builder(String id, String userName) {
            this.id = id;
            this.userName = userName;
        }
        
        //선택변수는 빌더 클래스의 필드을 set한 후 빌더 객체를 반환
        public Builder setNickname(String nickname) {
            this.nickname = nickname;
            return this;
        }
        
        public Builder setAge(String age) {
            this.age = age;
            return this;
        }
        
        //빌더 메서드
        public User build() {
            return new User(this);  //this : 객체 자신을 가리키는 레퍼런스 변수
        }
    }
}

User user = User.builder(1,"Emily")
    .nickname("Emily11")
    .age(22)
    .build();

빌더 메서드 이후엔 setter 같은 값을 변경할 수 있는 메서드가 없으므로 멤버변수를 변경할 수 없다. 따라서 데이터의 일관성, 객체의 불변성을 보장한다.

 

 

빌더 패턴(Builder Pattern)의 장점

1. 필요한 데이터만 설정할 수 있다.

2. 유연성을 확보할 수 있다.

3. 가독성을 높일 수 있다.

4. 변경 가능성을 최소화할 수 있다.

5. 데이터의 순서에 상관없이 객체를 생성할 수 있다.

6. build()함수가 null인지 체크해주므로 검증이 가능하다.

 

 

@Builder

Lombok 플러그인에서 지원하는 어노테이션으로 빌더 클래스를 자동으로 만들 수 있다.

클래스나 생성자 위에 @Builder 어노테이션을 붙이면 빌더가 생긴다.

(생성자 위에 붙이면, 생성자에 포함된 필드만 빌더에 포함된다.)

@Builder
public class User {
    private int id;           
    private String userName;  
    private String nickname;  
    private int age;          
}

User user = User.builder()  //빌더클래스 생성자
    .id(1)
    .name("Emily")
    .nickname("Emily11")
    .age(22)
    .build();

 

빌더 패턴을 사용하지 않아도 되는 경우

대부분의 케이스에선 빌더 패턴을 적용하는 게 좋다.

그러나 생성자에 필요한 매개변수의 수가 일반적으로 4개보다 적다면 빌더를 쓰지 않아도 된다.

- 빌더는 빌더가 붙은 클래스의 모든 필드를 복사하므로 코드가 장황하고(verbose) 중복된다.