[번역] How to implement a soft delete with Hibernate(어떻게 Hibernate를 사용해 소프트 삭제를 구현하는가)

💡 원본글 : https://thorben-janssen.com/implement-soft-delete-hibernate/

How to implement a soft delete with Hibernate

 

일부 응용 프로그램에서는 데이터베이스에서 레코드를 영구적으로 삭제하고 싶지 않거나 삭제가 허용되지 않을 수 있습니다. 그러나 더 이상 활성 상태가 아닌 레코드를 삭제하거나 숨겨야 할 필요가 있습니다. 예를 들어, 여전히 사용 중인 다른 비즈니스 객체에 연결된 사용자 계정을 유지하려는 경우가 있습니다.

시스템에서 이 정보를 유지하기 위해 두 가지 기본 옵션이 있습니다. 모든 변경 사항을 문서화하는 감사 로그(audit log)를 유지하거나 삭제된 레코드를 숨기는 소프트 삭제를 수행할 수 있습니다. 감사 로그(audit log) 옵션에 대한 설명은 Hibernate Envers에 관한 내 기사에서 다루었습니다. 오늘은 Hibernate를 사용하여 소프트 삭제를 구현하는 방법을 보여드리려고 합니다. 그러기 전에 소프트 삭제가 무엇인지 간단히 설명하겠습니다.

소프트 삭제란 무엇인가요?

소프트 삭제는 레코드를 데이터베이스 테이블에서 삭제하는 대신 레코드를 삭제로 표시하기 위한 업데이트를 수행합니다. 소프트 삭제를 모델링하는 일반적인 방법은 다음과 같습니다:

• 레코드가 활성 또는 삭제된 상태를 나타내는 boolean,
• 레코드 상태를 모델링하는 enum,
• 소프트 삭제가 수행된 날짜와 시간을 저장하는 timestamp.

이러한 필드를 추가하는 것은 당연히 소프트 삭제 기능을 구현하기 위한 첫 번째 단계일 뿐입니다. 새로운 레코드를 저장할 때 이를 설정해야 하며, 레코드를 삭제하는 대신 소프트 삭제 표시를 변경해야 합니다. 또한 사용자에게 소프트 삭제된 레코드를 숨기려면 소프트 삭제 표시를 기반으로 레코드를 제외하는 모든 쿼리를 조정해야 합니다.

이것은 많은 작업처럼 들릴 수 있지만, Hibernate를 사용하는 경우에는 그렇지 않습니다.

어떻게 Hibernate를 사용해 소프트 삭제를 구현하는가.

Hibernate 6.4 버전에서 Hibernate 팀은 Hibernate ORM을 위한 공식 소프트 삭제 기능을 소개했습니다. 이제 엔티티 클래스에서 소프트 삭제를 활성화하려면 1개의 어노테이션만 필요합니다. Hibernate은 그런 다음 레코드를 소프트 삭제하기 위한 필요한 SQL UPDATE 문을 생성하고 소프트 삭제된 레코드를 제외한 모든 쿼리 문을 조정합니다. 이 기사의 다음 섹션에서 소프트 삭제를 활성화하고 다양한 구성 옵션을 보여 드리겠습니다.

Hibernate 버전이 6.3 이하인 경우, 소프트 삭제 기능을 직접 구현해야 합니다. 이 작업에는 약간의 추가 작업이 필요하지만 복잡하지 않으며 엔티티 매핑에서 필요한 모든 부분을 선언할 수 있습니다. 따라서 비즈니스 코드에서 처리할 필요가 없습니다. 이 기사의 끝에서 매핑을 어떻게 구현하는지 보여 드리겠습니다.

6.4 이상 Hibernate 소프트 삭제

Hibernate 6.4에서 소프트 삭제 기능을 지원합니다.엔티티 클래스에 @SoftDelete 어노테이션을 붙이면 Hibernate가 나머지 처리를 담당합니다.

Hibernate의 기본 소프트 삭제 구현

다음 코드 조각은 Hibernate의 기본 소프트 삭제 구현을 사용합니다. 이 구현은 기본 데이터베이스 테이블에서 boolean 유형의 deleted 열을 기대합니다. @SoftDelete 어노테이션의 columnName 속성을 사용하여 해당 열의 다른 이름을 지정할 수 있습니다.

@Entity
@SoftDelete
public class Account { ... }

Hibernate는 새로운 Account 엔티티를 영속화할 때 자동으로 deleted 필드를 false로 설정합니다.

Account a = new Account();
a.setName("thjanssen");
em.persist(a);

10:30:49,099 DEBUG SQL:135 - insert into Account (name,deleted,id) values (?,false,?)

