[21] Spring - 복잡한 쿼리 QueryDSL로 바꾸기

📁️- github 참고

https://github.com/kuk1157/spring-plus/commit/bc94468b00c609b9e8b2abeefcb6563077cae77a

feat: 레벨 3-10 복잡한 쿼리 QueryDSL 적용 · kuk1157/spring-plus@bc94468

 

 

📓 - 전체흐름

 

요구사항)

- 제목, 담당자의 닉네임, 시작&종료일(생성일기준) 검색 가능하도록

- 제목과 담당자의 닉네임은 부분적으로 일치해도 검색되도록

- 일정의 제목, 담당자의 수, 댓글의 수를 조회 / 검색 결과는 페이징 처리되도록 반환

 

1) API한개 새로생성

2) 제목, 닉네임, 시작&종료일 @RequestParam으로 넘기기
3) 검색 설정과 관련된 샘플 쿼리문 작성해서 조회(정상적으로 검색되는거 확인완료)
4) 이미 만들어둔 TodoRepositoryCustom과 TodoRepositoryImpl에서 미리작성한 쿼리문을 QueryDSL로 바꿀 쿼리메서드를 세팅한다.
5) QueryDSL에서 Projections 기능을 사용해야 하기 때문에 필요한 값만 반환시킬 DTO를 따로만든다
6) DTO에서 요구사항에 맞게 제목,담당자수,댓글수만 반환시킨다(id 고유번호만 추가로 담았다.)
7) 반환타입을 controller, service, custom, impl에 전부 dto로 변경해준다.
8) TodoRepositoryImpl에서 샘플쿼리문을 QueryDSL로 변경해준다.

9) QueryDSL변경 완료 후 Postman 테스트 하기

 

 

🛠️ - QueryDSL 적용

 

QueryDSL로 바꿀 쿼리)

- 일정테이블에서 댓글,담당자테이블과 join해서 담당자수와 댓글수를 조회하는 쿼리문이다.

- WHERE, AND절은 요구사항에 검색기능으로 들어가는 부분들이다

※ (일정제목, 담당자의 닉네임, 일정생성일 시작&종료일로 검색)

- GROUP BY 1,2는 각 데이터마다 담당자수와, 댓글 수를 추출하기 위해 COUNT()을 사용하지않는 컬럼들을 GROUP BY

- 생성일로 내림차순하여 정렬해준다.

- COUNT, JOIN, LIKE, 서브쿼리, BETWEEN, GROUP BY 수 많은 함수와 조건이 들어가고 모두 QueryDSL로 변경해야한다.

 

 

1. controller - TodoController

- 페이징 처리를 해야하기 때문에 Page 인터페이스를 사용해준다.

- TodoSearch DTO를 반환타입으로 해서 메서드를 생성한다.

- 검색 항목 4개(제목,닉네임, 시작일, 종료일) @RequestParam으로 값을 담아준다.

 

2. DTO - TodoSearch

- 조회했을때 필요한 정보들만 담은 DTO파일이다.

- 일정 고유번호는 요구사항에는 없었지만 데이터 확인용으로 임의로 추가하였다.

 

3. custom - TodoRepositoryCustom

- findTodoWithCommentAndManagerCounts로 쿼리메서드를 만들고, 필요한 매개변수를 다 담아준다.

- TodoSearch DTO를 반환타입으로 둔다.

 

4. Impl - TodoRepositoryImpl

- 코드가 길어서 캡쳐본 2개

- 전체 코드 확인

 

 

 

- 쿼리문에서 사용할 Q클래스 객체 세팅 서브쿼리 및 한 쿼리에서 총 4개의 테이블을 참조해야함

- 위에서부터 순서대로 일정, 댓글, 담당자, 유저 4개 객체를 세팅

- String으로 받은 start,end(시작&종료일)를 데이터베이스에 타입과 동일하게 맞추는코드

 

- 위에서 직접 작성했던 쿼리문을 QueryDSL로 변경한것이다.

1) JPAQuery 실제쿼리의 실행을 담당 / queryFactory는 QueryDSL 처음 사용할때 세팅하는 config이다.

참고 - https://kuk1938.tistory.com/213

[18] Spring - QueryDSL 사용방법

 

2) Projections를 활용하면 별도의 DTO파일을 받아서 처리할 수 있다.

 

