QueryDSL(Query Domain-Specific Language)
📌 SQL, JPQL 같은 쿼리를 Java 코드로 작성할 수 있게 해주는 타입 안전한 ORM 기반 쿼리 빌더
- SQL을 Java 코드로 작성하면서, 가독성과 유지보수성을 대폭 개선할 수 있는 도구
- SQL-like 문법을 활용하여 가독성과 유지보수성을 향상시킵니다.
2. QueryDSL의 필요성
- 문법 오류 방지:
- QueryDSL은 컴파일 타임에 문법 오류를 검출하여, 런타임 오류를 예방합니다.
- 필드 이름 변경 문제 해결:
- 엔티티 필드가 변경되더라도, 쿼리가 자동으로 동기화됩니다.
- 동적 쿼리 작성 용이성:
- 여러 조건을 유연하게 조합할 수 있는 동적 쿼리를 간단히 작성할 수 있습니다.
- 복잡한 쿼리 지원:
- 조인, 서브쿼리, 그룹핑, 집계 등 복잡한 SQL 쿼리도 쉽게 작성 가능합니다.
3. QueryDSL의 장단점
| 장점 | 단점 |
| 타입 안전성: 컴파일 타임에 오류 감지. | 초기 설정이 복잡하고 의존성 관리 필요. |
| 가독성 향상: 명확한 SQL-like 문법. | Q 클래스 자동 생성 과정 필요. |
| 유지보수성 향상: 엔티티 필드 변경 반영. | 러닝 커브 존재. |
| 동적 쿼리 작성 용이. | 간단한 CRUD 프로젝트에서는 과잉 도구. |
4. QueryDSL 사용 예시
4.1 기본 설정
- build.gradle.kts
dependencies {
implementation("com.querydsl:querydsl-jpa:5.0.0")
kapt("com.querydsl:querydsl-apt:5.0.0:jpa")
}
kapt {
arguments {
arg("querydsl.entityAccessors", "true")
}
}
4.2 기본 코드 예시
- 동적 쿼리 작성 예
import com.querydsl.jpa.impl.JPAQueryFactory;
import com.querydsl.core.BooleanBuilder;
public List<User> findUsers(JPAQueryFactory queryFactory, Integer age, String name) {
QUser user = QUser.user;
BooleanBuilder builder = new BooleanBuilder();
if (age != null) {
builder.and(user.age.gt(age));
}
if (name != null) {
builder.and(user.name.eq(name));
}
return queryFactory.selectFrom(user)
.where(builder)
.fetch();
}
4.3 복잡한 쿼리 예
- 조인과 그룹핑
QOrder order = QOrder.order;
QCustomer customer = QCustomer.customer;
List<Tuple> result = queryFactory
.select(customer.name, order.totalAmount.sum())
.from(order)
.join(order.customer, customer)
.groupBy(customer.name)
.fetch();
5. QueryDSL 적용이 적합한 경우
- 동적 쿼리가 많은 프로젝트:
- 사용자 필터링, 복잡한 검색 기능 등이 포함된 시스템.
- 대규모 애플리케이션:
- 조인, 서브쿼리 등 복잡한 쿼리가 많은 환경.
- 가독성과 유지보수가 중요한 팀:
- SQL을 명시적으로 작성하지 않고, 코드에서 명확히 관리.
6. QueryDSL 적용이 부적합한 경우
- 간단한 CRUD 중심 프로젝트:
- 네이티브 SQL 또는 JPA 기본 기능으로 충분한 경우.
- 네이티브 SQL 중심 환경:
- SQL 문법을 직접 작성해야 하는 시스템.
7. QueryDSL의 대안
| 기술 | 특징 |
| JPA Criteria | JPA 표준, QueryDSL과 비슷하지만 코드가 장황해짐. |
| Native SQL | 데이터베이스 벤더에 특화된 SQL 작성 가능. |
| Spring Data JPA | 메서드 이름으로 간단한 쿼리 작성 가능, 동적 쿼리는 다소 어려움. |
8. 학습하면 좋은 추가 주제
- QueryDSL의 고급 기능:
- 서브쿼리 작성, 복잡한 집계 함수 활용.
- QueryDSL과 Spring Data JPA 통합:
- QueryDSL PredicateExecutor 활용.
- QueryDSL 성능 최적화:
- 페이징 쿼리, 배치 처리 전략.
- Q 클래스 생성 관리:
- Q 클래스 자동 생성 도구(Maven, Gradle) 설정.
JDBC, JPA, JPQL, QueryDSL 비교
| JDBC | JPA | JPQL | QueryDSL | |
| 정의 | Java에서 DB와 직접 상호작용하기 위한 저수준 API. | 객체와 데이터베이스 간 매핑을 자동화하는 ORM 프레임워크. | JPA에서 사용되는 객체 지향 쿼리 언어. | JPA 기반 타입 안전한 쿼리 빌더. |
| 작성 방식 | SQL을 직접 작성. | 메서드 호출로 DB 작업. | SQL과 유사한 문법으로 JPA 엔티티를 다룸. | Java 코드로 SQL-like 문법 작성. |
| 장점 | - 직접 SQL 작성으로 세밀한 제어 가능. | - 자동화로 개발 생산성 증가.- 데이터베이스 독립성 보장. | - SQL 대신 객체 지향적으로 쿼리 작성 가능.- JPA와 자연스럽게 연동 가능. | - 타입 안전성 보장.- 동적 쿼리 작성 용이.- 가독성과 유지보수성 향상. |
| 단점 | - 코드가 장황하고 반복적임.- 데이터베이스 종속적. | - 초기 학습 곡선 존재.- 성능 최적화를 위해 추가 설정 필요. | - 런타임 시 오류 검출.- 동적 쿼리 작성 어려움.- 가독성이 떨어짐. | - 초기 설정 복잡.- Q 클래스 생성 필요.- 러닝 커브 존재. |
| 사용 시기 | - 고성능 작업이나 데이터베이스 벤더 특화 기능이 필요한 경우. | - 일반적인 CRUD 작업과 객체 지향적 접근이 필요한 경우. | - 단순하고 고정된 객체 지향 쿼리가 필요한 경우. | - 복잡한 동적 쿼리나 타입 안전성을 중시하는 경우. |
| 실행 시점 | - SQL 문법이 컴파일 시점에 확인되지 않음(런타임 확인). | - SQL은 자동 생성됨. JPA 설정에 따라 실행.- 런타임 시 SQL 확인 가능. | - 런타임 시 JPQL 파싱 및 실행.- 실행 중 문법 오류 발견. | - SQL 문법을 컴파일 시점에 확인 가능. |
| 적용 환경 | - 소규모 프로젝트.- SQL 최적화가 중요한 경우. | - 대규모 시스템.- 비즈니스 로직이 복잡한 경우. | - JPA를 사용하는 환경에서 정적 쿼리를 작성할 때. | - 대규모 프로젝트에서 유지보수성 및 가독성이 중요한 경우. |
| 학습 난이도 | 낮음 (SQL만 익숙하면 사용 가능). | 중간 (ORM 개념 및 설정 학습 필요). | 중간 (SQL과 유사하지만 JPA 개념 필요). | 높음 (JPA와 QueryDSL 문법 학습 필요). |
주요 선택 기준
- JDBC: SQL에 익숙하며, 데이터베이스에 최적화된 세부 작업이 필요한 경우.
- JPA: 객체 지향적으로 데이터를 처리하고, 데이터베이스 독립성을 중시하는 경우.
- JPQL: 객체 지향적 쿼리가 필요하지만, 단순한 정적 쿼리 위주로 사용할 때.
- QueryDSL: 동적 쿼리와 복잡한 조건 쿼리가 빈번히 요구되며, 가독성과 타입 안전성을 중시할 때.