[Querydsl] 내가 찾아 쓰려고 정리한 글

 

 

🏃‍♂️ 계속해서 업데이트 하기 🏃‍♂️ 

마지막 업데이트 2022/03/29

 

1. Querydsl 을 왜 사용할까?

2. 작동방식?

3. 의존성

4. Repository 구조

5. Projection 의 대한 고찰 ...

6. 동적쿼리 (BooleanBuilder)

7. ExpressionUtils

8. 정렬 타입에 따른 정렬 처리

 

 

 

Querydsl 을 왜 사용할까?

 

JPA 를 사용하면서 (@Query 포함) 조회 기능에 대한 한계가 있다.

동적인 쿼리인 경우인데 예를 들어 주문 페이지를 검색 한다고 했을 때 카테고리 or 상품명 or 기업명 등등... 으로 검색 조건이 달라지는 부분이다.

 

그래서 사용하게 된 것이 바로 Querydsl 프레임워크 이다.

- 타입 체크가 바로 가능하다

- 자바 코드를 기반으로 쿼리를 작성한다

 

작동방식?

Querydsl -> JPQL -> SQL 

 

 

의존성

    <dependency>
      <groupId>com.querydsl</groupId>
      <artifactId>querydsl-jpa</artifactId>
    </dependency>

    <dependency>
      <groupId>com.querydsl</groupId>
      <artifactId>querydsl-apt</artifactId>
    </dependency>
    
    <plugin>
        <groupId>com.mysema.maven</groupId>
        <artifactId>apt-maven-plugin</artifactId>
        <version>1.1.3</version>
        <executions>
          <execution>
            <goals>
              <goal>process</goal>
            </goals>
            <configuration>
              <outputDirectory>target/generated-sources/java</outputDirectory>
              <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
            </configuration>
          </execution>
        </executions>
      </plugin>

엔티티를 기반으로 Q 가 붙는 클래스들을 자동 생성해준다.

빌드를 해보면 target/generated-sources/java 여기에 Q클래스들이 생겨난걸 볼 수 있다.

 

- querydsl-jpa : QueryDSL JPA 라이브러리

- querydsl-apt : 쿼리 타입(Q)을 생성할 때 필요한 라이브러리

 

 

 

Repository 구조

public interface UserRepository extends JpaRepository<Users, Long>, UserRepositoryCustom {
}

public interface UserRepositoryCustom {
  List<Users> findByOrderByUser(Long userId, UserSearch userSearch);
}

 

