5) Paging Query

이전 프로젝트를 만들었을 때, Querydsl 사용하는 부분 코드가 아쉬었었다.
그래서 이번에 페이징 쿼리를 수정하면서 다시 복습하고자 한다.

고치고 싶었던 것

• 컨트롤러 부분에서 카테고리별로 페이징처리하는 부분
•  페이징 필터 수정

카테고리별로 상품 페이징하는 부분에서 아쉬운점이 있다.

 

이전 프로젝트에서 카테고리 구현을 하고자, 컨트롤러에서 아래 경로 매핑 2개를 작성했었다.

/category/BOOK
/category/MUSIC

{code} 방식으로 받는 방법을 몰라서, 반복되는 코드를 적고 code를 문자열로 고정시켜 페이지 구현을 했었다.
하지만, queryDSL 쿼리를 작성하여 좀 더 코드개선을 할 수 있었다.

 

또한 페이징 필터를 "낮은가격순" "높은가격순"으로 고쳤다.
이전에 "이름순" "최신등록순" 필터를 만들었는데 가격순으로 수정하려고 한다.

 

이번 포스팅에서는 아래 사항에 대해 정리하고자 한다.

• Querydsl을 Spring Boot Data Jpa에서 Querydsl을 어떻게 설정하는지?
• Querydsl 작성
• 리팩토링

그럼 이제 시작해보겠습니다.

 

Querydsl

querydsl을 통하여 생성되는 정적 Q-type 클래스를 이용하여 SQL과 같은 쿼리를 생성하도록 도와주는 프레임워크이다.
JPA뿐만 아니라 MongoDB, JDO, Lucene과 같은 라이브러리도 제공하고 있다.
앞에서 말했던 JPQL의 단점을 완벽하게 커버할 수 있는 Querydsl은 타입에 안전한 방식으로 쿼리를 실행할 수 있다.

타입을 통하여 쿼리를 작성하므로 도메인 모델의 프로퍼티 변경에 유연하게 대처 가능하다.

Spring Data Jpa Custom Repository 적용

Spring Data Jpa에서는 Custom Repository를 JpaRepository 상속 클래스에서 사용할 수 있도록 기능을 지원한다.
전체적인 그림은 아래와 같다.

위와 같이 구성하면 ItemRepository에서 ItemRepositoryCustomImpl의 코드도 사용할 수 있다.

일종의 공식으로, custom이 붙은 인터페이스를 상속한 Impl 클래스의 코드는 Custom 인터페이스를 상속한 JpaRepository에서도 사용할 수 있다. Custom과 Impl만 외워도 된다.

 

먼저 ItemRepository와 같은 위치에

ItemRepositoryCustom(인터페이스), ItemRepositoryCustomImpl(구현체) 클래스를 생성한다.

코드는 아래와 같다.

ItemRepository 코드

ItemRepositoryCustom 코드

ItemRepositoryCustomImpl 코드

 

• Page searchByItemName(ItemSearchCondition condition, Pageable pageable) : 상품 이름으로 검색 페이징
• Page sortByCategoryType(String code, Pageable pageable) : 카테고리 타입별 페이징
• Page searchByItemNameAndCategoryType(ItemSearchCondition condition, String code, Pageable pageable) : 카테고리별 상품 이름검색 페이징
• Page sortByItemPriceASC(Pageable pageable) : 높은 가격순 페이징
• Page sortByItemPriceDESC(Pageable pageable): 낮은 가격순 페이징
• List sortByUser() : 유저별 등록한 상품 리스트 반환

Querydsl 작성

1. 의존성 추가

 

 

2. Q-type클래스

Gradle IntelliJ 사용법

• Gradle ➔ Tasks ➔ build ➔ clean
• Gradle ➔ Tasks ➔ other ➔ compileQuerydsl

Q 타입 생성 확인

• build ➔ generated ➔ querydsl

 

 

3. join 쿼리

• .join() 사용 가능하다.
• 연관관계가 있는 엔티티 Item, ItemImg를 join()해서 하나의 상품 객체를 만들었다.

 

 

4. 페이징 쿼리

페이징 쿼리 또한 JPQL과 매우 유사하다.
Querydsl의 이전 버전에서는 fetchResults(), fetchCount() 메소드를 이용하여 페이징 쿼리를 작성했었다.

 

그러나 5.0.0 버전 이후 deprecated 되었다.

count 쿼리가 모든 dialect에서 또는 다중 그룹 쿼리에서 완벽하게 지원되지 않았기 때문에 deprecated되었다.

이제 fetchCount() 대신 fetch.size()로 동일한 결과를 얻을 수 있다.

 

 

 

 

