JPA에서 Lombok 사용시 주의할 점

🤣  배경

프로젝트를 마치고 나면 항상 코드 인스펙션 과정을 통해 프로그램에 대한 취약점이나 장애가 있는지 확인을 하게 되는데,  간혹 equals와 hashcode가 구현되지 않은 엔티티에 대해 경고로 지적을 당하게 되는 경우가 종종 있다.

 

처음에는 Lombok에서 제공하는 @EqualsAndHashCode를 써서 간편하게 해결하려고 했다. 그런데 나중에 프로그램 사용 중에 문제가 발생하면서 Lombok 사용이 문제라는 것을 알게 되었고, 다른 문제는 없을지 JPA에 Lombok을 사용할 때 주의할 점에 대해 알아보게 되었다.

문제점 1. HashMap, HashSet 사용에 문제가 발생한다.

- Shiba 엔티티

@Entity
@Table(name = "tb_shiba_holic")
@EqualsAndHashCode
public final class Shiba {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "seq", nullable = false)
    private Long seq;

    private String name;
}

- 테스트 코드

    @Test
    @DisplayName("같은 객체인지 확인한다.")
    void sameValue() {
        Shiba shiba = new Shiba();
        Set<Shiba> shibaSet = new HashSet<>();

        shibaSet.add(shiba);
        shibaRepository.save(shiba);

        assertThat(shibaSet.contains(shiba)).isTrue();
    }

 

동일한 객체이기를 기대하는 위 테스트는 실제로 실행해 보면 실패한다.

 

 

JPA에 저장하는 과정에서 ID가 생성되면서 Hashcode가 변경되어 HashSet/HashMap 저장된 객체는 별도의 것으로 인지하기 때문이다.

 

따라서 @EqualsAndHashCode는 직접 구현해서 사용하거나 of 옵션 exclude 옵션을 사용해서 특정 필드만 해당되도록 정의해서 사용한다.

(+ @Data에도 @EqualsAndHashCode가 포함되어 있으므로 주의하자)

문제점 2. Lazy 연관 관계 필드가 자동으로 호출된다.

@EqualsAndHashCode, @ToString은 기본적으로 엔티티에 선언한 모든 필드가 포함된다.

 

따라서 서비스 코드 내에 엔티티를 다루는 과정에서 toString(), equals(), hashCode() 등이 호출되는 경우 Lazy 필드가 자동으로 호출될 수 있다.

 

Lazy 연관 관계를 선언한 필드가 호출되는 경우 애플리케이션 성능에 영향을 줄 수 있으며, 호출이 트랜잭션 외부에서 일어나는 경우에는 LazyInitializationException 예외가 발생할 수도 있어서 주의해야 한다.

- Shiba 엔티티

@Entity
@Table(name = "tb_shiba_holic")
@ToString
@Getter
public final class Shiba {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "seq", nullable = false)
    private Long seq;

    @OneToMany(fetch = FetchType.LAZY, mappedBy = "shiba")
    private List<Item> itemList = new ArrayList<>();
}

- 테스트 코드

    @Test
    @DisplayName("toString()을 호출한다.")
    void callToString() {
        Shiba shiba = new Shiba();
        Shiba savedShiba = shibaRepository.save(shiba);

        Item item1 = Item.builder()
                .shiba(savedShiba)
                .build();
        itemRepository.save(item1);

        Item item2 = Item.builder()
                .shiba(savedShiba)
                .build();
        itemRepository.save(item2);

        // 엔티티 매니저를 초기화 한다.
        entityManager.flush();
        entityManager.clear();

        Shiba shibaEntity = shibaRepository.findById(savedShiba.getSeq()).get();
        System.out.println(shibaEntity);
    }

 

shibaEntity의 toString()을 호출한다.

 

 

그 결과 의도하지 않은 item 목록을 조회하는 select 쿼리가 추가로 나가는 것을 확인할 수 있다.

 

양방향 연관관계에서 서로 @ToString이 사용되는 경우에는, 서로가 서로를 호출하게 되면서 StackOverflowError 예외까지 발생한다.

 

@ToString을 사용하고 싶다면, 직접 구현하거나 exclude 옵션 또는 onlyExplicitlyIncluded 옵션을 사용해서 Lazy 관련 필드는 제외시켜야 한다.

(+ @Data에도 @ToString이 포함되어 있으므로 주의하자)