public class UserRepositoryImpl extends QuerydslRepositorySupport implements
  UserRepositoryCustom {

  private JPAQueryFactory queryFactory;
	// 1.
  public UserRepositoryImpl() {
    super(Users.class);
  }
	// 2.
  @Override
  public void setEntityManager(EntityManager entityManager) {
    super.setEntityManager(entityManager);
    queryFactory = new JPAQueryFactory(entityManager);
  }

 

1. QuerydslRepositorySupport를 상속하게되면 더 이상 QueryDsl을 사용할 수 없습니다.

단, 생성자에서 super(Entity.class)를 호출하면 가능 하다.

 

- QuerydslRepositorySupport 클래스에는 기본생성자가 없음.

 

2.

QuerydslRepositorySupport 를 사용하면 구현체의 JPQLQuery 를 사용해서 쿼리를 진행해야 하기 때문에 from 으로 시작해야 한다. 그래서 queryFactory (일반적으로 사용하는 select 로 시작하기 위해 )를 이용하기 위해 

EntityManager 를 상위 클래스에 전달하여 JPAQuery에서 제공해주는 (select,selectFrom 등등 ..) 을 구현할 수 있다.

 

-> 성능 차이는 없지만 일반적으로 사용하는 SQL로 구현해서 코드 가독성을 높이는 것 또한 이득이라고 생각한다!

 

 

Projection 의 대한 고찰 ...

 

쿼리를 사용하여 하나의 필드를 조회 하는 것은 쉽다.

List<String> result = queryFactory
		.select(users.name)
		.from(users)
		.fetch();

하지만 보통 여러 리턴값이 필요한데 아래와 같이 작성한다면 Tuple 로 반환된다.

우리는 결과 값을 객체로 만들어 사용해야 하기 때문에 DTO 로 만들어 쓰는 방법에 대해 알아보고자 한다!

List<Tuple> result = queryFactory
		.select(users.name,user.age)
		.from(users)
		.fetch();

 

Projections 을 사용하면 된다.

1. constructor

생성자 기반 생성

-> 불변 객체 이지만 dto 생성자의 파라미터 순서와 동일해야 한다.(필드가 많을수록 실수 위험이 있다.)

-> 이름을 맞춰주지 않아도 해당자리에 들어가는 값을 넣어준다

List<UserInfoDto> result = queryFactory
	.select(
        Projections.constructor(UserInfoDto.class,
        users.name,
        user.age
        ))
	.from(users)
	.fetch();

2. bean

DTO에 있는 setter 메서드(@Setter) 기반 생성

-> DTO가 불변 객체가 아니게 되기 때문에 지양하는 방법

List<UserInfoDto> result = queryFactory
	.select(
        Projections.bean(UserInfoDto.class,
        users.name.as("userName"),
        user.age.as("userAge")
        ))
	.from(users)
	.fetch();

3. Fields

필드에 직접 접근해서 값을 채워준다.

-> 필드에 직접 접근하기 때문에 이름이 틀리면 안된다

-> DB 컬럼 이름과 DTO 필드 이름이 다를 경우 .as 로 변경하여 넣어주면 된다

List<UserInfoDto> result = queryFactory
	.select(
        Projections.fields(UserInfoDto.class,
        users.name.as("userName"),
        user.age.as("userAge")
        ))
	.from(users)
	.fetch();

4. @QueryProjection

DTO 에 대한 Q class 기반 생성

-> DTO 생성자에 @QueryProjection 어노테이션을 선언하고 querydsl 를 컴파일 하면 QUserInfoDto.class 처럼 Q 클래스가 생성된다.

-> Q 클래스 생성을 미리 해야 한다.

-> DTO 가 querydsl 에 의존한다는 단점이 있다.

List<UserInfoDto> result = queryFactory
	.select(
        new QUserInfoDto(
        users.name.as("userName"),
        user.age.as("userAge")
        ))
	.from(users)
	.fetch();

 

나는 필드를 주로 사용할것 같다. 

1. 생성자 - 실무에서는 절때 사용 못할것 같다 dto 필드가 10개 이상 일 때가 많다

2. setter -  불변성 객체가 아닐때 불안하다

3. QueryProjection - Q클래스가 추가된다는게 맘에 안들고 querydsl 에 의존이 강해지기 때문에 유지보수에서 문제가 발생할 수 있을 것 같다.

 

 

동적쿼리 (BooleanBuilder)

검색 등에서 사용될 수 있도록 쿼리문에 작성되는 조건들을 nullable 하게 넣어줄 수 있게 해준다.

 

1. 유저를 검색할 때 이름이나 나이로 검색하고 싶다

2. 이름필드로 값을 받은 경우 builder.and(users.name.eq(name)) 쿼리가 작동한다.

    BooleanBuilder builder = new BooleanBuilder();
    
    if (name != null) {
      builder.and(users.name.eq(name));
    }
    if (age != null) {
      builder.and(users.age.eq(age));
    }
    
    return jpaQueryFactory
            .selectFrom(users)
            .where(builder)
            .fetch();

 

실무에서는 좀더 가독성을 좋게 하기 위해 아래와 같이 씁니다

return jpaQueryFactory
            .selectFrom(users)
            .where(eqName(name), eqAge(age))
            .fetch();
  }
 
  private BooleanExpression eqName(String name) {
    return name != null ? users.name.eq(name) : null;
  }
 
  private BooleanExpression eqAge(int age) {
    return age == null ? users.age.eq(age) : null;
  }

 

ExpressionUtils

http://querydsl.com/static/querydsl/4.4.0/apidocs/com/querydsl/core/types/ExpressionUtils.html

ExpressionUtils (Querydsl 4.4.0 API)

공식 문서에 보면 어떤 메서드가 있는지 확인할 수 있다!

회사에서 레거시 프로젝트 수정하는 것을 봤는데 ExpressionUtils 로 Subquery 를 구현하는걸 보고 정리합니다!

현재 프로젝트에서는 엔티티로 구성되어있기 때문에 서브쿼리가 필요한 일은 거의 없었다!

 

return jpaQueryFactory
            .select(Projections.fields(
            ExpressionUtils.as(getUserCount(UserStatus.탈퇴회원),"usersCount"))
            .from(users).fetchCount());
            
            


private JPQLQuery<Long> getUserCount(UserStatus status){
	return	select(users.id.count())
		.from(users)
		.where(status == null ? null : eqUserStatus(status))
}

private Predicate eqUserStatus(UserStatus status){
	return users.status.eq(status);
}

 

여기서 as 로 알리아스를 해주는데 파라미터로 받는 Expression 은 아래와 같은 타입을 받을 수 있다. 그래서 JPQLQuery 를 만들어서 파라미터로 대입 해주었다!

Predicate 는 자바코드로 조건문을 표현(where 절)할 수 있게 해주어서 조건문들을 따로 관리할 수 있도록 해줍니다~! 

 

 http://querydsl.com/static/querydsl/4.4.0/apidocs/com/querydsl/core/types/Expression.html

Expression (Querydsl 4.4.0 API)

 

 

 

 

정렬 타입에 따른 정렬 처리

 

private OrderSpecifier getOrderBy(Order sortType) {
  switch (sortType) {
    case 최근가입:
      return new OrderSpecifier(Order.DESC, user.createAt);
    case 높은연령순:
      return new OrderSpecifier(Order.ASC, user.age);
    case 회원상태:
      return new OrderSpecifier(Order.ASC, user.status);
    default:
      return new OrderSpecifier(Order.ASC, user.createAt);
  }
}

 

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//

package com.querydsl.core.types;

public enum Order {
  ASC,
  DESC;

  private Order() {
  }
}