[SpringBoot] JPA QueryDSL 의존성 querydsl-apt는 왜 필요할까?

 

 

QueryDSL 의존성 추가를 위해서는 다음 두 가지 의존성을 추가해야 합니다.

implementation("com.querydsl:querydsl-jpa:5.0.0:jakarta")
annotationProcessor("com.querydsl:querydsl-apt:5.0.0:jakarta")

 

문득, 개발을 하다가 궁금한 점이 생겼는데, querydsl-jpa 의존성 하나로 해결할 수 없을까? 라는 생각으로 이번 글을 작성하게 되었습니다.

 

우선 querydsl 저장소를 살펴보면, 다음과 같이 다양한 의존성을 제공하고 있습니다. 그 중에서 우리가 사용하는 querydsl-jpa와 querydsl-apt도 볼 수 있습니다.

 

그리고, 우리가 사용하는 querydsl-jpa의 의존성을 보면 다음과 같이 querydsl-apt가 제공되는 것을 확인할 수 있죠

 

 

 

"아 그러면 굳이 qeurydsl-apt를 안 받아도 되겠구나!"라고 생각하고 의존성을 지운 다음 어플리케이션을 실행하니 다음과 같이 Qclass를 찾지 못 해서 오류가 발생합니다.

 

 

querydsl-jpa에서 제공해주는데 뭐가 문제인데..??

 

사실, 우리가 사용하는 querydsl-jpa는 말 그대로 실행을 위한 반쪽짜리 의존성입니다. 내부적으로 querydsl-apt를 의존하고 있긴 하지만, 이 의존성은 provided 스코프로 지정되어 있고, provided는 컴파일 시에는 필요하지만 빌드 결과물(JAR/클래스패스)이나 하위 모듈로는 전파되지 않는 스코프이기 때문에, 우리가 사용하는 프로젝트에서는 querydsl-apt가 annotation processing 대상이 되지 않습니다.

 

즉, Q 클래스가 자동으로 생성되지 않는 이유는 바로 이 의존성 스코프 때문입니다.  따라서 querydsl-apt를 직접 annotationProcessor 또는 kapt로 명시해줘야 컴파일 시점에 Q 클래스가 생성됩니다.

<dependency>
  <groupId>com.querydsl</groupId>
  <artifactId>querydsl-apt</artifactId>
  <version>${project.version}</version>
  <scope>provided</scope>
</dependency>

 

QueryDSL로 쿼리를 만들 때는 QClass를 통해 엔티티에 접근하게 되는데, 우리가 흔히 사용하는 select, from, where 등의 쿼리 메서드는 querydsl-jpa 라이브러리에 포함되어 있습니다. 하지만 그보다 더 핵심적인 역할을 하는 것이 바로 **Q 클래스를 생성하는 querydsl-apt**입니다.

 

이 QClass는 컴파일 타임에 생성되며, 런타임 시에는 별도로 생성되는 과정이 없습니다.
따라서 querydsl-apt는 반드시 annotationProcessor(또는 Kotlin의 경우 kapt)로 등록되어야 컴파일러가 동작하면서 Q 클래스를 만들어줄 수 있습니다.

 

사실상, QueryDSL의 핵심은 바로 이 Q 클래스를 통해 타입 안전하게 쿼리를 작성하는 데에 있는데요, 그럼에도 불구하고 그동안 querydsl-apt를 너무 당연하게 사용해 왔기 때문에 이를 간과하고 넘어갔었던 부분이었네요