엔티티를 삭제하면 Hibernate는 deleted 필드를 true로 설정합니다. 그리고 Hibernate는 모든 JPQL 및 Criteria 쿼리 및 생성된 모든 문에 대해 deleted=true인 모든 레코드를 제외하는 조건을 추가합니다.

Account a = em.find(Account.class, a.getId());
em.remove(a);

TypedQuery<Account> q = em.createNamedQuery("Account.FindByName", Account.class);
q.setParameter("name", "%ans%");
a = (Account) q.getSingleResult();

10:30:49,199 DEBUG SQL:135 - select a1_0.id,a1_0.name from Account a1_0 where a1_0.deleted=false and a1_0.id=?
10:30:49,211 DEBUG SQL:135 - update Account set deleted=true where id=? and deleted=false

10:30:49,234 DEBUG SQL:135 - select a1_0.id,a1_0.name from Account a1_0 where a1_0.name like ? escape '' and a1_0.active=true

다른 SoftDeleteType 사용하기

Hibernate는 데이터베이스에 저장된 boolean의 의미를 결정하는 두 가지 다른 SoftDeleteType을 지원합니다.

1. SoftDeleteType.ACTIVE: 값이 true는 레코드를 활성으로 표시하며 Hibernate은 기본적으로 active를 열 이름으로 사용합니다.
2. SoftDeleteType.DELETED: 값이 true는 레코드를 삭제로 표시하며 Hibernate은 기본적으로 deleted를 열 이름으로 사용합니다. 이게 기본값입니다.

여기에서 SoftDeleteType을 ACTIVE로 설정하는 간단한 매핑을 볼 수 있습니다.

@Entity
@SoftDelete(strategy = SoftDeleteType.ACTIVE)
public class Account { ... }

이제 이전과 동일한 테스트를 실행하면 Hibernate가 엔티티의 현재 상태를 active 열에 저장합니다. 엔티티를 삭제하면 Hibernate가 해당 필드를 false로 설정하고 모든 쿼리는 active=true인 레코드만 반환합니다.

// persist a new Account
Account a = new Account();
a.setName("thjanssen");
em.persist(a);

// find and remove an Account
a = em.find(Account.class, a.getId());
em.remove(a);

// query an Account
TypedQuery<Account> q = em.createNamedQuery("Account.FindByName", Account.class);
q.setParameter("name", "%ans%");
a = (Account) q.getSingleResult();

// persist a new Account
10:46:26,099 DEBUG SQL:135 - insert into Account (name,active,id) values (?,true,?)

// find and remove an Account
10:46:26,199 DEBUG SQL:135 - select a1_0.id,a1_0.name from Account a1_0 where a1_0.active=true and a1_0.id=?
10:46:26,211 DEBUG SQL:135 - update Account set active=false where id=? and active=true

// query an Account
10:46:26,234 DEBUG SQL:135 - select a1_0.id,a1_0.name from Account a1_0 where a1_0.name like ? escape '' and a1_0.active=true

다른 컬럼 타입을 사용하기

Hibernate의 기본 소프트 삭제 구현은 각 레코드의 현재 상태를 저장하는 데 boolean 유형의 열을 사용합니다. 그러나 내부적으로 사용되는 Boolean을 원하는 데이터베이스 유형에 매핑하는 AttributeConverter를 제공하여 이를 변경할 수 있습니다.

이것은 레거시 데이터베이스와 작업하는 경우 유용합니다. 이러한 경우 각 레코드의 현재 상태를 나타내는 String 또는 열거형을 사용하는 경우가 있습니다.

여기에서 엔티티 매핑을 볼 수 있으며 Hibernate에게 현재 레코드의 상태를 state 열에 저장하도록 지시하고 StateConverter AttributeConverter를 사용하여 속성을 매핑합니다.

@Entity
@SoftDelete(strategy = SoftDeleteType.ACTIVE, columnName = "state", converter = StateConverter.class)
public class Account { ... }

StateConverter 구현은 간단합니다. AttributeConverter 인터페이스를 구현하며 convertToDatabaseColumn 및 convertToEntityAttribute 메서드를 사용합니다.

Hibernate의 소프트 삭제 구현은 레코드가 활성 상태인지 삭제 상태인지를 나타내는 Boolean에 의존합니다. 따라서 AttributeConverter의 첫 번째 유형 매개변수는 Boolean이어야 합니다. 두 번째 유형 매개변수는 데이터베이스에 저장하려는 유형을 지정합니다. 이 예제에서는 Boolean을 String값인 "active" 또는 "inactive"에 매핑하려고 합니다.

public class StateConverter implements AttributeConverter<Boolean, String>{

