[Spring] Spring Boot에 QueryDSL 도입기

 일반적으로 Spring Boot 환경에서 데이터를 가져오는 데, Spring Data JPA가 제공하는 기본 CRUD  메소드와 Named Query 메소드를 사용하게 된다. 그리고 안되는 경우는 JPQL이나 Native Query로 작성하게 된다. 하지만 복잡한 쿼리 로직을 가진 경우에는 메소드나 쿼리문이 길어져서 가독성이 떨어지게 된다. 특히 Paging이나 Sorting을 구현하게 될 경우, 구현이 복잡해지게 된다.

 

 

 

 

 

🚨 문제 상황

 나의 경우에도 이전 프로젝트까지 Spring Data JPA가 기본적으로 제공하는 CRUD 메소드와 Named Query로 데이터를 가져오는 로직을 구현했었고, 조금 더 복잡한 쿼리의 경우에는 가독성은 조금은 떨어지지만 Native Query로 별 문제없이 구현을 했었다. 하지만 최근 프로젝트에서 검색 조건이 많고, Paging도 하고, Sorting도 하고, 총 검색 결과 개수까지 반환해야 하는 메소드를 구현해야 했었다.

 

 

 초기 구현에서는 Paging과 Counting이 없어서, 가독성이 안 좋았어도 named Query로 Sorting을 구현했었다. 하지만 Paging과 Counting이 추가되면서 JpaRepository에서의 메소드도 복잡해지기 시작했으며, 그 쿼리 메소드를 사용하는 Service 단의 로직도 복잡해지기 시작했다. 어찌어찌 구현은 할 수 있겠지만, 로직이 복잡하고 코드가 길어 비효율적이고 감당할 수 없게 되었다. QueryDSL을 처음 도입해보는 것이고, 특히 Page 객체도 따로 있어서 어려워보였지만.. 더 돌아올 수 없는 강을 건너기 전에 QueryDSL로 전환하기로 했다. 덕분에 QueryDSL의 필요성과 중요성을 느끼게 된 것 같다!

 

 

 

 

 

QueryDSL 도입 전 (+ Paging, Counting 구현 전)

Repository 

정렬은 구현된 페이징 도입 전 코드이다.

public interface TicketRepository extends JpaRepository<Ticket, Long> {
	//priceRow
    List<Ticket> findByDepCodeAndArrCodeAndDepDateAndPriceBetweenOrderByPriceAsc(String departure, String destination, String date, int minPrice, int maxPrice);

	//depTimeEarly
    List<Ticket> findByDepCodeAndArrCodeAndDepDateAndPriceBetweenOrderByDepTimeAsc(String departure, String destination, String date, int minPrice, int maxPrice);

	//depTimeLate
    List<Ticket> findByDepCodeAndArrCodeAndDepDateAndPriceBetweenOrderByDepTimeDesc(String departure, String destination, String date, int minPrice, int maxPrice);

	//flightTimeRow
    List<Ticket> findByDepCodeAndArrCodeAndDepDateAndPriceBetweenOrderByTotalTimeNumAsc(String departure, String destination, String date, int minPrice, int maxPrice);
}

 

각 정렬 조건 별로 Named Query를 사용하여 메소드들을 작성을 했는데 굉장히 길고 가독성이 좋지 않다..

 

 

Service

Switch Case 문으로 정렬 조건에 따라 구현된 Repository 메소드를 호출했다.

@Service
public class TicketServiceImpl implements TicketService {
    @Autowired
    TicketRepository ticketRepository;

