SpringData JPA 페이징과 정렬

출처 : 내일배움캠프

 

in PagingAndSortingRepository

페이징 프로세스

1. PageRequest 를 사용하여 Pageable에 페이징 정보를 담아 객체화
2. Pageable을 JpaRepository가 상속된 인터페이스의 메서드에 T(Entity)와 함꼐 파라미터로 전달
3. return 으로 Page<T>가 응답
4. 응답된 Page<T>에 담겨진 Page 정보를 바탕으로 로직을 처리하면 된다.

Pageable : 페이징 제공 인터페이스

Pageable 만드는 법

PageRequest.of(int page, int size) : 0부터 시작하는 페이지 번호와 개수. 정렬이 지정되지 않음
PageRequest.of(int page, int size, Sort sort) : 페이지 번호와 개수, 정렬 관련 정보
PageRequest.of(int page int size, Sort sort, Direction direction, String ... props) : 

0부터 시작하는 페이지 번호와 개수, 정렬의 방향과 정렬 기준 필드들

 

Pageable의 메서드

pageable.getTotalPages() : 총 페이지 수
pageable.getTotalElements() : 전체 개수
pageable.getNumber() : 현재 페이지 번호
pageable.getSize() : 페이지 당 데이터 개수
pageable.hasnext() : 다음 페이지 존재 여부
pageable.isFirst() : 시작페이지 여부
pageable.getContent(), PageRequest.get() : 

실제 컨텐츠를 가지고 오는 메서드. getContext는 List<Entity> 반환, get()은 Stream<Entity> 반환

반환 타입

1) Page<T>

- 게시판 형태의 페이징에서 사용

- 전체 요소 개수도 함꼐 조회한다

- 응답 형태

{
    "content": [
        {"id": 1, "username": "User 0", "address": "Korea", "age": 0},
        ...
        {"id": 5, "username": "User 4", "address": "Korea", "age": 4}
    ],
    "pageable": {
        "sort": {
            "sorted": false, // 정렬 상태
            "unsorted": true,
            "empty": true
        },
        "pageSize": 5, // 페이지 크기
        "pageNumber": 0, // 페이지 번호 (0번 부터 시작)
        "offset": 0, // 해당 페이지의 첫번째 요소의 전체 순번 (다음 페이지에서는 5)
        "paged": true,
        "unpaged": false
    },
    "totalPages": 20, // 페이지로 제공되는 총 페이지 수
    "totalElements": 100, // 모든 페이지에 존재하는 총 원소 수
    "last": false,  // 마지막 페이지 여부
    "number": 0,
    "sort": {
        "sorted": false,    // 정렬 사용 여부
        "unsorted": true,
        "empty": true
    },
    "size": 5,       // Contents 사이즈
    "numberOfElements": 5,  // Contents 의 원소 수
    "first": true,   // 첫페이지 여부
    "empty": false   // 공백 여부
}

2) Slice<T>

- '더보기' 형태의 페이징에서 사용

- 전체 요소 개수 대신 offset 필드로 조회 가능 ~  count 쿼리가 없고 limit + 1 조회를 한다(현업에서 잘 쓰지 않는다)

- 응답 형태

{
"content": [
  { "id": 13, "username": "User 12", "address": "Korea", "age": 12 },
  ...
  { "id": 16, "username": "User 15", "address": "Korea", "age": 15 }
],
"pageable": {
  "sort": { "sorted": false, "unsorted": true, "empty": true },
  "pageNumber": 3,
  "pageSize": 4,
  "offset": 12,
  "paged": true,
  "unpaged": false
},
"number": 3,
"numberOfElements": 4,
"first": false,
"last": false,
"size": 4,
"sort": { "sorted": false, "unsorted": true, "empty": true },
"empty": false
}

3) List<T> 타입

전체 목록보기 형태의 페이징에서 사용

기본 타입으로 Count 조회가 발생하지 않는다

 

Sort : 정렬

Sort 사용법

1) 컬럼 값으로 정렬 : 메서드의 인자 값으로 컬럼을 넣고, 그 기준으로 정렬하기

Sort sort1 = Sort.by("name").descending();     // 내림차순
Sort sort2 = Sort.by("password").ascending();  // 오름차순
Sort sortAll = sort1.and(sort2);      // 2개이상 다중정렬도 가능하다
Pageable pageable = PageRequest.of(0, 10, sortAll);  // pageable 생성시 추가

2) 컬럼이 아닌 값으로 정렬 : @Query으로 Alias를 걸어준 값을 기준으로 정렬

// 아래와 같이 AS user_password 로 Alias(AS) 를 걸어주면
@Query("SELECT u, u.password AS user_password FROM user u WHERE u.username = ?1")
List<User> findByUsername(String username, Sort sort);

// 이렇게 해당 user_password 를 기준으로 정렬할 수 있다.
List<User> users = findByUsername("user", Sort.by("user_password"));

3) SQL 함수를 사용한 정렬 : JpaSort

// 아래와 같이 일반적인 쿼리에서
@Query("SELECT u FROM user u WHERE u.username = ?1") // 이건 없어도됨
List<User> findByUsername(String username, Sort sort);

// 이렇게 쿼리함수 LENGTH() 조건을 걸어서 password 문자길이 기준으로 정렬할 수 있다.
List<User> users = findByUsername("user", JpaSort.unsafe("LENGTH(password)"));

 

실무 팁

1. List<T>가 필요한 경우 LIst<T>로 받을 것 :

전체 Count 쿼리가 추가로 발생하는 Page<T>보다는 List<T>가 대용량 처리할 때 더 안정적이고 빠르다

 

2. Pageable과 실제 페이지 사이 -1 문제 해결하기 : JPA 페이지는 0부터인데 화면은 1부터 시작하는 문제 

~ -1 처리를 중복으로 해줘야하는 이슈

-> PageDTO를 만들어 toPageable() 메소드를 사용하자

 

3. Pageable을 Get API의 요청 필드로 받아오기

get API에서 파라미터를 Pageable로 받으면 별도로 @RequestParam을 사용하지 않고도 바로 받아올 수 있다