5. Dto로 Projection 하기

• 조회용 DTO를 추가한다.
• Q-type Dto 생성한다.

자주 사용되는 특정 쿼리의 결과는 Dto로 따로 분리하여 가져올 때가 많다.

프로젝션과 결과 반환하기 위해 @QueryProjection을 사용한다.

 

메인 페이지에 띄울 상품정보만 보여주기 위해 MainItemDto를 만들었다.

간략하게 화면에 보여주고 싶은 정보만 MainItemDto에 담아 페이징처리했다.

 

 

 

6. 동적쿼리 성능 최적화 조회

where절 파라미터를 사용한다.

 

 

7. 스프링 데이터 페이징 활용

• Querydsl 페이징 연동 :스프링 데이터의 Page, Pageable을 활용한다.
• CountQuery 최적화 :PageableExecutionUtils.getPage()로 최적화한다.

 

8. 정렬

• desc() : 내림차순
• asc() : 올림차순
• sortByItemPriceASC() 로직에, asc()를 사용하여 낮은가격순 페이징처리를 했다.

 

 

 

 

9. BooleanExpression을 활용한 리팩토링

BooleanExpression을 사용하면 QueryDSL Repository의 표현을 좀더 직관적으로 볼 수 있도록 리팩토링할 수 있다.

• itemNameContains(), categoryTypeContains() 메서드를 생성하여 BooleanExpression 타입을 리턴하도록 한다.
• BooleanExpression을 리턴하는데, 각 메소드에서 조건이 맞지 않으면 null을 리턴한다.
• null을 리턴하니 where에서는 상황에 따라 조건문을 생성하게 된다.

 

예시로, 아래 코드처럼 작성하였다.

전체코드는 링크를 참고해주세요. ItemRepositoryCustomImpl 전체코드

이 코드가 정상적으로 작동하는지 테스트를 해보자.
위와 같이 기본 repository로 조회하여 확인하면 된다. 테스트 코드 첨부

 

만든 QueryDSL Repository를 사용하여 다음과 같이 컨트롤러에서 사용할 수 있게 되었다.

 

 

 

카테고리 컨트롤러

• @PathVariable 어노테이션을 이용해서 {카테고리 코드} 파라미터를 받는다.
• Page results, PageDto pageDto를 변수로 선언하고, if() 조건문으로 상품 검색 여부를 판단한다.
• 상품 검색 하지 않을 때, "책" "음반" 중에서 선택한 카테고리로 페이징 처리를 한다.
• 상품 검색을 하는 경우에는, 해당 카테고리 안에서 상품 이름 검색을 할 수 있도록 페이징 처리를 한다.

http://localhost:8080/bookstore/category/MUSIC?itemName=BAEK+HYUN 를 요청했을 때 화면은 아래와 같다.

 

 

 

메인홈 컨트롤러

• @RequestParam(required = false, name = "code") String code 파라미터로 "높은/낮은 가격순" 필터 정보를 받는다.
• "required=false" 이므로 파라미터를 받지 않는 경우는 검색정렬페이징 처리한다.
• 높은 가격순 요청경우:http://localhost:8080/bookstore/home?code=DESC
• 낮은 가격순 요청경우: http://localhost:8080/bookstore/home?code=ASC

http://localhost:8080/bookstore/home?itemName=Anne+를 요청했을 때 화면은 아래와 같다.

메인홈 페이지에서 상품 이름 "Anne"를 검색하면 화면과 같이 조횐된다.

다음에는 "높은가격" 선택한 상태인 경우 "Anne" 이름을 검색했을 때는 높은 가격순으로 페이징처리 되도록 해봐야겠다.

페이징 처리를 위한 클래스 설계

PageDto 코드

생성자를 정의하고 전체 데이터 수(total), 카테고리 타입(sortParam), Pageable를 파라미터로 지정한다.

• 컨트롤러에서 PageDto를 사용할 수 있도록 Model에 담아서 화면에 전달해 준다.
• sortParam으로 "카테고리타입" "가격순 필터조건" 을 받아 페이징을 구현했다.
• sortParam이 없는 생성자는 상품검색 페이징을 위해 만들었다.

html 파일

th:href="@{/bookstore/home?code={code}&page={page}&itemName={name}(page = ${page.getCurPage()-1}, code=${page.sortParam}, name=${condition.itemName})}" 

참고자료

fetchResults deprecated 관련하여 공식문서의 설명 링크와 대체 방법에 대한설명 글

 

후기

이제 명확하게 쿼리가 예측 가능하게 되었다.
다음에는 추가로 페이징 성능개선 참고글를 읽고 프로젝트 리팩토링을 했으면 좋겠다.