SpringData 쿼리와 QueryDSL

1. SpringData 쿼리

SpringData Common의 CrudRepository와 PagingAndSortingRepository 쿼리기능을 제공

 

사용 방법

• 프로그래밍되어 제공되는 쿼리명 규칙
  • 리턴타입 {접두어}{도입부}By{프로퍼티 표현식}(조건식)(And|Or){프로퍼티 표현식}(조건식) (매개변수...)

접두어	Find, Get, Query, Count, ...
도입부	Distinct, First(N), Top(N)
프로퍼티 표현식	Person.Address.ZipCode => find(Person)ByAddress_ZipCode(...)
조건식	IgnoreCase, Between, LessThan, GreaterThan, Like, Contains, ...
정렬 조건	OrderBy{프로퍼티}Asc
리턴 타입	E, Optional<E>, List<E>, Page<E>, Slice<E>, Stream<E>
매개변수	Pageable, Sort

2. QueryDSL

QueryDSL의 Predicate 인터페이스로 조건문을 여러 개 구성하여 따로 관리할 수 있다

~ 주로 findOne(Predicate), findAll(Predicate) 메소드를 사용한다

- findOne(Predicate) : Optional<T> 리턴

- findAll : List<T> | Page<T> | Iterable<T> | Slice<T> 리턴

 

Type Safe 기능

조건문 구성 시 사용하는 객체, 필드 조건이 실제 타입과 일치하는 지 체크해준다

 

장점

1. 문자가 아닌 코드로 쿼리를 작성하므로, 컴파일 시 문법 오류를 쉽게 확인할 수 있다

2. 자동 완성 등 IDE의 도움을 받을 수 있다

3. 동적인 쿼리 작성이 편리하다

4. 쿼리 작성 시 제약 조건 등을 메서드 추출을 통해 재사용할 수 있다.

 

원리

QueryDSL 의존성을 추가하면 SpringData에 의해 QueryDslPreficateExecutor 인터페이스가 추가된다

-> QueryDslPreficateExecutor 인터페이스 : Repository가 QueryDSL을 실행할 수 있도록 인터페이스를 제공한다

 

사용 방법

~ Spring 2.x : queryDSL 의존성, 소스 디렉토리 설정, annotation 프로세서 설정, Task 정의를 해야 한다

plugins {
    ...
    id "com.ewerk.gradle.plugins.querydsl" version "1.0.10"
}

compileQuerydsl{
    options.annotationProcessorPath = configurations.querydsl
}

configurations {
    ...
    querydsl.extendsFrom compileClasspath
}

def querydslSrcDir = 'src/querydsl/generated'

querydsl {
    library = "com.querydsl:querydsl-apt"
    jpa = true
    querydslSourcesDir = querydslSrcDir
}

sourceSets {
    main {
        java {
            srcDirs = ['src/main/java', querydslSrcDir]
        }
    }
}

project.afterEvaluate {
    project.tasks.compileQuerydsl.options.compilerArgs = [
            "-proc:only",
            "-processor", project.querydsl.processors() +
                    ',lombok.launch.AnnotationProcessorHider$AnnotationProcessor'
    ]
}

dependencies {
    implementation("com.querydsl:querydsl-jpa") // querydsl
    implementation("com.querydsl:querydsl-apt") // querydsl
    ...
}

gradle 빌드 스크립트 원리

• Gradle 빌드시에 QueryDSL은 프로젝트 내의 **@Entity** 어노테이션을 선언한 클래스를 탐색하고,  **JPAAnnotationProcessor**를 사용해 Q클래스를 생성합니다.
• **querydsl-apt**가 **@Entity** 및 **@Id** 등의 매핑정보 Annotation을 알 수 있도록, **javax.persistence**과 **javax.annotation**을 annotationProcessor에 함께 추가합니다.
  • **annotationProcessor**는 Java 컴파일러 플러그인으로서, 컴파일 단계에서 어노테이션을 분석 및 처리함으로써 추가적인 파일을 생성합니다.
• 개발 환경에서 생성된 Q클래스를 인지할 수 있도록 /build/generated 디렉토리를 프로젝트의 sourceSet에 추가합니다.
  • 이로써, IDE 에서도 생성된 Q클래스 파일을 인식하여 개발할 수 있습니다.

Spring 3.x ~ : 의존성 추가 Only

// application.yml

dependencies {
		....

		// 9. QueryDSL 적용을 위한 의존성 (SpringBoot3.0 부터는 jakarta 사용해야함)
    implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
    annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"
    annotationProcessor "jakarta.annotation:jakarta.annotation-api"
    annotationProcessor "jakarta.persistence:jakarta.persistence-api"
}

Join이 필요한 경우엔 사용할 수 없다

• 전체 채널에서 내가 멘션된 쓰레드 목록 조회 기능 만들기
  1. Mention 엔티티 생성
  2. User - Mention - Thread 다대다 연관관계 설정
  3. User, Mention 조건으로 Thread 목록 조회 쿼리수행

~ QueryPredicatieExecutor로는 Join 연산이 불가능하여 구현 불가능 : 멤버 컬렉션까지만 조회 가능하다

QuerydslPredicateExecutor의 단점 : 묵시적 조인( 1 Depth 자동 조인) ~ Channel의 Thread까지만 조회할 수 있다

<-> Join 연산이 수행되는 명시적 조인(2 Depth 이상 조인)

Join 이 없는 대신 조건이 많은 쿼리

해당 채널에서 메세지가 있는 쓰레드 목록 조회 기능 만들기 ~

Channel 조건으로 메세지 본문이 있는 Thread 목록 조회 쿼리수행

 

Join 없이 조건이 많이 추가될수록 **QuerydslPredicateExecutor** 를 활용할 수 있다.

~ 사실 현업에서는 요건 잘 안쓰고 JPAQueryFactory 를 주로 쓴다