[JPA] 페이징에 사용되는 Page와 Slice

Spring Data JPA에서 사용하는 Page와 Slice에 대해 알아보도록 하겠습니다.

 

Page에 대해서는 이 전에 JPA를 공부하면서 짧게나마 다뤄보았는데, 무한 스크롤을 구현할 때 Slice를 사용하기 때문에 페이징에 사용되는 Page와 Slice에 대해 자세히 기록해보려 합니다.

---

Page, Slice가 무엇이고 어디에 사용될까?

Spring Data JPA는 페이징을 위해 두 가지 객체를 제공하는데 이것이 바로 Slice와 Page입니다.

 

여기서 말하는 페이징이 무엇이냐 ?

우리가 페이징이란 사용자가 어떠한 데이터를 요청했을 때, 전체 데이터 중 일부를 원하는 정렬 방식으로 보여주는 방식입니다.

페이징 예시 - 구글 검색

 

페이징은 어떻게 적용할까?

페이징 기법 구현을 위해 기본적으로 알아야 하는 파라미터들이 있습니다.

• page : 페이징 기법이 적용되었을 때, 원하는 페이지 
• size : 해당 페이지에 담을 데이터 개수
• sort : 정렬 기준

이 파라미터들을 밑에서 설명할 Pageable 구현체에 담아 페이징을 설정합니다.

 

Repository 코드에서 메소드를 보면 파라미터로 Pageable 객체를 받습니다.

public interface PostRepository extends JpaRepository<Post, Long>, QPostRepository{

    Page<Post> findPageBy(Pageable pageable);

Pageable 객체는 Pagination을 위한 정보를 저장하는 객체로 Pageable은 인터페이스이므로 Pageable의 구현체인 PageRequest 객체를 사용합니다.

 

이 Pageable 인터페이스의 구현체인 PageRequest 생성자의 파라미터에 위에서 서술한 page, size, sort를 파라미터로 사용할 수 있습니다. 좀 더 구체적으로 알아봅시다.

 

Controller 계층입니다. Pageable를 Argument로 설정해두면, 해당 메소드에서 Pagination 정보를 추출할 수 있도록 도와줍니다. 따라서, "/postList" GetMapping 요청 시 page, size, sort를 파라미터로 함께 요청하여 Paging 정보를 설정할 수 있습니다.

@GetMapping("/postList")
public ResponseEntity<PostDto> postList(Pageable pageable){
    Page<PostDto> postList = postService.getPage(pageable);
    return new ResponseEntity<>(postList,HttpStatus.OK);
}

 

Service 계층입니다. Controller계층에서 요청한 페이징 정보를 Pageable 구현체에 담아 Repository 계층에 접근하여 페이징된 정보를 토대로 데이터를 꺼내옵니다.

 

public Page<Post> getPage(Pageable pageable) {
	
    int page = pageable.getPageNumber();
    int size = pageable.getPageSize();
    PageRequest.of(page, size, Sort.by(Sort.Direction.DESC));
    return postRepository.findPageBy(pageable);
}

 

만약 클라이언트가 Page, Size, Sort 정보를 파라미터에 쿼리스트링으로 넘겨주지 않는다면, 정렬되지 않은 20개씩 분리된 페이지 중 첫 페이지를 반환합니다. 이를 방지하기 위해 @PageDefault 어노테이션을 사용하여 페이징 정보가 함께 요청되지 않을 때에 대비하여 기본적인 페이징 정보를 설정할 수 있습니다.

 

+ @PageableDefault

@GetMapping("/postList")
public ResponseEntity<PostDto> postList(@PageableDefault(
            page = 0, size = 10, sort = "id", direction = Sort.Direction.DESC)
            Pageable pageable){
    Page<PostDto> postList = postService.getPage(pageable);
    return new ResponseEntity<>(postList,HttpStatus.OK);
}

 

+ page 인덱스를 1부터 시작하도록 설정

프론트에서는 page index를 1부터 계산하는 것과 달리 Pageable은 page index를 0부터 계산합니다. 필요에 따라 바꿔줄 필요가 있습니다.

@Configuration
public class CustomPageableConfiguration {
    @Bean
    public PageableHandlerMethodArgumentResolverCustomizer customize() {
        return p -> p.setOneIndexedParameters(true);
    }
}

Sol1. CustomPageableConfiguration 클래스를 만들어 pageableHandlerMethodArgumentResolverCustomizer를 커스터마이징 해주는 방법이 있습니다. 여기서 setOneIndexedParameters를 true로 설정하면 page 인덱스가 1부터 시작하도록 설정할 수 있습니다.

 

spring.data.web.pageable.one-indexed-parameters=true

Sol2. 또는 application-yml 이나 application-properties 설정에 위 코드를 추가하여 페이지 인덱스가 1부터 시작하도록 설정할 수 있습니다.

 

페이지 인덱스를 1부터 시작하도록 설정하게 되면, 단순히 Controller에서 받는 Pageable의 page값이 -1되서 저장될 뿐입니다.

Pageable 객체나 이후 반환받은 Slice, Page객체에서는 page인덱스가 여전히 0부터 시작하기 때문에 현재 페이지 index를 반환하고 싶다면 반드시 -1을 해주어야 합니다. 유의해서 사용하도록 합시다.

 

---

기본적인 페이징 개념과 사용 방법에 대해 알아보았습니다.

그런데 Repository를 보면 Page를 객체로 받았습니다. 그렇다면 이전에 언급한 Slice는 언제 어떻게 사용될까요?

 

Slice

사실 Page는 Slice과 상속관계입니다.

public interface Page<T> extends Slice<T> {

