[Spring] JPQL을 이용한 검색

in Study on Spring, Web
[Spring] JPQL을 이용한 검색

JPQL을 이용해 검색 처리를 해봅시다.


board 프로젝트를 구성할 때 3개의 엔티티를 사용했습니다. board와 reply는 FK를 이용해 @ManyToOne과 같은 연관관계를 설정했습니다. guestbook과 달리 여러 엔티티 타입을 사용할 때 JPQL문을 이용한 검색은 조금 더 복잡해집니다. 여러 엔티티 타입을 JPQL로 처리한 결과물은 Object[] 타입, 즉 튜플로 나오기 때문에 복잡합니다. 복잡한만큼 어떤 상황에서도 사용할 수 있기 때문에 유용합니다.
현재 작성중인 board 프로젝트는 Querydsl 설정이 없는 상태이기 때문에 Querydsl의 설정을 다시 해주어야 합니다.


1. Querydsl 설정


1

Querydsl의 설정은 앞서 작성한 글인 동적 쿼리 처리를 위한 Querydsl 설정에서 확인할 수 있습니다.
실행 환경에 따라 여러 오류들이 생길 수 있으니 설정을 바꿔가며 수행합니다.

2. SearchBoardRepository 작성


2

QuerydslRepositorySupport를 이용해 검색 기능을 구현하고자 합니다. 이를 위해 repository 패키지 내에 search 패키지를 생성한 뒤 SearchBoardRepository 인터페이스를 작성합니다.
SearchBoardRepository에는 Board 타입 객체를 반환하는 메소드 하나를 선언합니다.

3. SearchBoardRepositoryImpl 작성


3

SearchBoardRepository 인터페이스의 구현 클래스 SearchBoardRepositoryImpl를 작성합니다.
SearchBoardRepositoryImpl은 QuerydslRepositorySupport를 상속해 작성합니다. QuerydslRepositorySupport는 생성자가 존재하기 때문에 super()를 이용해 호출합니다.
SearchBoardRepository에 작성한 search1()의 구현 역시 작성합니다. 동작이 제대로 되는지 여부를 확인하기 위해 우선 log.info를 사용해 작성합니다.

4. BoardRepository 수정


4

BoardRepository에 SearchBoardRepository를 상속하는 형태로 수정합니다.

5. BoardRepository - testSearch() 작성 및 결과


5

Repository의 확장이 정상적으로 처리된 것을 확인할 수 있습니다.

6. SearchBoardRepositoryImpl - search1() 구현


6

Querydsl 라이브러리 내에 JPQLQuery 인터페이스를 활용해 search1()을 작성합니다.
QBoard타입의 board와 JPQLQuery 객체를 생성하는 것을 확인할 수 있습니다.

7. BoardRepository - testSearch() 결과


7

search1()의 테스트 결과를 살펴보면 SQL문이 실행되고 있는 것을 확인할 수 있습니다.
선을 통해 구분해둔 부분에서 출력된 결과문을 살펴보면 JPQL의 문자열과 동일한 것과 실제 동작하는 SQL문을 확인할 수 있습니다.

8. SearchBoardRepositoryImpl - search1() join(reply) 추가


8

JPQLQuery를 통해 join을 처리할 때 join()과 on()을 사용합니다.
QReply타입의 reply를 추가한 뒤 leftJoin()과 on()을 사용합니다.

9. BoardRepository - testSearch() 결과


9

join을 추가한 search1()의 결과를 살펴보면 SQL문에 left outer join이 추가된 것을 알 수 있습니다.

10. SearchBoardRepositoryImpl - search1() join(member) 추가


10

QMember타입의 member를 추가한 뒤 한번 더 join합니다. 그 다음 groupBy()를 사용해 select()의 결과물에서 여러 객체를 가져오게 변경합니다.
정해진 엔티티 단위가 아닌 데이터를 추출한 형태로 가져왔고 이 때 Tuple이라는 객체를 사용해 데이터를 받아와야 합니다.

11. SearchBoardRepositoryImpl - search1() Tuple 사용


