[Java/JPA] QueryDSL이란?

QueryDSL

QueryDSL은 Java 기반의 타입 안전(type-safe)한 SQL 쿼리 생성 라이브러리입니다. 주로 JPA, Hibernate 등과 함께 사용되어 복잡한 쿼리를 코드로 안전하게 작성할 수 있도록 도와줍니다. 다음은 QueryDSL의 주요 특징과 장점, 그리고 사용 예시입니다.

 

QueryDSL은 정적 타입을 이용해서 SQL과 같은 쿼리를 생성할 수 있도록 해 주는 오픈소스 프레임워크이다. Fluent API를 이용해 코드 작성 형식으로 쿼리를 생성할 수 있게 한다.

 

QueryDSL이 적합한 상황은 아래와 같다.

1. 복잡한 검색 조건이 필요한 경우 (ex. 게시판 필터, 검색 기능)
2. 동적 쿼리가 자주 필요한 도메인
3. SQL 쿼리를 문자열이 아닌 안전한 코드로 다루고 싶을 때

Querydsl - Unified Queries for Java

 

QueryDSL을 사용하는 이유

1. 쿼리를 Java 코드로 작성하기 때문에, 컴파일 시점에 문법 오류를 잡을 수 있다.
   • SQL 문자열 기반 쿼리(JPQL, Native Query)보다 런타임 오류가 줄어드는 장점이 있음.
     → JPQL은 쿼리를 문자열로 작성하기 때문에, 잘못 작성하거나 오타가 있는 경우에도 컴파일 시점에 에러가 발생하지 않다가 런타임 중에 에러가 발생하기 때문에 실행 전에는 잘못된 부분을 파악할 수 없다.
2. 동적 쿼리 작성이 용이하다. (Q클래스, 메서드 사용)
   • IF 조건 등을 사용하여 유연하게 조건을 추가할 수 있다.
   • 복잡한 검색 조건(ex. 여러 검색 필터 적용)에 적합하다.
     → JPQL을 이용해 동적 쿼리를 다루기 위해서는 문자열을 조건에 맞게 조합하여 사용해야 한다. 이 경우 코드가 복잡해지고 런타임 에러를 발생시킬 수 있다는 치명적인 단점이 존재한다.
3. IDE 자동완성을 지원한다.
   • Q클래스를 통해 필드명 자동완성이 가능하여 생산성이 향상된다.
4. SQL-Like한 문법을 Java 코드로 표현할 수 있기에 문법이 직관적이다.

 

QueryDSL 사용 예시

1. Entity 클래스

@Entity
public class Member {
    @Id @GeneratedValue
    private Long id;
    private String username;
    private int age;
}

 

2. Q클래스 생성

Gradle 또는 Maven에서 annotationProcessor 설정으로 Q클래스(QMember) 자동 생성

 

Maven의 경우, IntelliJ 우측 메이븐 도구 - Lifecycle - compile을 실행하여 Q클래스를 생성할 수 있다.

Maven - 프로젝트명 - Lifecycle - compile

target - generated-sources - annotations 하위

 

3-1. 정적 쿼리 예시

JPAQueryFactory queryFactory = new JPAQueryFactory(entityManager);
QMember member = QMember.member;

Member result = queryFactory
    .selectFrom(member)
    .where(member.username.eq("홍길동"))
    .fetchOne();

 

3-2. 동적 쿼리 예시

public List<Member> search(String usernameCond, Integer ageCond) {
    return queryFactory
        .selectFrom(member)
        .where(
            usernameEq(usernameCond),
            ageEq(ageCond)
        )
        .fetch();
}

private BooleanExpression usernameEq(String username) {
    return StringUtils.hasText(username) ? member.username.eq(username) : null;
}

private BooleanExpression ageEq(Integer age) {
    return age != null ? member.age.eq(age) : null;
}

 

 

QueryDSL 메서드 종류

목적	메서드	설명
SELECT	select(), selectFrom()	조회할 컬럼 또는 엔티티를 지정
FROM	from()	조회할 테이블(Q타입)을 지정 (selectFrom은 select + from 결합)
WHERE	where()	조건절 설정 (BooleanExpression 넣음)
GROUP BY	groupBy()	그룹핑
HAVING	having()	그룹 조건
ORDER BY	orderBy()	정렬 조건
JOIN	join(), leftJoin(), rightJoin()	조인 (inner, left, right 등)
UPDATE	update()	테이블에 대한 수정 쿼리
DELETE	delete()	테이블에 대한 삭제 쿼리
INSERT	insert()	SQLQueryFactory 사용 시 가능, JPA에서는 직접적으로 지원 X
FETCH	fetch(), fetchOne(), fetchFirst(), fetchResults()	결과 반환 메서드

 

WHERE 조건절 메서드 (BooleanExpression)

SQL 표현	QueryDSL 표현	설명
=	eq()	같음
!=	ne()	다름
>	gt()	크다 (greater than)
<	lt()	작다 (less than)
>=	goe()	크거나 같다 (greater or equal)
<=	loe()	작거나 같다 (less or equal)
IN (...)	in()	포함됨
NOT IN (...)	notIn()	포함되지 않음
LIKE	like(), contains(), startsWith()	문자열 포함 여부
IS NULL	isNull()	null인지 확인
IS NOT NULL	isNotNull()	null이 아닌지 확인
AND, OR	.and(), .or()	조건 조합
NOT	.not()	부정 조건
BETWEEN A AND B	between()	범위 조건

 

예시 코드

QMember member = QMember.member;

// SELECT * FROM member WHERE username = '홍길동'
queryFactory.selectFrom(member)
            .where(member.username.eq("홍길동"))
            .fetch();

// WHERE age > 20 AND age < 30
queryFactory.selectFrom(member)
            .where(member.age.gt(20).and(member.age.lt(30)))
            .fetch();

// WHERE username IN ('a', 'b', 'c')
queryFactory.selectFrom(member)
            .where(member.username.in("a", "b", "c"))
            .fetch();

// WHERE age IS NOT NULL
queryFactory.selectFrom(member)
            .where(member.age.isNotNull())
            .fetch();

// UPDATE member SET username = '변경됨' WHERE age < 20
queryFactory.update(member)
            .set(member.username, "변경됨")
            .where(member.age.lt(20))
            .execute();

// DELETE FROM member WHERE age > 60
queryFactory.delete(member)
            .where(member.age.gt(60))
            .execute();