[TroubleShooting] 컬렉션 필드 초기화가 되지 않는 Builder 패턴

👀 현재 상황 및 배경 설명

현재 프로젝트에서 Builder 패턴을 사용하여 엔티티 객체를 생성하고 있으며, 특히 양방향 연관관계를 설정한 Organization 엔티티에서 리스트 형태의 컬렉션 필드를 사용하고 있다.

 

▶ 구현 코드

@Entity
@Getter
@Builder
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@AllArgsConstructor
public class Organization {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;


	...


    // 양방향 연관관계
    @OneToMany(mappedBy = "organization", cascade = CascadeType.REMOVE, orphanRemoval = true)
    private List<OrganizationMember> organizationMembers = new ArrayList<>();

    // 연관관계 편의 메서드 - 추가
    public void addOrganizationMember(OrganizationMember organizationMember) {
        this.organizationMembers.add(organizationMember);
    }

    // 연관관계 편의 메서드 - 삭제
    public void removeOrganizationMember(OrganizationMember organizationMember) {
        this.organizationMembers.remove(organizationMember);
    }
}

 

 

🚨 문제 상황

양방향 연관관계를 설정하면서 organizationMembers 리스트를 new ArrayList<>()로 초기화했음에도 불구하고 NullPointerException이 발생하는 문제가 있었다.

 

 

✏️ 원인 분석

Builder 패턴을 사용할 때, 리스트나 컬렉션과 같은 필드는 기본적으로 초기화되지 않는다. 이로 인해 컬렉션 필드가 null 상태로 유지되어 연관관계 편의 메서드에서 add() 호출 시 에러가 발생한 것이다.

 

 

🔨 해결 방법

Builder를 사용하면서 초기화가 필요한 필드에는 @Builder.Default를 사용하여 기본값을 명시적으로 설정해 주어야 한다.

@Entity
@Getter
@Builder
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@AllArgsConstructor
public class Organization {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;


	...


    // 양방향 연관관계
    @Builder.Default // 리스트 기본값 초기화
    @OneToMany(mappedBy = "organization", cascade = CascadeType.REMOVE, orphanRemoval = true)
    private List<OrganizationMember> organizationMembers = new ArrayList<>();

    // 연관관계 편의 메서드 - 추가
    public void addOrganizationMember(OrganizationMember organizationMember) {
        this.organizationMembers.add(organizationMember);
    }

    // 연관관계 편의 메서드 - 삭제
    public void removeOrganizationMember(OrganizationMember organizationMember) {
        this.organizationMembers.remove(organizationMember);
    }
}

 

 

🔍 결과 관찰

문제가 해결되었으며, 컬렉션 필드가 정상적으로 초기화되어 NullPointerException 없이 리스트에 데이터를 추가하거나 삭제할 수 있게 되었다.

쿼리가 정상적으로 실행되는 것을 확인할 수 있다!

 

 

💡 고찰

Builder 패턴은 가독성과 유연성을 제공하지만, 컬렉션과 같은 필드는 자동으로 초기화되지 않는다는 점을 주의해야 한다. @Builder.Default를 적절히 사용함으로써 이러한 문제를 방지할 수 있다. 이번 문제를 통해 개발 도구의 동작 방식을 충분히 이해하고 사용하는 것이 중요하다는 점을 다시 한번 느꼈다. 앞으로는 편리한 기능들을 사용할 때 그 내부 동작을 명확히 이해하는 습관을 기르려고 한다.

 

 

📍 참고 자료

• 1:N 양방향 매핑시에 컬렉션 필드 초기화가 안되는 문제..