[프로젝트] JPQL → QueryDSL 로 변경하기

💡 QueryDSL 이란?

하이버네이트 쿼리 언어(HQL: Hibernate Query Language)의 쿼리를 타입에 안전하게 생성 및 관리해주는 프레임워크

QueryDSL이 등장하기 이전에는 Mybatis, JPQL, Criteria 등 문자열 형태로 쿼리문을 작성하여 컴파일 시에 오류를 발견하는 것이 불가능했음

QueryDSL은 JPA 뿐만 아니라 SQL, MongoDB, Lucenece 등다양한 언어에 대해서 서비스를 제공함

QueryDSL을 사용하여 기존의 @Query를 대체하려면, JPAQueryFactory를 사용해 동적 쿼리를 작성할 수 있음

1. Q클래스 생성
- 해당 엔티티의 필드들을 객체로 다루는 도구
- QueryDSL이 컴파일 시 자동으로 생성 (Post → QPost)

 public class QPost extends EntityPathBase<Post> {
    public static final QPost post = new QPost("post");

    public final StringPath title = createString("title");
    public final DateTimePath<LocalDateTime> createdAt = createDateTime("createdAt", LocalDateTime.class);
    // other fields
}

2. 쿼리 생성 및 빌딩
- QueryDSL이 JPAQuery 객체를 사용하여 쿼리를 생성
- Q클래스의 필드들을 이용하여 동적 쿼리를 작성

QPost post = QPost.post;

List<Post> posts = new JPAQuery<>(entityManager)
        .select(post)                  // Select post
        .from(post)                    // From Post table
        .where(post.title.eq("test"))  // Where title = 'test'
        .fetch();                      // 쿼리 실행

 

💡 QueryDSL vs JPQL

	QueryDSL	JPQL
쿼리 작성 방식	메소드 체인 기반	문자열 기반
오류 검출	컴파일 타임에 오류 검출 가능	런타임 시 오류 발생 가능
동적 쿼리 작성	동적 쿼리 작성이 매우 유연함	불편함
가독성 및 유지보수	객체지향적 쿼리 작성 방식으로 가독성 높음	복잡한 쿼리에서는 가독성이 떨어질 수 있음

 

👾 QueryDSL 설정 코드

build.gradle

dependencies {
    // queryDSL 설정
    implementation "com.querydsl:querydsl-jpa:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"
    implementation "com.querydsl:querydsl-core"
    implementation "com.querydsl:querydsl-collections"
    annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta" // querydsl JPAAnnotationProcessor 사용 지정
    annotationProcessor "jakarta.annotation:jakarta.annotation-api" // java.lang.NoClassDefFoundError (javax.annotation.Generated) 대응 코드
    annotationProcessor "jakarta.persistence:jakarta.persistence-api" // java.lang.NoClassDefFoundError (javax.annotation.Entity) 대응 코드
}

// Querydsl 설정부
// 없으면 QClass들이 빌드 디렉토리에 들어감 -> gradle이 빌드하려고 스캔한 영역과 intellij가 스캔하고자 하는 빌드클래스 파일 영역을 한번 더 스캔하면서 충돌나면서 중복문제 발생
def generated = 'src/main/generated'

// querydsl QClass 파일 생성 위치를 지정
tasks.withType(JavaCompile) {
    options.getGeneratedSourceOutputDirectory().set(file(generated))
}

// java source set 에 querydsl QClass 위치 추가
sourceSets {
    main.java.srcDirs += [ generated ]
}

// gradle clean 시에 QClass 디렉토리 삭제
clean {
    delete file(generated)
}

.gitignore 에 추가

### Querydsl
/src/main/generated

 

📌 예제 1

public class HashtagService {
    private final HashtagRepository hashtagRepository;

    public void deleteUnusedHashtags(Set<Long> hashtagIds) {
        List<Hashtag> unusedHashtags = hashtagRepository.findUnusedHashtagsByIds(hashtagIds);
        for (Hashtag unusedHashtag : unusedHashtags) {
            hashtagRepository.delete(unusedHashtag);
        }
    }
}

 

✔️ 기존 코드:: JPQL

public interface HashtagRepository extends
        JpaRepository<Hashtag, Long>
{
    // 해시태그 중에서 PostHashtag에 속하지 않는 해시태그들 찾기
    @Query("SELECT h FROM Hashtag h WHERE h.postHashtags IS EMPTY AND h.id IN :hashtagIds")
    List<Hashtag> findUnusedHashtagsByIds(@Param("hashtagIds") Set<Long> hashtagIds);
}

 

✔️ 변경된 코드:: QueryDSL

public interface HashtagRepository extends
        JpaRepository<Hashtag, Long>,
        HashtagRepositoryCustom
{
}

public interface HashtagRepositoryCustom {
    List<Hashtag> findUnusedHashtagsByIds(@Param("hashtagIds") Set<Long> hashtagIds);
}

public class HashtagRepositoryCustomImpl extends QuerydslRepositorySupport implements HashtagRepositoryCustom {

    public HashtagRepositoryCustomImpl() {
        super(Hashtag.class);
    }

    @Override
    public List<Hashtag> findUnusedHashtagsByIds(Set<Long> hashtagIds) {
        QHashtag hashtag = QHashtag.hashtag;
       
        return from(hashtag)
                .select(hashtag)
                .where(hashtag.postHashtags.isEmpty()
                        .and(hashtag.id.in(hashtagIds)))
                .fetch();
    }
}