 따라서 Slice가 가진 모든 메소드를 Page도 사용할 수 있습니다.

Page가 Slice와 다른 점은 조회 쿼리 이후 전체 데이터 개수를 조회하는 쿼리가 한번 더 실행된다는 점입니다.

 

Page interface Method

int getTotalPages();

/**
 * Returns the total amount of elements.
 *
 * @return the total amount of elements
 */
long getTotalElements();

Slice interface Method

public interface Slice<T> extends Streamable<T> {

    int getNumber();

    int getSize();

    int getNumberOfElements();
    List<T> getContent();

    boolean hasContent();

    Sort getSort();

    boolean isFirst();

    boolean isLast();

    boolean hasNext();

    boolean hasPrevious();

    default Pageable getPageable() {
      return PageRequest.of(getNumber(), getSize(), getSort());
    }
    
    Pageable nextPageable();

    Pageable previousPageable();
    
    default Pageable nextOrLastPageable() {
      return hasNext() ? nextPageable() : getPageable();
    }

	default Pageable previousOrFirstPageable() {
      return hasPrevious() ? previousPageable() : getPageable();
    }
}

 

Page vs Slice 어떤 걸 사용해야 할까?

Page는 따라서 전체 데이터 개수를 조회하는 쿼리가 나가지 않기 때문에 Slice와 다르게 전체 데이터 개수나 전체 페이지 수까지 확인할 수 있습니다. 하지만 한 번 더 쿼리가 나가게 된다는 점에서 사용 방식에 따른 차이가 있습니다.

 

Slice의 경우 무한 스크롤 구현에서 사용합니다.

 

이미지 출처: 드리블

무한 스크롤은 우리가 스크롤 바가 아래 끝에 다다르게 되면 추가 데이터를 요청하는 기능입니다. 무한 스크롤에서는 전체 데이터 개수를 조회할 필요가 없기 때문에 굳이 Page를 써서 쿼리를 불필요하게 날릴 필요가 없습니다. 

 

Page는 전체 데이터 개수를 조회하는 쿼리를 한 번 더 실행합니다. 따라서 전체 페이지 개수나 데이터 개수가 필요한 경우 유용합니다.

 

 

<참고 자료>

Spring Data JPA의 Slice & Page

[Spring JPA] Spring Data JPA 에게 페이징이란?

 

[SpringBoot] Spring Data JPA 에서 Page와 Slice