3) Projections.constructor을 사용하여 TodoSearch 클래스 파일의 생성자와 조회하려는 컬럼들을 매핑하는 것이다.

-  TodoSearch에서 고유번호,제목,댓글수,담당자수와 일치하게 4개를 매핑하는것을 볼 수 있다.

- 담당자수와 댓글수는 위에서 생성한 객체를 참조해서 해당 객체의 id(고유번호)로 COUNT() 하고 있다.

- 샘플쿼리문과 동일하다는 뜻이다.

 

4) from()에서는 조회할 테이블명(엔티티)을 입력하여 조회해준다.

 

5) lefJoin을 활용하여 참조할 테이블(엔티티)을 정하고 on()으로 이어줄 컬럼을 세팅한다.

- comment 테이블을 참조, comment의 todo_id와 todo테이블의 id(고유번호)를 이어준다는 뜻이다.(댓글&일정)

- manager 테이블을 참조, manager의 todo_id와 todo테이블의 id(고유번호)를 이어준다는 뜻이다.(담당자&일정)

 

6) where()은 검색해야할 모든 항목을 넣어준다.

- 일정의 제목을 like검색해야하기 때문에 todo.title.contains(title)을 사용하여 매개변수(title)와 부분일치하는지 확인.

 

7) and() 담당자의 닉네임을 조회해야하기때문에 서브쿼리가 필요하다.

- todo테이블의 user_id를 user테이블의 id(고유번호)를 nickname와 부분일치하는 id를 구해서 서로 같은지 비교

- todo.user.id.eq( JPAExpressions.select(user.id) 서브쿼리를 사용해 user_id를 확인한다는 뜻

- from(user) .where(user.nickName.contains(nickName)) user테이블의 닉네임을 like문으로 검색해서 부분일치 확인

 

8) 생성일 기준으로 시작일&종료일 BETWEEN 검색

- and(todo.createdAt.between(startDateTime, endDateTime))

- 위에서 날짜 형식으로 변경한 startDateTime, endDateTime를 활용

 

9) 일정 각 데이터마다 담당자 수와 댓글 수를 집계해서 보여주기 위해 GROUP BY 진행

-  groupBy(todo.id, todo.title) id(일정 고유번호)와 titile(일정 제목)을 기준으로 그룹화

 

10) 생성일 기준으로 내림차순 - 가장 최근에 생성된 Todo가 먼저 조회되도록

- orderBy(todo.createdAt.desc())

 

 

1) fetchCount() - 쿼리에서 전체 건수를 구해온다.(페이징에 활용)
2) offset(pageable.getOffset()) - 현재 페이지에서 시작할 항목의 위치

3) limit(pageable.getPageSize())  - 한 페이지에 표시할 항목의 수

4) fetch() - 쿼리를 실행하여 결과를 반환

 

5) return new PageImpl<>(results, pageable, total)

- PageImpl은 Page인터페이스를 구현하는 클래스, 결과 리스트와 페이징 정보를 반환할 수 있음.

- results : fetch() 메서드에서 가져온 현재 페이지의 TodoSearch 목록

- pageable: 클라이언트로부터 전달받은 페이징 정보입니다.

- total: 전체 데이터 수입니다.

 

5. Service - TodoService

- Controller에서 생성한 그대로 매개변수를 받고, 페이징을 Pageable 객체를 최상단에 먼저 세팅한다.

- 각 검색값에 대한 예외처리를 진행해뒀다. 각 검색에 대한 1개,2개,3개 모든 경우의 수를 다 잡고싶지만 여러 쿼리 메소드와 더 많은 if문이 생겨야해서 일단 null에 대한 예외처리만 진행했다.

https://kuk1938.tistory.com/208

[15] Spring - JPA-Plus 과제 필수레벨_1

※ 해당 글 마지막에 JPQL과 같이 하려면 쿼리메소드가 여러개 나와야한다.

 

- TodoRepositoryCustom, TodoRepositoryImpl에서 세팅한 쿼리메소드를 활용하여 TodoSearch DTO에서 최종으로 조회해야할 값을 반환시켜준다.

 

 

 

🧪 - 최종 테스트

 

 

 

- 쿼리가 워낙 복잡해서 2개가 한쿼리