[DEVLOG] @Builder와 @Builder.Default

 

🤔 @Builder가 달려있는 클래스의 필드를 초기화해줬는데, 왜 빌더 패턴을 사용하면 초기화 값이 아닌 Null이 나오지?

 

🪄 GTAccountInfo 엔티티의 코드 일부

@Slf4j
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Entity(name = "gt_account_info")
public class GTAccountInfo {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "ACCOUNT_ID")
    private long id;

    @Getter
    @Column(name = "account_email")
    private String accountEmail;

    @Getter
    @Column(name = "account_pw")
    private String accountPW;

    @OneToMany(mappedBy = "accountInfo", fetch = FetchType.LAZY)
    private List<GTAccountUserRoleInfo> roleByThisAccountList = new ArrayList<>();

    public List<GTUserRole> getRoles(){
        return roleByThisAccountList.stream()
                .map(GTAccountUserRoleInfo::getUserRole)
                .map(GTUserRoleInfo::getUserRole)
                .collect(Collectors.toList());
    }
    
	// ...
}

 

🪄Test 코드의 일부 발췌

    @Test
    @DisplayName("🤔 1. 계정정보 생성 및 저장 테스트 : 성공 케이스")
    @Transactional
    public void testForCreateNewAccountInfoAndSave(){
        GTAccountInfo mockAccountInfo = GTAccountInfo.builder()
                .accountEmail("test@example.com")
                .accountPW("1234")
                .build();

        GTAccountInfo savedAccountInfo = accountInfoRepository.save(mockAccountInfo);

        assertEquals(savedAccountInfo.getAccountEmail(), "test@example.com");
        assertEquals(savedAccountInfo.getAccountPW(), "1234");
        assertEquals(savedAccountInfo.getRoles().size(), 0);

    }

 

테스트 코드에서 위와 같이, Builder 패턴을 사용해서 이메일과 PW를 채워 넣어 새로운 객체를 생성해냈습니다.

Entity 클래스에서, roleByThisAccountList의 경우, new ArrayList<>()로 할당되어 있기 때문에 null일 경우는 없다라고 생각했습니다.

 

그러나, 테스트의 결과를 확인해보니,

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 List<GTAccountUserRoleInfo> roleByThisAccountList = new ArrayList<>();

java.lang.NullPointerException at com.example.gtmvcserverside.member.domain.GTAccountInfo.getRoles(GTAccountInfo.java:41) ...

와 같이 roleByThisAccountList가 null인 것을 확인할 수 있었습니다. 

 

경고 표현을 읽어보면, @Builder는 Initializing expression을 전체 무시하고, default로 사용하고 싶다면, @Builder.Default를 사용해라고 합니다. 

 

class Example<T> {
   	private T foo;
   	private final String bar;
   	
   	private Example(T foo, String bar) {
   		this.foo = foo;
   		this.bar = bar;
   	}
   	
   	public static <T> ExampleBuilder<T> builder() {
   		return new ExampleBuilder<T>();
   	}
   	
   	public static class ExampleBuilder<T> {
   		private T foo;
   		private String bar;
   		
   		private ExampleBuilder() {}
   		
   		public ExampleBuilder foo(T foo) {
   			this.foo = foo;
   			return this;
   		}
   		
   		public ExampleBuilder bar(String bar) {
   			this.bar = bar;
   			return this;
   		}
   		
   		@java.lang.Override public String toString() {
   			return "ExampleBuilder(foo = " + foo + ", bar = " + bar + ")";
   		}
   		
   		public Example build() {
   			return new Example(foo, bar);
   		}
   	}
   }

위 코드는, @Builder를 통해 내부적으로 만들어진 코드에 대한 내용을 주석에서 가져온 것입니다.

builder 패턴을 활용해서 foo와 bar를 세팅할 수 있습니다.

 

이 inner class인 ExampleBuilder<T>는, 내부에서 초기화 하는 코드가 어디에도 없습니다.

따라서 @Builder가 달려있는 클래스에 대해 빌더 패턴으로 새로운 객체를 생성하려고 하면, 필드가 initialized 되어있더라도, 빌더패턴을 사용하면서 값을 삽입하지 않으면 null이 들어갈 수 밖에 없습니다.

 

따라서 초기화된 상태를 @Builder를 사용하면서 유지하고 싶다면, 필드에 @Builder.Default를 적용하면 됩니다.

 

@Slf4j
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Entity(name = "gt_account_info")
public class GTAccountInfo {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "ACCOUNT_ID")
    private long id;

    @Getter
    @Column(name = "account_email")
    private String accountEmail;

    @Getter
    @Column(name = "account_pw")
    private String accountPW;

	@Builder.Default
    @OneToMany(mappedBy = "accountInfo", fetch = FetchType.LAZY)
    private List<GTAccountUserRoleInfo> roleByThisAccountList = new ArrayList<>();

    public List<GTUserRole> getRoles(){
        return roleByThisAccountList.stream()
                .map(GTAccountUserRoleInfo::getUserRole)
                .map(GTUserRoleInfo::getUserRole)
                .collect(Collectors.toList());
    }
    
	// ...
}

 

이제는, 원하는대로 초기화가 되고 정상적으로 테스트가 통과하는 모습을 볼 수 있습니다.

 

 

 

 

 

🤔 @Builder의 추가 지식

 

추가적으로 @Builder의 주석을 한 번 살펴보도록 하겠습니다.

If a member is annotated, it must be either a constructor or a method. If a class is annotated, then a package-private constructor is generated with all fields as arguments (as if @AllArgsConstructor(access = AccessLevel.PACKAGE) is present on the class), and it is as if this constructor has been annotated with @Builder instead. Note that this constructor is only generated if you haven't written any constructors and also haven't added any explicit @XArgsConstructor annotations. In those cases, lombok will assume an all-args constructor is present and generate code that uses it; this means you'd get a compiler error if this constructor is not present.

 

@Builder 어노테이션을 삽입하면, 모든 필드를 인자로 요구하는 package-private한 생성자를 자동으로 생성하고, 내부적으로 이러한 생성자가 있다는 가정하에 코드를 generate 합니다.

 

이러한 모든 필드를 인자로 요구하는 package-private한 생성자는 어떠한 생성자를 작성하지 않아야하고, 다른 @XArgsConstructor(No, Required..) 역시 명시하지 않은 경우에 생성된다고 나와있습니다.

 

즉, JPA를 사용하면서 @NoArgsConstructor를 반드시 포함해야 하는 경우에는 모든 필드를 인자로 요구하는 package-private한 생성자가 생성되지 않습니다.

 

그렇기 때문에 Entity 클래스에서 @Builder를 사용하고자 한다면,

@NoArgsConstructor과 @AllArgsConstructor를 같이 사용해주면 됩니다.