Spring Config Client와 QueryDSL 충돌

1. 문제의 시작

기존 모놀리스 프로젝트에 MSA 아키텍처를 도입하던 중, Config Repository와 Config Server를 띄운 후에 Config Client의 연결성을 구성하는 과정에서 아래와 같은 에러를 컴파일러가 건네주었다.

Could not find org.springframework.cloud:spring-cloud-starter-config:.
Required by:
    project :

Possible solution:
 - Declare repository providing the artifact, see the documentation at https://docs.gradle.org/current/userguide/declaring_repositories.html

에러가 건네준 링크에서는 Gradle 프로젝트에서 리포지토리를 명시하는 방법에 대한 내용만 있고, 문제의 원인이나 해결방법에 대한 힌트를 얻지 못했다. 하여간 에러에서 알려주는 내용만 가지고는 어떻게 해결하기는 어려운 상황이었는데, 내가 검색 요령이 없는건지 같은 트러블을 만났던 사람이 없는건지 구글링을 해봐도 관련 내용은 전혀 없었고, GPT의 힘을 빌리자니 문제 파악을 전혀 못하고 있는데 도움을 줄 수 있을리가 없었다(당연하다, 오히려 좋아).

스스로 파헤쳐보려고 머리를 계속 굴리다가 사용 중인 dependencies를 다시 처음부터 하나하나 추가해보면서 어떤 의존성에서 발생되는 것인지 파악해보려 했다.

그 결과로, 기존 의존성에서 QueryDSL을 제거하고 Config Client를 추가했을 때는 문제 없이 build되는 것을 확인할 수 있었다.

1.1 Config Client Dependency

ext {
  set('springCloudVersion', "2023.0.0")
}

dependencies {
  implementation 'org.springframework.cloud:spring-cloud-starter-config'
}

dependencyManagement {
  imports {
    mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
  }
}

1.2 QueryDSL Dependency

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"

2. 문제의 원인

어떤 이유로 Config Client가 build 될 수 없는지 정확한 파악은 어려웠다.

다만 QueryDSL의 의존성 중에서

annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"

에서 문제가 발생되는 것을 확인할 수 있었다.

참고

querydsl-apt 라이브러리는Q타입 class를 자동 생성해주는 역할을 한다.

3. 문제 해결

그래서 아래 명령어로 dependencies 구성 문제를 정확히 살펴보았다.

./gradlew dependencies

javax 의존성이 있어서 이상하다 생각했다.

Spring Boot 3.x 부터 jakarta 로 대체되었기 때문이다. 그래서 현재 버전에 맞는 querydsl-apt 버전을 직접 기입해보았다.

implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"
annotationProcessor "jakarta.annotation:jakarta.annotation-api"
annotationProcessor "jakarta.persistence:jakarta.persistence-api"

이 시도로 문제가 해결되었다.

4. 문제 정리

• MSA를 구성하는 서비스들 중에 Config Client 의존성이 추가된 것에서만 이 글에서 다룬 에러가 발생되었다.
• 문제가 생기는 서비스의 의존성에서 Config Client만 제거하면 문제가 사라졌고, 추가하면 문제가 생겨났다.
  • Spring Boot가 관리하는 Config Client 의존성이 QueryDSL과 함께 사용될 때 내부적으로 충돌이 생겨 javax로 다운그레이드 되는 것일 수 있다.
• 1.2절의 QueryDSL Dependency 문장 ${~} 부분에서 Spring Boot가 판단 하에 설정하는 의존성이 잘못 들어오는 걸로 확인된다.