[Springboot] JPA와 pageable 활용한 sort 정렬 구현 방법

Intro

안녕하세요. 이번 시간에는 spring boot 에서 JPA와 pageable 활용한 sort 정렬 구현 방법에 대해 알아보도록 하겠습니다. user 데이터가 있다는 가정하에 진행해보도록 하겠습니다. 

 

1. User 엔티티 정의 

User 엔티티에는 id, name, email, createdDate 등의 필드가 있다고 가정합니다.

@Entity
data class User(
    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    val id: Long,

    val name: String,
    val email: String,

    @CreatedDate
    val createdDate: LocalDateTime
)

 

2. UserRepository 인터페이스 정의

User 데이터를 페이징과 정렬로 조회하기 위해 JpaRepository를 상속한 UserRepository 인터페이스를 정의합니다. JpaRepository는 페이징과 정렬을 자동으로 지원합니다. findAll(Pageable pageable) 메서드를 통해 페이징 및 정렬된 데이터를 쉽게 조회할 수 있습니다.

interface UserRepository : JpaRepository<User, Long>

 

3. UserController에서 Pageable과 Sort 사용

3.1. 기본적인 페이징과 정렬

Pageable 객체는 URL 쿼리 파라미터에서 page, size, sort를 자동으로 처리할 수 있습니다. 위 코드에서는 pageable 객체를 사용하여 findAll(pageable)을 호출하고, Spring Data JPA가 제공하는 페이징과 정렬 기능을 자동으로 적용합니다.

@RestController
@RequestMapping("/users")
class UserController(private val userRepository: UserRepository) {

    @GetMapping
    fun getUsers(
        pageable: Pageable // Spring Data JPA가 자동으로 처리하는 Pageable 객체
    ): ResponseEntity<Page<User>> {
        val users = userRepository.findAll(pageable) // pageable을 사용하여 페이징과 정렬 적용
        return ResponseEntity.ok(users)
    }
}

 

3.2. URL 예시

다음과 같은 URL로 요청을 보낼 수 있습니다. Spring Boot는 자동으로 Pageable 객체를 구성하고 findAll(pageable)에 전달합니다. 이때, name 필드를 기준으로 오름차순 정렬된 User 데이터를 첫 번째 페이지에서 10개씩 반환합니다.

GET /users?page=0&size=10&sort=name,asc

• page=0: 첫 번째 페이지 (0부터 시작) 
• size=10: 한 페이지에 10개의 데이터 
• sort=name,asc: name 필드를 기준으로 오름차순 정렬

 

3.3. 여러 필드를 기준으로 정렬하기

여러 개의 필드를 기준으로 정렬하려면 sort 파라미터에 쉼표로 구분된 정렬 기준을 전달하면 됩니다. 예를 들어, name 필드를 오름차순으로, createdDate 필드를 내림차순으로 정렬하려면 다음과 같이 URL을 작성할 수 있습니다.

GET /users?page=0&size=10&sort=name,asc,createdDate,desc

 

3.4. PageRequest와 Sort를 사용하여 직접 설정

클라이언트에서 쿼리 파라미터로 정렬 기준을 보내지 않고, 서버에서 직접 PageRequest와 Sort를 설정할 수도 있습니다.

@GetMapping("/users/custom-sort")
fun getUsersWithCustomSort(): ResponseEntity<Page<User>> {
    // 기본적으로 name을 오름차순, createdDate를 내림차순으로 정렬
    val sort = Sort.by(Sort.Order.asc("name"), Sort.Order.desc("createdDate"))
    val pageable = PageRequest.of(0, 10, sort) // 첫 페이지, 10개씩, 정렬 기준 설정
    val users = userRepository.findAll(pageable)
    return ResponseEntity.ok(users)
}