[Springboot] 페이지네이션 Pageable 객체에 대해 알아보자

Intro

안녕하세요. 이번 시간에는 스프링부트의 Pageable 페이지네이션 객체에 대해 알아보도록 하겠습니다.

제 경우 Task를 진행하던 도중 페이지네이션을 추가해야 하는 요구사항이 들어옸습니다. 페이지네이션을 구현하는 방법은 여러가지가 있는데요, 그중에서도 저는 Spring Data JPA를 이용했습니다.

Spring Data JPA를 이용하면 Pageable 객체를 사용하여 페이지네이션(pagination) 정보를 쉽게 관리할 수 있기 때문입니다. JPA Query 메서드의 파라미터로 Pageable을 넘겨서 DB에 쿼리를 날릴 수 있습니다.

즉, 알아서 잘 해주기 때문에 매우 편하게 사용이 가능합니다 :-)

Pageable

Pageable는 Pagination 요청 정보들을 담기 위한 추상 인터페이스입니다.

• class QPageRequest : QueryDSL을 위한 Pageable 구현체
• class PageRequest : 가장 기본적인 Pageable 구현체
• enum Unpaged : pagination 정보가 없는 것을 표현하기 위한 구현체

보통 이 중에서 가장 기본인 PageRequest를 많이 사용한다고 합니다.

Example

UserController에 user 목록을 가져오는 메서드를 만들어봤습니다. getPageRequest 함수를 통해 PageRequest 객체를 가져오고 있습니다.

@RestController
@RequestMapping("api/v1/user")
class UserController(
    private val userApiService: UserApiService
) : BaseMobileApiController() {

    /**
     * user 조회
     */
    @GetMapping
    suspend fun getUsers(
        principal: Principal,
        pageable: Pageable,
    ): ApiResponse<Page<UserRes>> {
        val res = userApiService.getUsers(principal, getPageRequest(pageable))
        return ApiResponse.ok(res)
    }
}

위 user 조회 API를 실행한 결과는 다음과 같습니다.

"content":[
{
    "content": [
        {"id": 1, "username": "User 0", "address": UK", "age": 20},
        ...,
        {"id": 5, "username": "User 4", "address": "Korea", "age": 4}
    ],
    "pageable": {
        "sort": {
            "sorted": false, // 정렬 상태
            "unsorted": true,
            "empty": true
        },
        "pageSize": 5, // 한 페이지에서 나타내는 원소의 수 (게시글 수)
        "pageNumber": 0, // 페이지 번호 (0번 부터 시작)
        "offset": 0, // 해당 페이지에 첫 번째 원소의 수
        "paged": true,
        "unpaged": false
    },
    "totalPages": 20, // 페이지로 제공되는 총 페이지 수
    "totalElements": 100, // 모든 페이지에 존재하는 총 원소 수
    "last": false,
    "number": 0,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "size": 5,
    "numberOfElements": 5,
    "first": true,
    "empty": false
}

---

https://velog.io/@chlee4858/Jpa-Pagination-%EA%B5%AC%ED%98%84%ED%95%98%EA%B8%B0
https://wonit.tistory.com/483