11

select()의 결과를 JPQLQuery<Tuple>을 이용해 처리하도록 변경하고 result 변수 역시 List<Tuple> 타입으로 변경했습니다.

12. BoardRepository - testSearch() 결과


12

testSearch의 실행 결과는 위의 그림과 같습니다.

13. SearchBoardRepository - searchPage() 선언


13

search1()의 실행 결과의 마지막 부분을 살펴 보면 Board 객체와 작성자 이메일, 댓글 개수가 출력됩니다. 이제 검색을 위한 조건들을 추가하고 Page<Object[]> 타입으로 만들어 반환하고자 합니다.
Page<Object[]> 타입으로 반환하는 searchPage()를 선언합니다. 매개변수로 type과 keyword, pageable을 사용합니다.

14. SearchBoardRepositoryImpl - searchPage() 구현


14

앞서 search1과 같이 단순한 실행을 테스트하기 위해 log만을 출력하도록 작성합니다.

15. BoardRepositoryTests - testSearchPage() 작성


15

BoardRepositoryTests에 searchPage()의 테스트를 위한 testSearchPage()를 위의 그림과 같이 작성한 후 실행합니다.

16. BoardRepositoryTests - testSearchPage() 결과


16

무사히 실행이 됨을 확인했습니다. 구현한 내용이 없기 때문에 로그만 출력합니다.

17. SearchBoardRepositoryImpl - searchPage() BooleanExpression 추가


17

이제 실제 검색을 위한 내용을 작성합니다.
search1()의 구현 내용을 가져온 뒤 BooleanBuilder와 BooleanExpression을 추가합니다. 검색 조건에 대한 내용은 앞서 guestbook에서 다룬 내용과 같습니다.

18. BoardRepositoryTests - testSearchPage() 결과


18

searchPage()의 내용을 구현한 뒤 테스트를 위해 testSearchPage()를 다시 실행합니다.
실행 결과 SQL문의 where절에 조건문이 생긴 것을 확인할 수 있습니다.

19. SearchBoardRepositoryImpl - searchPage() PageImpl 추가


19

검색 조건을 추가했기 때문에 결과값의 정렬을 위한 코드를 작성합니다.
JPQL에서는 Sort 객체를 지원하지 않기 때문에 orderBy()의 매개변수로 OrderSpecifier<T extends Comparable>을 사용합니다.
OrderSpecifier는 정렬이 필요합니다. Sord 객체의 정렬 정보를 com.querydsl.core.types.Order 타입으로 처리한 뒤 Sord 객체의 속성을 PathBuilder를 사용해 처리합니다. PathBuilder를 생성할 때 문자열로 된 이름은 JPQLQuery를 생성할 때 이용하는 변수명과 동일해야 합니다.
JPQLQuery는 기존에 사용하던 Sort의 방식보다 복잡하고 어렵지만 fetchCount()를 사용해 count 쿼리를 한번에 처리할 수 있는 장점이 있습니다.

20. BoardRepositoryTests - testSearchPage() 수정


20

searchPage()의 정렬 기능을 확인하기 위해 테스트 코드의 내용을 수정합니다.
고의적인 중첩 Sort 조건을 만들어 실행합니다.

21. BoardRepositoryTests - testSearchPage() 실행 결과


21

실행 결과를 살펴 보면 order by 조건과 List를 위한 SQL, count를 위한 SQL이 실행된 것을 알 수 있습니다.

22. BoardServiceImpl - getList() 수정


22

list.html과 Controller의 화면 처리는 동일하게 둔 채로 BoardServiceImpl의 getList()를 수정합니다.
기존의 코드에서 getBoardWithReplyCount()를 사용해 전체 글을 가져오는 것이 아닌 searchPage()를 사용해 검색 조건에 맞춰서 페이지를 가져오도록 수정합니다.

23. 검색 결과 확인


23

브라우저에서 type을 제목으로, keyword를 1로 검색한 결과 정상적으로 검색 결과물이 출력된 것을 확인할 수 있습니다.

© 2022. All rights reserved.