Lombok 1.16.16에서 @Builder 애노테이션 변경

자바로 개발하는 프로젝트라면 Lombok을 많이 사용할것이다. 이런저런 규약에 따라 거의 필수적으로 만들어줘야하는 코드를 자동생성해주는 고마운 라이브러리이다. 객체 생성 패턴중 한가지인 빌더 클래스도 롬복의 @Builder 애노테이션을 이용하면 쉽게 만들 수 있다.

@Builder
public class Person {
   private int age;
   private String name;
}

빌더 패턴에 대한 설명은 여기서 하지 않겠다(이전 포스팅). 롬복을 이용해 빌더 클래스를 만들면 이런식으로 Person 객체를 생성할 수 있다.

Person person = Person.builder()
   .age(30)
   .name("LichKing")
   .build();

이번에 포스팅할 내용은 이부분에 관한것이다. Person의 인스턴스 필드인 age가 이미 초기화되어있다면 어떻게 될까?

@Builder
public class Person {
   private int age = 30;
   private String name;
}

1.16.14 버전까지 아무런 문제 없이 잘 만들어준다. 만들어주는 코드의 생김새는 이렇다.

public class Person {
    private int age = 30;
    private String name;

    Person(int age, String name) {
        this.age = age;
        this.name = name;
    }

    public static Person.PersonBuilder builder() {
        return new Person.PersonBuilder();
    }

    public static class PersonBuilder {
        private int age;
        private String name;

        PersonBuilder() {
        }

        public Person.PersonBuilder age(int age) {
            this.age = age;
            return this;
        }

        public Person.PersonBuilder name(String name) {
            this.name = name;
            return this;
        }

        public Person build() {
            return new Person(this.age, this.name);
        }

        public String toString() {
            return "Person.PersonBuilder(age=" + this.age + ", name=" + this.name + ")";
        }
    }
}

이 작동은 1.16.16 버전 이후부터 변경되었는데 컴파일 에러를 발생시킨다거나 하는건 아니고.. 빌드시에 warnning을 발생시킨다.

* 1.16.16 버전

Person.java:10: warning: @Builder will ignore the initializing expression entirely. If you want the initializing expression to serve as default, add @Builder.Default. if it is not supposed to be settable during building, add @Builder.Constant.         private int age = 30;                     ^ 1 warning

* 1.16.20 버전

Person.java:10: warning: @Builder will ignore the initializing expression entirely. If you want the initializing expression to serve as default, add @Builder.Default. If it is not supposed to be settable during building, make the field final.         private int age = 30;                     ^ 1 warning

(16버전과 20버전 로그가 약간다른데 @Builder.Constant 라는 애노테이션이 없기때문에 로그가 변경됐다.)

warnning은 컴파일이 안되도록 만드는것도 아니고 빌더클래스를 안만들어주는것도 아니기때문에 사용하거나, 빌드하는데 문제는 없다. 그런데 멀쩡히 잘 돌아가던걸 워닝을 띄우게 바꼈다는건 실수한거 아닌이상은 무언가의 의도가 있을것이다. 그 의도가 무엇일까?

필드를 미리 초기화해 놓는다는것은 객체를 생성할때 age 필드를 30으로 고정시켜놓겠다는 의미로 볼 수 있다. 그런데 빌더가 그걸 오버라이딩해버리면 필드를 미리 초기화해놓은 의도와 충돌이 난다는 경고를 하는것이다. 필드를 초기화해놓은 개발자의 의도를 무시해버리는 경우가 생길 수 있으니 warnning을 발생시키는것이다. 그럼 어떻게 해결할 수 있을까?

1. final

필드를 고정시킨다는 의도라면 final을 붙이는게 의미적으로도 맞다. 좀 더 나아가 final 로 만들거라면 static final로 만드는게 좋을것이다. lombok의 @Builder 애노테이션은 final 필드에 대한 메서드는 만들어주지 않기때문에 warnning 로그도 발생하지 않는다.

2. @Builder.Default

상황에 따라서는 일단 30으로 초기화해놓고 특정 경우마다 다른 값으로 초기화하고싶을 수도있다. 고정시키겠다는 의미가 아니므로 final을 붙일 수 없는 경우이다. 그럴때는 age 필드에 @Builder.Default 애노테이션을 붙여주면 된다.

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

다만 이경우에 사용하는 클라이언트 입장에서 빌더클래스만 보고 제공자의 의도를 알기 힘들다. 이런 경우라면 개인적으로는 생성자 오버로딩이나 정적 팩토리 메서드를 제공하는게 좀 더 옳은 방향이라고 생각한다.