    @Override
    public List<TicketRes> getTicketList(OneWayTicketReq ticketReq) {
       ...

        //검색
        if(direct[0]) { //경유 필터 : 전체
            switch (sortType) {
                case "priceRow" : {
                    ticketList = ticketRepository.findByDepCodeAndArrCodeAndDepDateAndPriceBetweenOrderByPriceAsc(departure, destination, date, minPrice, maxPrice);
                    break;
                }
                case "gapHigh" : {
                	//당시 구현중
                    break;
                }
                case "depTimeEarly" : {
                    ticketList = ticketRepository.findByDepCodeAndArrCodeAndDepDateAndPriceBetweenOrderByDepTimeAsc(departure, destination, date, minPrice, maxPrice);
                    break;
                }
                case "depTimeLate" : {
                    ticketList = ticketRepository.findByDepCodeAndArrCodeAndDepDateAndPriceBetweenOrderByDepTimeDesc(departure, destination, date, minPrice, maxPrice);
                    break;
                }
                case "flightTimeRow" : {
                    ticketList = ticketRepository.findByDepCodeAndArrCodeAndDepDateAndPriceBetweenOrderByTotalTimeNumAsc(departure, destination, date, minPrice, maxPrice);
                    break;
                }
            }
        } else {
            ...
        }

        //결과값 반환
        ...

        return result;
    }

}

 

 

 

 

🔧 설정하기

Gradle

 

Spring Data JPA의 경우, Gradle에 한 줄만 추가하면 된다.

dependencies {
    ...
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	...
}

 

 

QueryDSL을 추가한다면 초기 설정이 복잡하다.

buildscript {
    ext {
        queryDslVersion = "5.0.0"
    }
}

plugins {
    ...
    id "com.ewerk.gradle.plugins.querydsl" version "1.0.10"
}

...

dependencies {
    implementation "com.querydsl:querydsl-jpa:${queryDslVersion}"
    annotationProcessor "com.querydsl:querydsl-apt:${queryDslVersion}"
    ...
}

def querydslDir = "$buildDir/generated/querydsl"
querydsl {
    jpa = true
    querydslSourcesDir = querydslDir
}
sourceSets {
    main.java.srcDir querydslDir
}
configurations {
    querydsl.extendsFrom compileClasspath
}
compileQuerydsl {
    options.annotationProcessorPath = configurations.querydsl
}

...

 

 

 

 

 

QClass 생성하기

Gradle > other > compileQuerydsl 클릭한다.

 

그러면 프로젝트의 build > generated > querydsl 폴더가 생기고, Entity의 QClass가 생성된 것을 확인할 수 있다.

 

 

 

 

 

Repository

public interface TicketRepository extends JpaRepository<Ticket, Long>, TicketRepositoryCustom {
}

 

기존에 JPA를 사용했다면 Repository interface가 있을 것이다. 여기에 기본 Crud와 named Query를 위한 JpaRepository뿐만 아니라, 직접 만든 RepositoryCustom을 상속받는다.

 

 

 

 

 

RepositoryCustom

public interface TicketRepositoryCustom {
    Page<Ticket> findAllTickets(Pageable pageable, String departure, String destination, String date, int minPrice, int maxPrice);
}

 

QueryDSL로 구현할 메소드를 작성해준다.

 

 

 

 

 

RepositoryCustomImpl

 

오버라이딩한 메소드 안에 QueryDSL을 작성해준다.

public class TicketRepositoryImpl implements TicketRepositoryCustom {

    private final JPAQueryFactory queryFactory;

    public TicketRepositoryImpl(EntityManager em){
        this.queryFactory = new JPAQueryFactory(em);
    }

    @Override
    public Page<Ticket> findAllTickets(Pageable pageable, String departure, String destination, String date, int minPrice, int maxPrice) {
        JPAQuery<Ticket> query  = queryFactory
                .selectFrom(ticket)
                .leftJoin(ticket.flightList, flight)
                .leftJoin(ticket.tendency, tendency)
                .where(ticket.depCode.eq(departure),
                        ticket.arrCode.eq(destination),
                        ticket.depDate.eq(date),
                        ticket.price.between(minPrice, maxPrice)
                )
                .distinct();

        sortAndOrder(query, pageable);

        List<Ticket> ticketList = query
                .offset(pageable.getOffset())
                .limit(pageable.getPageSize())
                .fetch();

        Long totalCount =  queryFactory
                .select(ticket.countDistinct())
                .from(ticket)
                .leftJoin(ticket.flightList, flight)
                .leftJoin(ticket.tendency, tendency)
                .where(ticket.depCode.eq(departure),
                        ticket.arrCode.eq(destination),
                        ticket.depDate.eq(date),
                        ticket.price.between(minPrice, maxPrice)
                )
                .fetchOne();

        return new PageImpl<>(ticketList, pageable, totalCount);
    }
    
