Builder 패턴

📌 모든 소스는 Github에 있습니다.

Effective Java에서 배웠던 Build 패턴을 정리한 포스트 입니다.

Builder 패턴이란?

객체를 생성하기 위해 다수의 Parameter가 필요할때 Setter를 쓰는 것 말고 메소드 체이닝 방식으로 객체를 생성하는 방식을 말합니다.

💡메소드 체이닝이란? 여러 메소드를 이어서 호출하는 방식을 말하며, 메소드 마다 this를 반환하여 순차적으로 호출하는 것입니다.

다양한 목적이 있겠지만 객체를 생성 시 Setter와 달리 불변 객체를 생성하기 위해 사용합니다.

💡불변객체란? 객체 생성 이후 내부의 상태가 변하지 않는 객체로 상세한 내용은 다른 포스팅에 올리겠습니다~

직접 작성한 Builder 코드

---

Post (원래 객체)

다음은 Post 객체 입니다.

public class Post {

    @Id
    private Long id;

    @Column(length = 255, nullable = false)
    private String title;

    @Column(nullable = false)
    private String content;

    private String author;

    // (1)
    public static PostBuilder builder(String title, String content) {
        return new PostBuilder(title, content);
    }

}

(1) PostBuilder를 생성하기 위한 메소드 builder()를 작성했습니다.

builder() 메소드는 static으로 선언하고, 필수로 세팅할 필드를 인자로 하여 메소드를 생성합니다.

Builder 클래스

객체 안에 Inner Class로 Builder 클래스를 선언합니다.

Inner Class는 다음과 같이 생겼습니다.

// (1)
public static class PostBuilder {

    // (2)
    private String title;
    private String content;
    private String author;

    // (3)
    public PostBuilder(String title, String content) {
        this.title = title;
        this.content = content;
    }

    // (4)
    public PostBuilder author(String author) {
        this.author = author;
        return this;
    }

    // (5)
    public Post build() {
        return new Post(this.title, this.content, this.author);
    }

}

(1) Builder 클래스는 static으로 선언합니다.

(2) Inner Class에 멤버 필드는 원래 객체, 즉, Post와 동일하게 작성합니다.

💡꼭 동일한 필요는 없습니다. Post 객체를 Builder로 생성 시 필요한 필드만 적으면 되지만 대부분 모든 필드를 기재합니다.

(3) 필수로 세팅할 필드를 인자로 하는 PostBuilder 생성자를 만듭니다.

(4) 추가로 세팅할 필드 메소드, author()를 작성합니다.

여기서 메소드 체이닝이 일어납니다.

(5) 객체, Post를 반환할 build() 메소드를 작성합니다.

사용법

위의 코드를 보면 짐작이 가시겠지만 Bulider를 생성 시 필수 값을 넘기고, 메소드 체이닝 방식으로 author를 세팅합니다.

PostBuilder builder = Post.builder("title", "content");
builder.author("author");
Post build = builder.build();

Builder를 직접 작성하는 방법에 대해선 알아봤습니다.

하지만 우리는 갓bok, Lombok을 사용하면 Builder 패턴을 좀 더 쉽게 이용할 수 있습니다.

💡그래도 Builder 패턴을 직접 한번 짜보시는걸 추천드립니다. Builder가 어떤 식으로 동작하는지를 알면 도움이 많이 되실겁니다~

Lombok을 사용한 Builder

---

우선 @Builder 어노테이션의 내부를 한번 보겠습니다.

@Target({TYPE, METHOD, CONSTRUCTOR})
@Retention(SOURCE)
public @interface Builder {

	@Target(FIELD)
	@Retention(SOURCE)
	public @interface Default {}

	String builderMethodName() default "builder";
	
	String buildMethodName() default "build";

	String builderClassName() default "";

	boolean toBuilder() default false;

	AccessLevel access() default lombok.AccessLevel.PUBLIC;

	....
}

@Builder 어노테이션은 클래스, 인터페이스, enum과 메소드, 생성자에 선언할 수 있습니다.

클래스에 선언할 경우 모든 필드를 메소드 체이닝으로 하는 연결하는 Builder가 만들어집니다.

메소드에 선언할 경우 메소드의 인자값만 메소드 체이닝으로 연결할 수 있습니다.

// 클래스에 @Builder 선언
@Builder
public class Post {

