QueryDSL

🔎 QueryDSL

QueryDSL은 타입 안전한 SQL과 유사한 쿼리를 자바 코드로 작성할 수 있게 해주는 프레임워크입니다. JPA, MongoDB, SQL 등 다양한 백엔드를 지원하며, 특히 JPA와 함께 사용할 때 강력한 기능을 제공합니다.

🏷️ 특징

타입 안전한 쿼리 작성
자동 완성 지원으로 생산성 향상
동적 쿼리 작성 용이
다양한 데이터베이스 및 ORM 지원

🔎 QueryDSL 설정

QueryDSL을 사용하기 위해서는 프로젝트에 의존성을 추가하고 Q클래스를 생성해야 합니다.

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

🏷️ 특징

Maven 또는 Gradle을 통한 의존성 관리
APT(Annotation Processing Tool)를 사용한 Q클래스 자동 생성
JPA 엔티티 기반의 쿼리 도메인 클래스 생성

🔎 QueryDSL을 사용한 쿼리 작성

public List<User> findUsers(String username, Integer age) {
    QUser user = QUser.user;
    
    BooleanBuilder builder = new BooleanBuilder();
    if (StringUtils.hasText(username)) {
        builder.and(user.username.eq(username));
    }
    if (age != null) {
        builder.and(user.age.goe(age));
    }
    
    return queryFactory
        .selectFrom(user)
        .where(builder)
        .fetch();
}

🏷️ 특징

타입 안전한 쿼리 작성
메서드 체이닝을 통한 직관적인 쿼리 구성
동적 쿼리 작성이 용이
컴파일 시점에 오류 검출 가능

🔎 QueryDSL의 장단점

🏷️ 장점

타입 안전성 보장
IDE의 자동 완성 기능 활용 가능
동적 쿼리 작성이 편리
복잡한 쿼리도 자바 코드로 작성 가능

🏷️ 단점

학습 곡선이 존재
프로젝트 설정이 다소 복잡
Q클래스 생성으로 인한 빌드 시간 증가

🔎 주의사항

Q클래스 관리: 생성된 Q클래스를 버전 관리에 포함시키지 않도록 주의

gitignoreCopy/target/generated-sources/

페이징 처리: fetchResults() 메서드 사용 시 주의 필요 (deprecate 예정)

QueryResults<User> results = queryFactory
    .selectFrom(user)
    .offset(pageable.getOffset())
    .limit(pageable.getPageSize())
    .fetchResults();

return new PageImpl<>(results.getResults(), pageable, results.getTotal());

성능 최적화: 필요한 컬럼만 조회하는 프로젝션 사용

List<String> usernames = queryFactory
    .select(user.username)
    .from(user)
    .fetch();

테스트 작성: QueryDSL 쿼리에 대한 단위 테스트 및 통합 테스트 작성 권장

JPQL과의 병행 사용: 복잡한 쿼리는 QueryDSL, 간단한 쿼리는 JPQL 사용 고려