[QueryDSL] @QueryProjection (feat. 프로젝션)

 

 

 

 

 

프로젝션

프로젝션은 select절에 대상을 지정하는 것입니다.

 

프로섹션 대상이 하나인 경우,

둘 이상인 경우,

DTO로 조회하는 경우에 대한 방법이 모두 다르기에 하나하나 예시를 동해 알아가보도록 하겠습니다.

 

 

 

그전에 우선 프로젝션을 사용할 때 가장 권장되는 방법인 @QueryProjection의 사용법부터 알아보겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

@QueryProjection

@QueryProjection은 생성자를 통해 DTO를 조회하는 방법과 함께 사용됩니다.

 

 DTO의 생성자에 @QueryProjection을 붙여주어야 합니다.

 

data class MemberDtoQueryProjection @QueryProjection constructor(
    val username: String,
    val age: Int,
)

 

이후 빌드 시 DTO가 Q파일로 생성됩니다.

 

 

 

생성된 Q타입은 다음과 같이 사용할 수 있습니다.

/**
 * 프로젝션 - @QueryProjection 사용
 *
 * 단점 - Q클래스 생성
 *     - DTO가 QueryDSL에 대한 의존성을 가짐
 */
@Test
fun testQueryProjection() {

    val fetch = query
        .select(QMemberDtoQueryProjection(member.username, member.age))
        .from(member)
        .fetch()

    fetch.forEach { println(it) }

}

 

 

@QueryProjection을 사용하면 컴파일 시에 타입 체크를 할 수 있어 이후 소개할 여러 방법들보다 안전한 방법입니다.

 

그러나 DTO에 QueryDSL 어노테이션을 유지해야 하는 점과(의존성의 추가), DTO까지 Q파일을 생성해야 하는 단점이 있습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

프로젝션 대상이 하나인 경우

대상이 하나라면 타입을 명확하게 지정하여 결과값으로 반환받을 수 있습니다.

@Test
fun testSimpleProjection() {
    //given
    val fetch: List<String> = query
        .select(member.username)
        .from(member)
        .fetch()

    //when
    fetch.forEach { println(it) }
}

 

member의 username은 String이므로 위와 같이 String 타입으로 바로 조회할 수 있습니다.

 

 

 

 

 

 

 

 

프로젝션 대상이 둘 이상

프로젝션 대상이 둘 이상인 경우에는 Tuple을 사용하여 결과를 조회할 수 있습니다.

@Test
fun testTupleProjection() {
    val fetch = query
        .select(member.username, member.age)
        .from(member)
        .fetch()
    
    fetch.forEach {
        println("username : ${it.get(member.username)}")
        println("age : ${it.get(member.age)}")
    }
}

 

참고로 Tuple을 사용하는 경우, 프로젝션 할 때 사용했던 Expression을 그대로 사용하여 get의 인자로 넘겨주어 사용할 수 있습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

DTO로 조회 

Projections를 사용합니다.

 

 

 

QueryDSL은 3가지의 방법을 통해 DTO로 조회할 수 있도록 지원합니다.

• 프로퍼티 접근 (Setter) : setter와 기본 생성자 필수
• 필드 직접 접근 : 기본 생성자 필수
• 생성자 사용 : 타입이 일치하는 생성자 필수

 

 

 

 

 

 

 

 

1. 프로퍼티 접근법 - Setter 사용

Projections.bean()을 사용합니다.

data class MemberDto(
    var username: String? = null,
    var age: Int? = null,
) 
/**
 * 프로젝션 - DTO 조회
 *
 * 프로퍼티(세터), 필드 직접, 생성자 모두
 *
 * 세터 - bean - 기본 생성자 필수
 */
@Test
fun testDTOProjection_setter() {
    //given
    val fetch = query
        .select(Projections.bean(
            MemberDto::class.java,
            member.username,
            member.age))
        .from(member)
        .fetch()

    //when
    fetch.forEach {
        println(it)
    }
}

 

 

 

 

 

 

 

 

 

 

2. 필드 직접 접근

Projections.fields()을 사용합니다.

data class MemberDto(
    var username: String? = null,
    var age: Int? = null,
) 
/**
 * 프로젝션 - DTO 조회
 *
 * 프로퍼티, 필드 직접, 생성자 모두
 *
 * 필드 - fields - 기본 생성자 필수(getter, setter 없어도 돼)
 */
@Test
fun testDTOProjection_field() {
    //given
    val fetch = query
        .select(Projections.fields(
            MemberDto::class.java,
            member.username,
            member.age))
        .from(member)
        .fetch()

    //when
    fetch.forEach {
        println(it)
    }
}

 

 

 

 

DTO와 Entity의 필드명이 다른 경우

ExpressionUtils.as(source, alias) : 필드나 서브 쿼리에 별칭을 적용할 사용합니다.
username.as(alias) : 필드에 별칭을 적용할 때 사용합니다.

 

 

 

data class UserDto(
	var name: String? = null,
	var aage: Int? = null,
) 
/**
 * 프로젝션 - DTO 조회
 *
 * fields  - 전체 생성자 있어야 함
 *
 * 별칭이 다른 경우 - as 사용
 */
@Test
fun testDTOProjection_field_other_alias() {
    //given
    val m = QMember("sub")
    val fetch = query
        .select(Projections.fields(
            UserDto::class.java,
            member.username.`as`("name"),
            ExpressionUtils.`as`(JPAExpressions.select(m.age.max()).from(m), "aage")))
        .from(member)
        .fetch()

    //when
    fetch.forEach {
        println(it)
    }
}

 

 

 

 

 

 

3. 생성자 사용

Projections.contructor()을 사용합니다.

 

data class MemberDto(
    var username: String? = null,
    var age: Int? = null,
) 
/**
 * 프로젝션 - DTO 조회
 *
 * 프로퍼티, 필드 직접, 생성자 모두
 *
 * 생성자 - constructor - 전체 생성자 있어야 함
 */
@Test
fun testDTOProjection_constructor() {
    //given
    val fetch = query
        .select(Projections.constructor(
            MemberDto::class.java,
            member.username,
            member.age))
        .from(member)
        .fetch()

    //when
    fetch.forEach {
        println(it)
    }
}

 

 

 

 

 

 

 

 

 

 

 

Reference

실전! Querydsl - 인프런 | 강의