🔥 TIL - Day 48

페이징과 정렬을 지원하는 조회 API를 만들어보자.

📌 Controller 처리

페이징 처리를 위해 클라이언트로부터 받는 파라미터

• page: 요청 페이지 번호
• size: 한 페이지에서 보여줄 요소 수
• isAsc: 오름차순 or 내림차순
• sortBy: 정렬의 기준이 될 필드이름

ex)
/api?page=1&size=10&isAsc=true&sortBy=title
1페이지에서 10개를 제목기준 오름차순으로 주세요.

📌 Service 처리

페이징을 위해 Pageable 객체를 사용한다.
Pageable객체를 생성하는 static 메서드가 PageRequest에 있다. 이것을 사용한다.

• 페이징을 위해 Pageable 객체를 사용
• Pageable 객체를 생성하기 위해 PageRequest의 정적 of 메서드 사용

PageRequest 는

• 현재 페이지
• 페이지 당 요소 수
• 정렬 ( Sort )
  • 정렬방향 ( Sort.Direction )
  • 정렬기준 필드

를 파라미터로 받아 Pageable 객체를 생성한다.

현재 페이지와 페이지 당 요소 수는 Controller로부터 받은 page와 size를 그대로 사용하고 정렬부분만 처리하면 된다.

정렬의 경우 Sort 객체를 생성하면 된다.
Sort 객체에는 정렬방향, 정렬기준 필드가 포함된다.

정렬방향은 Sort 클래스 안에 있는 static enum 클래스인 Direction을 사용한다.

Sort.Direction direction = isAsc ? Sort.Direction.ASC : Sort.Direction.DESC;

정렬기준 필드에 대한 처리는 처음 알았다.
정직하게 필드의 이름을 그대로 Sting 타입으로 Sort에 넘겨주면 된다.

Sort의 생성하는 경우에도 팩토리 메서드를 제공한다. (by)
properties로 정렬기준 필드를 받는데 가변인자로 받는다. 만약 정렬기준이 두 개 이상이라도 잘 처리해 줄 것 같다.

Sort 객체생성

Sort sort = Sort.by(direction, "필드이름", ...);

Service 측 흐름정리

• 정렬 Sort.by(정렬방향, 정렬기준필드)
  • 정렬방향 (Sort.Direction)
• Pageable 생성
  • PageRequest.of(현재페이지, 페이지 당 요소수, 정렬)

📌 Repository 처리

조회조건이 있다면 그냥 네이밍쿼리 + 인자로 추가해주면 된다.

중요한 것은 Pageable을 파라미터로 받고 리턴타입을 컬렉력 대신 Page를 사용하는 것이다.

Page<엔티티_타입> findAll(Pageable pageable);

📌 클라이언트로 내려줄 값

클라이언트 측에서 페이징을 위해 가져야 할 값을 생각해보자.

• 페이징 된 조회결과
• 총 페이지 수 (버튼을 몇 개 배치해야 할 지)
• 현재 페이지 (현재 페이징 버튼 활성화 처리)
• 첫 페이지인지, 마지막 페이지인지 (boolean)

일단 이정도만 있으면 클라이언트 쪽에서도 페이징 처리가 가능할 것 같다.
JPA를 통해서 얻은 Page타입 객체를 그냥 클라이언트 쪽으로 리턴해보자.

• content: 페이징 된 조회결과
• totalPages: 총 페이지 수
• number: 현재 페이지
• first / last: 첫 페이지, 마지막 페이지

그냥 Page 타입 객체를 만들어서 내려줬는데 필요한 부분이 다 구성되어 있다..

Page 객체를 그대로 내려주는 것도 크게 상관은 없을 것 같은데 직접 필요한 부분만 응답객체로 만들어서 내려주는 것도 깔끔하고 좋을 것 같다.