Soft Delete를 선택적으로 적용하는 방법 (cc. @FilterDef, @Filter)

[songsunkook]

기존

@Where(clause = "is_deleted=0")를 엔티티 클래스에 적용하여 Soft Delete되지 않은 정보만 접근할 수 있도록 제한할 수 있다.

문제점

@Where은 조건에 성립하는 정보만 접근할 수 있도록 도와주지만 그 조건을 임의로 풀 수 없다. 결국 Soft Delete된 정보까지 조회가 필요한 경우가 생기면(ex. admin) 원활한 기능 수행이 어려워진다.

해결방안

@Where 대신 @FilterDef와 @Filter를 사용한다.
@FilterDef는 @Where와 달리 조건을 선택적으로 적용할 수 있다.

사용 방법

Entity Class

@FilterDef(name = "deletedArticleFilter", parameters = @ParamDef(name = "isDeleted", type = Boolean.class))
@Filter(name = "deletedArticleFilter", condition = "is_deleted=:isDeleted")
public class Article {
    ...
}

엔티티 클래스에 @FilterDef와 @Filter를 작성한다.

Service Class

엔티티 클래스에 접근할 클래스에서는 EntityManager가 필요하기 때문에 이를 의존성 주입으로 불러와야 한다.

@RequiredArgsConstructor
public class CommunityService {

    private final EntityManager em;

    ...

    private ArticlesResponse findArticles(boolean getSoftDeleted) {
        Session session = em.unwrap(Session.class);
        Filter filter = session.enableFilter("deletedArticleFilter");
        filter.setParameter("isDeleted", getSoftDeleted);

        // 로직 수행

        session.disableFilter("deletedArticleFilter");
        return getArticlesResponse;
    }

사용 절차는 다음과 같다.

1. EntityManager를 통해 session을 불러온다.
2. 엔티티 클래스에서 정의해두었던 filter를 session에서 enable한다.
3. filter에 파라미터를 입력한다. (ex. Soft Delete된 데이터 접근 여부)
4. 비즈니스 로직을 수행한다.
5. filter를 disable한다.

주의사항

Filter와 Session을 import할 때 여러 라이브러리가 나올텐데, 해당 기능은 hibernate에서 제공하는 것이기 때문에 hibernate의 라이브러리를 import해야 한다.

import org.hibernate.Filter;
import org.hibernate.Session;

참고

• feat: 게시글 목록 조회 구현 #158 (comment)
• @FilterDef 관련 문서