    @Override
    public String convertToDatabaseColumn(Boolean attribute) {
        return attribute ? "active" : "inactive";
    }

    @Override
    public Boolean convertToEntityAttribute(String dbData) {
        return dbData.equals("active");
    }

}

When I now execute the same test as before, Hibernate stores the values “active” or “inactive” in the state column. When I remove the entity, Hibernate sets that field to “inactive”, and all queries only return records where state=active.

// persist a new Account
Account a = new Account();
a.setName("thjanssen");
em.persist(a);

// find and remove an Account
a = em.find(Account.class, a.getId());
em.remove(a);

// query an Account
TypedQuery<Account> q = em.createNamedQuery("Account.FindByName", Account.class);
q.setParameter("name", "%ans%");
a = (Account) q.getSingleResult();

// persist a new Account
10:46:26,099 DEBUG SQL:135 - insert into Account (name,state,id) values (?,'active',?)

// find and remove an Account
11:18:39,857 DEBUG SQL:135 - select a1_0.id,a1_0.name from Account a1_0 where a1_0.state='active' and a1_0.id=?
11:18:39,867 DEBUG SQL:135 - update Account set state='inactive' where id=? and state='active'

// query an Account
11:18:39,889 DEBUG SQL:135 - select a1_0.id,a1_0.name from Account a1_0 where a1_0.name like ? escape '' and a1_0.state='active'

6.4 미만 Hibernate 소프트 삭제 구현

Hibernate 6.4 미만에서 소프트 삭제를 구현하는 것은 그리 어렵지 않지만 약간의 추가 작업이 필요합니다. 다음을 수행해야 합니다.

1. 엔티티 객체를 제거할 때 삭제 작업 대신 SQL UPDATE를 수행하도록 Hibernate에 지시하고
2. 쿼리 결과에서 모든 소프트 삭제된 레코드를 제외합니다.

다음 예제에서 이를 쉽게 수행하는 방법을 보여 드리겠습니다. 이 예제는 모두 Account 엔티티를 사용하며 AccountState 상태 속성을 사용하여 계정이 INACTIVE, ACTIVE, 또는 DELETED 인지를 나타냅니다.

@Entity
@NamedQuery(name = "Account.FindByName", query = "SELECT a FROM Account a WHERE name like :name")
public class Account {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name = "id", updatable = false, nullable = false)
    private Long id;

    @Column
    private String name;

    @Column
    @Enumerated(EnumType.STRING)
    private AccountState state;

    …

}

레코드를 삭제하는 대신 레코드를 업데이트하기.

소프트 삭제를 구현하려면 Hibernate의 기본적인 제거 작업을 재정의해야 합니다. 이를 @SQLDelete 어노테이션으로 수행할 수 있습니다. 이 어노테이션을 사용하면 엔티티를 삭제할 때 Hibernate가 실행할 사용자 정의 네이티브 SQL 쿼리를 정의할 수 있습니다. 다음 코드 조각에서 예제를 볼 수 있습니다.

@Entity
@SQLDelete(sql = "UPDATE account SET state = ‘DELETED’ WHERE id = ?", check = ResultCheckStyle.COUNT)
public class Account { … }

이전 코드 조각의 @SQLDelete 어노테이션은 Hibernate에게 기본 SQL DELETE 문 대신 지정된 SQL UPDATE 문을 실행하도록 지시합니다. 이것은 계정의 상태를 DELETED로 변경하며 삭제된 계정을 제외하려면 모든 쿼리에서 state 속성을 사용할 수 있습니다.

Account a = em.find(Account.class, a.getId());
em.remove(a);

16:07:59,511 DEBUG SQL:92 – select account0_.id as id1_0_0_, account0_.name as name2_0_0_, account0_.state as state3_0_0_ from Account account0_ where account0_.id=? and ( account0_.state <> 'DELETED')
16:07:59,534 DEBUG SQL:92 – UPDATE account SET state = 'DELETED' WHERE id = ?

기본적인 소프트 삭제 구현을 생성하는 데 필요한 것은 이것뿐입니다. 그러나 처리해야 할 다른 두 가지 사항이 있습니다.

1. Account 엔티티를 삭제할 때 Hibernate는 현재 세션에서 state 속성의 값을 업데이트하지 않습니다.
2. 삭제된 엔티티를 제외하기 위해 모든 쿼리를 조정해야 합니다.

현재 세션에서 state 속성을 업데이트하기.