QHashtag.hashtag: QueryDSL에서 생성된 Q 클래스

hashtag.postHashtags.isEmpty(): postHashtags가 비어 있는지 확인하는 조건

hashtag.id.in(hashtagIds): id가 hashtagIds에 포함되는지 확인하는 조건

fetch(): 쿼리 실행 결과를 리스트로 가져온다

∴ postHashtags가 비어 있고, id가 특정 집합에 포함된 Hashtag 엔티티들을 조회

📌 

public class HashtagRepositoryCustomImpl extends QuerydslRepositorySupport implements HashtagRepositoryCustom

     HashtagRepositoryCustomImpl
     - Impl 붙여주면 querydsl이 인식 가능 (규약)
     - JPA의 기본 기능 외에 추가적인 쿼리 로직을 정의하기 위해 구현체 생성함

     extends QuerydslRepositorySupport
     - Spring Data JPA 에서 제공하는 클래스
     - QuerydslRepositorySupport 를 상속하면 JPAQueryFactory 를 자동으로 사용할 수 있어, 별도로 생성하지 않고도    
     QueryDSL 쿼리를 작성할 수 있다

     implements HashtagRepositoryCustom
     - HashtagRepositoryCustom 인터페이스를 구현


📌

public HashtagRepositoryCustomImpl() {
        super(Hashtag.class);
    }

     super : 부모 클래스의 생성자를 호출하는 역할
     QuerydslRepositorySupport 클래스는 상속받는 클래스에서 관리할 엔티티 클래스를 필요로 한다
     super(Hashtag.class);  : QuerydslRepositorySupport 가 Hashtag 엔티티를 기반으로 쿼리를 수행할 수 있도록 엔티티
                                                       클래스의 타입을 부모 클래스에게 전달

✔️ 쿼리 실행 결과

Hibernate: 
    select
        h1_0.id,
        h1_0.created_at,
        h1_0.created_by,
        h1_0.hashtag_name,
        h1_0.modified_at,
        h1_0.modified_by 
    from
        hashtag h1_0 
    where
        not exists(select
            1 
        from
            post_hashtag ph1_0 
        where
            h1_0.id=ph1_0.hashtag_id) 
        and h1_0.id in (?, ?)
2024-09-12T14:47:24.937+09:00 TRACE 68585 --- [nio-8080-exec-2] org.hibernate.orm.jdbc.bind              : binding parameter (1:BIGINT) <- [19]
2024-09-12T14:47:24.938+09:00 TRACE 68585 --- [nio-8080-exec-2] org.hibernate.orm.jdbc.bind              : binding parameter (2:BIGINT) <- [20]

 

📌 예제 2 - Join

Post post = notificationRepository.findPostByNotificationId(id)
                .orElseThrow(() -> new EntityNotFoundException("알림에 해당하는 포스트를 찾을 수 없습니다 - notiId: " + id));

 

✔️ QueryDSL 

public interface NotificationRepository extends
        JpaRepository<Notification, Long>,
        NotificationRepositoryCustom 
{
}

public interface NotificationRepositoryCustom {
    Optional<Post> findPostByNotificationId(Long id);
}

public class NotificationRepositoryCustomImpl extends QuerydslRepositorySupport implements NotificationRepositoryCustom {

    public NotificationRepositoryCustomImpl() {
        super(Notification.class);
    }

    @Override
    public Optional<Post> findPostByNotificationId(Long id) {
        QNotification notification = QNotification.notification;
        QPost post = QPost.post;
        QLike like = QLike.like;
        QPostComment postComment = QPostComment.postComment;

        Notification fetchedNotification = from(notification)
                .select(notification)
                .where(notification.id.eq(id))
                .fetchOne();

        // NotificationType에 따라 동적 조인
        switch (fetchedNotification.getNotificationType()) {
            case NEW_LIKE_ON_POST:
                return Optional.ofNullable(from(like)
                        .select(post)
                        .join(like.post, post)
                        .where(like.id.eq(fetchedNotification.getTargetId()))
                        .fetchOne());
            case NEW_COMMENT_ON_POST:
                return Optional.ofNullable(from(postComment)
                        .select(post)
                        .join(postComment.post, post)
                        .where(postComment.id.eq(fetchedNotification.getTargetId()))
                        .fetchOne());
        }
        return Optional.empty();
    }
}

 

✔️ 쿼리 실행 결과

Hibernate: 
    select
        p1_0.id,
        p1_0.content,
        p1_0.created_at,
        p1_0.created_by,
        p1_0.modified_at,
        p1_0.modified_by,
        p1_0.title,
        p1_0.user_id 
    from
        post_comment pc1_0 
    join
        post p1_0 
            on p1_0.id=pc1_0.post_id 
    where
        pc1_0.id=?

 

fetch()   vs   fetchOne()

- 둘 다 QueryDSL에서 결과를 가져올 때 사용하는 메서드들
- 반환하는 방식에서 차이가 있음

fetch()
- 다수 결과 가져옴
- 쿼리 결과로 나온 레코드들 → List 형태로 반환 (여러 행을 조회할 때 사용)

fetchOne()
- 하나의 객체나 값이 반환됨
- 결과가 없으면 Null 반환
- 결과가 두 개 이상이면 예외 발생