Spring Boot 3.0 이상에서 QueryDsl 프로젝트 세팅

썸네일

진행 버전은 다음과 같습니다.
- Java 17
- JDK 17
- Spring Boot 3.1.4
- QueryDsl 5.0.0

 

build.gradle

// QueryDsl 이라고 주석이 달린 부분이 기본 build.gradle에서 추가해준 부분이다.

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.1.4'
    id 'io.spring.dependency-management' version '1.1.3'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'

java {
    sourceCompatibility = '17'
}

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'com.h2database:h2'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'

    // QueryDsl
    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"
}

tasks.named('test') {
    useJUnitPlatform()
}

// QueryDsl
def querydslSrcDir = 'src/main/generated'

clean {
    delete file(querydslSrcDir)
}

tasks.withType(JavaCompile) {
    options.generatedSourceOutputDirectory = file(querydslSrcDir)
}

 

테스트를 위한 Entity 생성

QueryDsl이 제대로 설정되었는지 확인하기 위해 간단한 Entity를 생성해보자.

@Entity
@Getter
@Setter
public class Hello {

    @Id
    @GeneratedValue
    private Long id;
}

 

./gradlew clean build
./gradlew compileJava

clean build 후 compileJava를 실행하면 아래 사진과 같은 위치에 Q클래스가 생성된다.

 

build.gradle에서 querydslSrcDir 변수 값을 변경하여 폴더를 변경할 수 있다.

Q클래스가 생성된 모습

 

Q클래스를 git에 올리지 말자

Q클래스는 시스템이 자동으로 생성해준 파일이다. 라이브러리 버전이 올라가는 등 변경사항이 발생하면 Q클래스의 세부적인 내용이 변경될 수 있으므로, 나중에 pull을 받을 때 conflict가 발생할 수 있다.

TMI
이전에 iOS를 공부했을 때 코드 변경사항이 있을 때 pbxproj 파일의 내용이 변경되어 pull할 때 conflict가 발생했던 경험이 있다.
이와 비슷한 상황인 것 같다.

그러므로 Q클래스가 담긴 src/main/generated 폴더를 .gitignore에 추가해주도록 하자.

 

테스트 코드를 통한 검증

@SpringBootTest
@Transactional
class QuerydslPracticeApplicationTests {

    @Autowired
    EntityManager em;

    @Test
    void contextLoads() {
        Hello hello = new Hello();
        em.persist(hello);

        JPAQueryFactory query = new JPAQueryFactory(em);
        QHello qHello = new QHello("h");

        Hello result = query
            .selectFrom(qHello)
            .fetchOne();

        assertThat(result).isEqualTo(hello);
        assertThat(result.getId()).isEqualTo(hello.getId()); // lombok 테스트
    }

}

테스트 코드 결과

QueryDsl을 위한 메서드가 잘 호출되며, 테스트 코드도 잘 통과하는 것을 확인할 수 있다.

 

Reference

https://www.inflearn.com/course/Querydsl-%EC%8B%A4%EC%A0%84

https://lordofkangs.tistory.com/461