Hibernate는 @SQLDelete 어노테이션에 제공하는 네이티브 쿼리를 구문 분석하지 않습니다. 그저 매개변수 값을 설정하고 실행합니다. 따라서 @SQLDelete 어노테이션에 DELETE 문 대신 SQL UPDATE 문을 제공했다는 사실을 인식하지 않습니다. 또한 삭제 작업을 수행한 후 state 속성의 값이 예전 값이라는 것을 알지 못합니다.

대부분의 경우, 이는 문제가 되지 않습니다. Hibernate가 SQL 문을 실행할 때 데이터베이스 레코드가 업데이트되고 모든 쿼리가 새로운 state 값을 사용합니다. 그러나 EntityManager.remove(Object entity) 작업에 제공한 Account 엔티티는 어떻게 될까요?

그 엔티티의 state 속성은 예전 상태입니다. 삭제한 후 즉시 참조를 해제하는 경우 큰 문제가 되지 않습니다. 그렇지 않은 경우 속성을 직접 업데이트해야 합니다.

가장 쉬운 방법은 다음 코드 조각에서처럼 라이프사이클 콜백을 사용하는 것입니다. @PreRemove 어노테이션은 deleteUser 메서드에 있으며 Hibernate에게 제거 작업을 수행하기 전에이 메서드를 호출하도록 지시합니다. 이 메서드를 사용하여 state 속성의 값을 DELETED로 설정합니다.

@Entity
@SQLDelete(sql = "UPDATE account SET state = 'DELETED' WHERE id = ?", check = ResultCheckStyle.COUNT)
public class Account {

	...

	@PreRemove
	public void deleteUser() {
		this.state = AccountState.DELETED;
	}

}

쿼리에서 소프트 삭제된 엔티티 제외

삭제된 데이터베이스 레코드를 쿼리 결과에서 제외하려면 모든 쿼리에서 state 속성을 확인해야 합니다. 이 작업은 수동으로 수행할 경우 오류 발생 가능성이 있으며 모든 쿼리를 직접 정의해야 합니다. EntityManager.find(Class entityClass, Object primaryKey) 메서드와 Hibernate의 Session에 해당하는 메서드는 state 속성의 의미를 알지 못하며 이를 고려하지 않습니다.

Hibernate의 @Where 어노테이션을 사용하면 모든 삭제된 엔티티를 제외하는 더 나은 방법을 제공합니다. 이 어노테이션을 사용하면 Hibernate이 모든 쿼리의 WHERE 절에 추가할 SQL 스니펫을 정의할 수 있습니다. 다음 코드 조각은 state가 DELETED인 경우 레코드를 제외하는 @Where 어노테이션을 보여줍니다.

@Entity
@SQLDelete(sql = "UPDATE account SET state = 'DELETED' WHERE id = ?", check = ResultCheckStyle.COUNT)
@Where(clause = "state <> 'DELETED'")
@NamedQuery(name = "Account.FindByName", query = "SELECT a FROM Account a WHERE name like :name")
public class Account { ... }

다음 코드 조각에서 볼 수 있듯이 Hibernate은 JPQL 쿼리를 수행하거나 EntityManager.find(Class entityClass, Object primaryKey) 메서드를 호출할 때 정의된 WHERE 절을 추가합니다.

TypedQuery<Account> q = em.createNamedQuery("Account.FindByName", Account.class);
q.setParameter("name", "%ans%");
Account a = q.getSingleResult();

16:07:59,511 DEBUG SQL:92 – select account0_.id as id1_0_, account0_.name as name2_0_, account0_.state as state3_0_ from Account account0_ where ( account0_.state <> 'DELETED') and (account0_.name like ?)

Account a = em.find(Account.class, a.getId());

16:07:59,540 DEBUG SQL:92 – select account0_.id as id1_0_0_, account0_.name as name2_0_0_, account0_.state as state3_0_0_ from Account account0_ where account0_.id=? and ( account0_.state <> 'DELETED')

결론

보았듯이 Hibernate를 사용하여 소프트 삭제를 구현하는 것은 매우 간단합니다.

Hibernate 버전이 6.4 이상이라면 엔터티 클래스에 @SoftDelete 어노테이션만 추가하면 됩니다. Hibernate는 각 레코드의 현재 상태를 자동으로 관리하고 모든 쿼리를 소프트 삭제된 레코드를 제외하도록 자동으로 조정합니다.

Hibernate 버전이 6.3 이하인 경우 소프트 삭제를 직접 구현해야 합니다. 이를 위해 엔터티 클래스에 @SQLDelete 어노테이션을 추가하고 레코드의 상태를 변경하는 SQL UPDATE 문을 제공해야 합니다. 또한 Hibernate의 @Where 어노테이션을 사용하여 기본적으로 모든 소프트 삭제된 레코드를 제외하는 조건을 정의해야 합니다.