Hibernate의 @Formula를 이용한 연관 관계 엔티티 집계

개요

Hibernate의 @Formula 어노테이션은 엔티티 클래스 내에서 실제로 데이터베이스 스키마에 존재하지 않는 '가상 컬럼'을 정의할 수 있는 기능입니다. @Formula를 사용하면 다른 컬럼들의 값에 기반하여 계산된 값을 표현할 수 있으며, 이 값은 엔티티를 조회할 때만 계산되어 사용됩니다.

 

 

예시 코드

@Formula 어노테이션의 전형적인 사용 사례는 연관된 데이터의 집계를 수행하는 경우입니다. 예를 들어, 게시글과 연결된 댓글의 수를 계산하는 경우를 들 수 있습니다.

아래는 간단한 예시 코드입니다. 전체 코드는 깃허브에서 확인 가능합니다.

@Entity
public class Post {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column
    private String title;

    @Column
    private String content;

    @Formula("(select count(c.id) from Comment c where c.post_id = id)")
    private int commentCount;
}

위 코드에서 'commentCount'는 Post 엔티티에 추가된 가상 컬럼입니다. @Formula 어노테이션에 정의된 네이티브 SQL 쿼리를 통해 해당 게시글과 연결된 댓글 수를 계산하며, 'commentCount'는 데이터베이스 상에서는 실제로 존재하지 않지만 엔티티 내에서는 실제 컬럼처럼 사용할 수 있습니다.

 

 

언제 사용하면 좋을까?

@Formula 어노테이션은 특히 엔티티 간의 연관 관계가 있을 때, 집계 연산을 수행하는 데 유용하게 사용될 수 있습니다.

예를들어 게시글(Post)과 댓글(Comment)과 같이 1:N 관계를 가지는 엔티티에서 게시글에 달린 댓글의 수를 조회하는 경우를 생각해 봅시다. 이때 만약 댓글의 수를 얻기 위해 단순히 Post 엔티티 내부의 comments 리스트의 크기를 직접 조회한다면 Lazy Loading 설정으로 인해 댓글의 전체 컬렉션이 로드되는 상황이 발생합니다.

@Entity
public class Post {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column
    private String title;

    @Column
    private String content;

    @OneToMany(mappedBy = "post")
    private List<Comment> comments = new ArrayList<>();

    public int getCommentCount() {
        return comments.size();
    }
}

위와 같이 코드를 작성하면, 댓글의 수를 얻기 위해 해당 Post의 모든 댓글 데이터(컬럼)를 로드해야 합니다. 이로 인해 실행 속도가 느려질 수 있고, 메모리 사용량 또한 많아지며 결과적으로 시스템 전체의 성능에 부정적인 영향을 줄 수 있습니다.

이때 @Formula 어노테이션을 사용하면 댓글 수를 데이터베이스 쿼리를 통해 직접 계산하여 가져와 불필요한 데이터 로드를 방지하고 메모리 사용량을 줄여 성능을 개선할 수 있습니다.

@Entity
public class Post {
    // 댓글 리스트 - 연관 관계 정의
    @OneToMany(mappedBy = "post")
    private List<Comment> comments = new ArrayList<>();
    
    // @Formula를 통한 댓글 수 직접 계산
    @Formula("(SELECT COUNT(*) FROM comment c WHERE c.post_id = id)")
    private int commentCount;

    // 댓글 수를 반환하는 메소드는 이제 더 이상 comments 컬렉션을 로드하지 않음
    public int getCommentCount() {
        return this.commentCount;
    }
}

물론 상황에 따라서는 @Formula 어노테이션이 오히려 부작용을 일으킬 수도 있습니다. 예를 들어, 댓글 리스트 전체를 조회하는 화면이 필요한 경우에는 엔티티를 조회할 때마다 무조건적으로 @Formula가 실행되기 때문에 불필요한 쿼리가 실행될 수 있습니다.

또한 @Formula에 지연 로딩(Lazy Loading)을 적용하고 싶어도 Hibernate는 기본적으로 원시 타입(primitive type)에 대해 지연 로딩을 지원하지 않기 때문에 적용하고 싶다면 @Basic(fetch = FetchType.LAZY)와 함께 별도의 바이트 코드 조작(ByteCodeEnhancement)을 통해 적용해야 합니다.