    @Id
    private Long id;

    @Column(length = 255, nullable = false)
    private String title;

    @Column(nullable = false)
    private String content;

    private String author;
		
}

// 사용
public void lombokBuilderPattern() {
    Post post = Post.builder()
  .id(1L)
  .title("title")
  .content("content")
  .author("author")
  .build();
}

// 메소드에 @Builder 선언
@Builder
public Post(String title, String content) {
		this.title = title;
		this.content = content;
}

// 사용
public void lombokBuilderPattern() {
    Post post = Post.builder()
  .title("title")
  .content("conent")
  .build();
}

@Builder의 여러 속성들

@Builder 어노테이션에는 여러가지 속성 들이 있는데 하나 씩 보도록 하겠습니다.

1. @Default라는 어노테이션이 하나 더 있는데, 이는 Builder 사용 시 초기화하지 않으면, 변수의 기본 값을 지정합니다. 다음과 같이 선언하면 “default author”가 들어가는 것을 확인할 수 있습니다.

    @Builder.Default
    private String author = "default author";
       
    // 사용
    Post post = Post.builder()
      .title("title")
      .content("conent")
      .build();
   

   

2. builderMethodName은 builderClassName은 한 클래스 안에서 @Builder를 2개 이상의 생성자에서 사용할 때 같이 사용합니다.

   💡특히 생성자에 인자값과 동일하게 메소드 체이닝을 하고자 한다면 builderMethodName은 builderClassName두 개를 함께 사용해야 합니다.

    @Builder(builderClassName = "PostTitleBuilder", builderMethodName = "postTitleBuilder")
    public Post(String title) {
        this.title = title;
    }
       
    @Builder(builderClassName = "PostTitleAndContentBuilder", builderMethodName = "postTitleAndContentBuilder")
    public Post(String title, String content) {
        this.title = title;
        this.content = content;
    }
   

    Post post1 = Post.postTitleBuilder()
      .title("title")
      .build();
       
    Post post2 = Post.postTitleAndContentBuilder()
      .title("title")
      .content("content")
      .build();
   

   만약 위에서 builderClassName를 생략하고 builderMethodName만 사용한다면 postTitleBuilder() 메소드를 사용할때도, content()가 사용 가능한 것을 확인할 수 있습니다.

3. toBuilder는 builder를 이용하여 생성된 객체에서 특정 값만 변경하여 새로운 객체를 생성하고자 할때 사용합니다. 속성의 값은 true/false 입니다.

    PostBuilder postBuilder = post1.toBuilder();
    Post update_title = postBuilder.title("update title")
      .build();
   

   기존 post1에서 title을 업데이트 하고자 할 때, toBuilder()로 Builder를 생성하고 title을 새로 세팅합니다.

   ❓그런데, 이런식으로 객체의 상태를 업데이트 할꺼라면 Setter를 쓰는게 낫지 않을까 싶네요. (혹은 객체의 상태를 변경하는 메소드를 따로 만들거나) Builder를 생성하기 위해 불필요한 비용과 코드라인이 추가되기 때문에 불필요하다 생각하고 별로 사용될 일이 없어보입니다.

4. access는 Builder 클래스의 접근제한자를 설정한다. AccessLevel의 enum을 사용합니다.

💡builder에서 required와 optional을 설정하기 위한 코드 작성 방법을 다음과 같이 사용하면 됩니다.

@Builder(builderMethodName = "allBuilder")
public class Post {

    public static PostBuilder builder(String title, String content) {
        return allBuilder()
            .title(title)
            .content(content);
    }
}

마무리

---

이번 포스트에선 Builder 패턴에 대해 알아봤습니다. Builder 패턴은 무분별한 Setter를 지양하고, 불변 객체를 유지하기 위해 주로 사용합니다.

하지만, Builder 패턴을 적용할 생성자의 인자값이 1개, 혹은 2개 등 갯수가 적다면 오히려 안좋은 상황이 나올수 있습니다.

따라서 Builder 패턴은 인자가 4개, 적어도 3개 이상되었을때 사용하는 것을 권장합니다.

2022년 새해가 밝았습니다~ 새해엔 다들 원하는 것을 이루시고, 무엇보다 건강하시길 바랍니다.

이번에도 제 포스트를 읽어주신 분들 감사합니다. 😀