Spring 페이지네이션 처리

페이지네이션?

페이징은 게시글, 댓글 등을 표출할 양이 많아질때, 아주 중요한 역할을 한다. 페이징을 통해서 많은 정보 즉, 수백 수천개의 게시글등의 정보를 페이지로 나눠서 효과적으로 정보를 제공하게 한다.

이런 페이징을 위해서는 page관련 쿼리를 파라미터로 받아서 처리하는 방법이 있지만, Spring Data JPA에서 효과적인 페이징 처리 방법을 제공한다.

 

JpaRepository 의 부모인터페이스인 PagingAndSortingRepository에서 페이징과 Sorting 기능을 제공한다.

findAll() 메서드의 반환 타입을 살펴보면, 아래와 같은 메서드가 존재한다.

 

• Pageable : 페이징을 제공하는 인터페이스
• Page : 페이징의 findAll()의 기본적인 반환 메서드로 여러 반환타입중 하나

 

즉, JpaRepository<>를 사용할때 findAll() 메서드를 Pageble 인터페이스로 파라미터를 넘기면 페이징을 사용할수있다.

 

코드

Controller

/**  
* 스프링에서는 기본적으로 페이지 번호를 0부터 시작한다. -> 이를 위해서 controller쪽에서 page-1 을 해서 올바른 번호를 조회할수있게 해줌.  
* @param page : 페이지네이션을 위한 페이지 번호  
* @param size : 한 페이지에 표시되어야 할 데이터 개수(row)  
* @return  
*/
@GetMapping  
public ResponseEntity getLicenses(@RequestParam int page,  
@RequestParam int size){  
Page<License> pageLicenses = licenseService.findLicenses(page, size);  
List<License> licenses = pageLicenses.getContent();  

return new ResponseEntity<>(  
new MultiResponseDto<>(licenses,pageLicenses),HttpStatus.OK  
);  
}

Service

/**  
* 페이지네이션 처리가 된 자격증 정보 목록을 리턴  
* @param page  
* @param size  
* @return  
*/  
public Page<License> findLicenses(int page, int size) {  
return licenseRepository.findAll(PageRequest.of(page-1, size, Sort.by("id").ascending()));  
} 
//page-1 을 하는 이유는 page+1이 되어있으므로.
//id로 sorting 오름차순(ascending)

MultiResponseDto

@Getter  
public class MultiResponseDto<T> {  

private List<T> data; // 응답 데이터 목록 담는 필드  
private PageInfo pageInfo; // 페이지 정보 담는 필드  

public MultiResponseDto(List<T> data, Page page) {  

this.data = data;  

// 페이지 번호 0부터 시작하기 때문에 1부터 시작하는 걸로 변경  
this.pageInfo = new PageInfo(page.getNumber() + 1,  
page.getSize(), page.getTotalElements(), page.getTotalPages());  
}  
}

PageInfo

@AllArgsConstructor  
@Getter  
public class PageInfo {  

private int page;  
private int size;  
private long totalElements;  
private long totalPage;  

}

결과

 

페이징 반환타입

Page<T> type

• Page<T> 타입으로 반환하면 offset과 totalPage를 이용해서 서비스를 제공할수있다.
• Page<T> 는 일반적인 게시판 형태의 페이징에서 사용된다.
• 위의 예제 코드에 작성된것이 Page타입으로 나타낸것이다.
• Page<T> 타입은 count쿼리를 포함하는 페이징으로 count쿼리가 자동으로 생성되어 함께 나간다.

 

Slice<T> type

• slice 타입을 반환 타입으로 받으면 더보기 형태의 페이징으로 나타난다.

 

List<T> type

@GetMapping("/users") 
public List<User> getAllUsers(Pageable pageable) { 
return userRepository.findAll(pageable); }

• List 반환 타입은 가장 기본적인 방법으로 count 쿼리 없이 결과만 반환된다.