따라서 @Formula 어노테이션의 사용은 특정 상황에서의 성능 최적화를 위한 것이며, 그 외의 경우에는 신중하게 검토해야 합니다.

 

 

주의점

@Formula 어노테이션으로 정의된 필드는 해당 엔티티가 조회될 때마다 SQL 표현식이 실행되며 그 결과값으로 채워집니다. 따라서, 만약 댓글이 추가되거나 삭제된 경우에도, @Formula를 통해 계산된 필드 값은 자동으로 갱신되지 않습니다.

또한 @Formula로 정의된 필드는 데이터베이스에서 계산된 값을 읽어오는 데에만 사용됩니다. 이 필드에 대한 변경을 시도하면 Hibernate는 이를 데이터베이스에 반영하지 않으며, 실제로 이 필드를 업데이트하려 하면 무시되거나 에러가 발생할 수 있습니다.

따라서 @Formula로 생성된 필드는 데이터를 조회하는 데에만 적합하며, 엔티티의 상태를 변경하는 로직에서는 사용을 피해야 합니다. 만약 @Formula가 적용된 필드의 값을 갱신하고 싶다면, 별도로 데이터베이스 트리거를 설정하거나 애플리케이션 수준에서 로직을 구현해야 합니다.

 

 

테스트

@SpringBootTest
@Transactional
class FormulaApplicationTests {

    @Autowired
    private PostRepository postRepository;

    @Autowired
    private JdbcTemplate jdbcTemplate;

    private Long postId = 1L;

    @BeforeEach
    void setUp() {
        // Post 테이블에 레코드 추가
        jdbcTemplate.update("INSERT INTO post (id, title, content) VALUES (?, ?, ?)", 1L, "글 제목", "글 내용");

        // Comment 테이블에 레코드 추가
        jdbcTemplate.update("INSERT INTO comment (id, content, post_id) VALUES (?, ?, ?)", 2L, "첫 번째 댓글", 1);
        jdbcTemplate.update("INSERT INTO comment (id, content, post_id) VALUES (?, ?, ?)", 3L, "두 번째 댓글", 1);
    }

    @Test
    void shouldReturnCorrectCommentCount() {
        // when
        Post post = postRepository.findById(postId).orElseThrow(() -> new AssertionError("Post not found"));

        // then
        Assertions.assertThat(post.getCommentCountFromCollections()).isEqualTo(2);
        Assertions.assertThat(post.getCommentCountFromFormula()).isEqualTo(2);
    }

    @DisplayName("Colletctions.size() 쿼리 확인")
    @Test
    void shouldQueryWhenGettingCountFromCollections() {
        Post post = postRepository.findById(postId).orElseThrow(() -> new AssertionError("Post not found"));

        post.getCommentCountFromCollections();
        /**
         *
         * Hibernate:
         *     select
         *         post0_.id as id1_1_0_,
         *         post0_.content as content2_1_0_,
         *         post0_.title as title3_1_0_,
         *         (select
         *             count(*)
         *         from
         *             comment c
         *         where
         *             c.post_id = post0_.id) as formula1_0_
         *     from
         *         post post0_
         *     where
         *         post0_.id=?
         * Hibernate:
         *     select
         *         comments0_.post_id as post_id3_0_0_,
         *         comments0_.id as id1_0_0_,
         *         comments0_.id as id1_0_1_,
         *         comments0_.content as content2_0_1_,
         *         comments0_.post_id as post_id3_0_1_
         *     from
         *         comment comments0_
         *     where
         *         comments0_.post_id=?
         */
    }

    @DisplayName("Formula 쿼리 확인")
    @Test
    void shouldQueryWhenGettingCountFromFormula() {
        Post post = postRepository.findById(postId).orElseThrow(() -> new AssertionError("Post not found"));

        post.getCommentCountFromFormula();
        /**
         *
         * Hibernate:
         *     select
         *         post0_.id as id1_1_0_,
         *         post0_.content as content2_1_0_,
         *         post0_.title as title3_1_0_,
         *         (select
         *             count(*)
         *         from
         *             comment c
         *         where
         *             c.post_id = post0_.id) as formula1_0_
         *     from
         *         post post0_
         *     where
         *         post0_.id=?
         */
    }
}