    private void sortAndOrder(JPAQuery<Ticket> query, Pageable pageable) {
        for (Sort.Order o : pageable.getSort()) {
            if(o.getProperty().equals("updown")) {
                PathBuilder pathBuilder = new PathBuilder(tendency.getType(), tendency.getMetadata());
                query.orderBy(new OrderSpecifier(o.isAscending() ? Order.ASC : Order.DESC,
                        pathBuilder.get(o.getProperty())), new OrderSpecifier(Order.ASC,
                        ticket.depTime), new OrderSpecifier(Order.ASC,
                        ticket.arrTime));
            } else {
                PathBuilder pathBuilder = new PathBuilder(ticket.getType(), ticket.getMetadata());
                query.orderBy(new OrderSpecifier(o.isAscending() ? Order.ASC : Order.DESC,
                        pathBuilder.get(o.getProperty())), new OrderSpecifier(Order.ASC,
                        ticket.depTime));
            }
        }
    }
    
}

 

 

 

 

 

 

🔎 QueryDSL 메소드

• select(ticket) : ticket의 모든 칼럼을 조회한다.
• from(ticket) : ticket 테이블에서 가져온다.
• selectFrom() : select와 from을 합친 메소드다.
• join(), leftJoin() : 그냥 join시 innerJoin이 되고, outer join을 하고 싶다면 left, right를 붙여줘야 한다.
• where() : 조건을 넣는다
  • eq()
  • between(a, b)
• distict() : 중복되는 칼럼을 제거한다.
• fetch() : query를 생성해 결과를 반환한다.

페이징

• offset() : 얻고자 하는 결과의 페이지 번호
• limit() : 총 페이지 수

정렬

• orderBy() : 원하는 조건에 따라 정렬한다.

 

 

 

 

 

 

 

 

 

📌 결과

 QueryDSL 구현을 위해 설정해야 할 것들이 많고, QueryDSL의 메소드들도 익혀야해서 진입장벽이 좀 있었다.

 

 하지만 Repository에서 각종 named Query로 넘처났던 코드와 Service 단에서 Switch 문으로 넘처나던 코드가 줄어들어 효율적이게 되고, 가독성도 좋아지게 되었다!

 

그리고 다른 장점으로는 쿼리 오류를 컴파일 타임에 잡아낼 수 있다는 것이다. 

 

 

Repository

public interface TicketRepository extends JpaRepository<Ticket, Long>, TicketRepositoryCustom {
}

 

Service

@Service
public class TicketServiceImpl implements TicketService {
    @Autowired
    TicketRepository ticketRepository;

    @Autowired
    MemberRepository memberRepository;

    @Autowired
    OnewayTicketLikeRepository onewayTicketLikeRepository;

    @Autowired
    RoundTicketLikeRepository roundTicketLikeRepository;

    @Override
    public OnewayTicketListRes getOneWayTicketList(OnewayTicketReq ticketReq) {
        ...

        PageRequest pageRequest = PageRequest.of(page, 10, Sort.Direction.fromString(orderBy), sortType);

        //검색
        long totalCount = 0;

        List<Ticket> ticketList = new ArrayList<>();

        if(direct[0]) { //경유 필터 : 전체
            Page<Ticket> result = ticketRepository.findAllTickets(pageRequest, departure, destination, date, minPrice, maxPrice);
            ticketList = result.getContent();
            totalCount += result.getTotalElements();
        }else {
        	...
        }

        //결과값 반환
        ...

        return onewayTicketListRes;
    }
    
}

 

 

 

 

 

 

 

 

 

 

 

📖 참고 자료

https://velog.io/@jkijki12/Spring-QueryDSL-%EC%99%84%EB%B2%BD-%EC%9D%B4%ED%95%B4%ED%95%98%EA%B8%B0

[Spring] QueryDSL 완벽 이해하기

 

https://ksabs.tistory.com/186

[ClassFlix] EP 17. QueryDSL 도입 (페이징, 정렬)