[java] Hibernate Envers에서 데이터 변경 로그를 어떻게 복원하고 추적하나요?

30 Nov 2023

java

Hibernate Envers는 Hibernate ORM의 기능을 확장하여 데이터 변경 이력을 기록하고 추적하는 기능을 제공합니다. 이를 통해 애플리케이션에서 데이터 변경에 대한 로그를 복원하고 추적할 수 있습니다.

1. Hibernate Envers 설정하기

먼저, Hibernate Envers를 사용하기 위해 프로젝트에 필요한 의존성을 추가해야 합니다. Maven을 사용하는 경우, pom.xml 파일에 다음과 같은 의존성을 추가해주십시오:

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-envers</artifactId>
    <version>5.4.30.Final</version>
</dependency>

Hibernate Envers는 Hibernate ORM의 일부로 제공되므로, Hibernate ORM의 설정 파일 (hibernate.cfg.xml 또는 persistence.xml)에서도 Envers를 사용하도록 설정해야 합니다. 다음은 Hibernate ORM의 설정 파일에서 Envers를 사용하도록 설정하는 예시입니다:

<properties>
    <!-- Hibernate Envers 사용 설정 추가 -->
    <property name="hibernate.listeners.envers.autoRegister" value="true"/>
</properties>

2. 엔티티에 Envers 애너테이션 추가하기

Envers를 사용하여 데이터 변경 이력을 추적하려면 변경을 추적하려는 엔티티에 @Audited 애너테이션을 추가해야 합니다. 이 애너테이션은 해당 엔티티의 변경 로그를 Envers에 의해 관리하도록 지정합니다. 다음은 User 엔티티에 @Audited 애너테이션을 추가하는 예시입니다:

@Entity
@Audited
public class User {
    // 엔티티의 필드 및 매핑 정보
    // ...
}

3. 데이터 변경 이력 조회하기

Hibernate Envers를 사용하여 데이터 변경 이력을 조회하려면 AuditReader 인터페이스를 사용해야 합니다. AuditReader는 Hibernate Session에서 직접 얻을 수 있으며, 변경 로그를 조회하기 위해 createQuery() 메서드를 사용합니다. 다음은 User 엔티티의 변경 로그를 조회하는 예시입니다:

AuditReader reader = AuditReaderFactory.get(session);
List<Number> revisions = reader.getRevisions(User.class, userId);
for (Number revision : revisions) {
    User userRevision = reader.find(User.class, userId, revision);
    System.out.println("Revision: " + revision);
    System.out.println("User: " + userRevision);
}

위의 예시에서 userId는 조회할 사용자의 식별자입니다. getRevisions() 메서드는 엔티티의 변경 로그가 있는 모든 리비전 번호의 목록을 반환하고, find() 메서드를 통해 특정 리비전에서 엔티티를 조회할 수 있습니다.

4. 데이터 변경 로그 복원하기

변경 로그를 사용하여 데이터를 복원하려면 엔티티의 이력을 사용하여 원하는 시점의 데이터를 복원해야 합니다. 위에서 언급한 AuditReader 인터페이스를 사용하여 특정 리비전에서 엔티티를 조회할 수 있습니다. 예를 들어, User 엔티티의 특정 리비전에서의 데이터를 복원하는 예시는 다음과 같습니다:

AuditReader reader = AuditReaderFactory.get(session);
User userRevision = reader.find(User.class, userId, revisionNumber);
// 데이터 복원 후 필요한 로직 수행

위의 예시에서 revisionNumber는 복원하려는 리비전 번호입니다.

참고 자료

Hibernate Envers 공식 문서: https://docs.jboss.org/hibernate/envers/
Hibernate Envers GitHub 저장소: https://github.com/hibernate/hibernate-envers