[JPA] 커서 기반 pagenation 구현하기

커서 기반 페이지네이션

Cursor 개념을 사용하여 사용자에게 응답해준 마지막 데이터 기준으로 다음 n개 요청/응답

 

offset 기반 쿼리가 다음과 같다면

SELECT * FROM items WHERE 조건문 ORDER BY id DESC OFFSET 페이지번호 LIMIT 페이지사이즈

cursor 기반 쿼리는 다음과 같다.

SELECT * FROM items WHERE 조건문 AND id < 마지막조회_id ORDER BY id DESC LIMIT 페이지사이즈

직전 조회 결과의 마지막 데이터가 추가로 들어가는데 SQL 키워드가 아닌 고정된 조건문으로 처리하기때문에 정적 쿼리로서의 한계가 있는 것 같다. (물론 동적 쿼리인 QueryDSL을 사용하면 된다.)

 

 

controller

/**
 * 게시물 page 조회
 *
 * @param cursorId
 * @return CursorResult<PostDto>
 */
@GetMapping(produces = APPLICATION_JSON_VALUE)
public ApiResponse<CursorResult<PostDTO.Response>> getPosts(@RequestParam("cursorId")Interger cursorId) {
    CursorResult<PostDTO.Response> page = postService.findAll(PageRequest.of(0,10), cursorId);
    return ApiResponse.ok(page);
}

PageRequest.of()의 첫 번째 파라미터는 무조건 0으로, 즉 최초의 페이지로 처리를 해야 한다.

 

public class CursorResult<T> {
    private List<T> values;
    private Boolean hasNext; // 다음 페이지가 있는지 함께 알려준다.

    public CursorResult(List<T> values, Boolean hasNext) {
        this.values = values;
        this.hasNext = hasNext;
    }
}

 

repository

public interface PostJpaRepository extends JpaRepository<Post, Long> {

    Slice<Post> findAllByIdLessThanOrderByIdDesc(Long id, Pageable pageable);

    Slice<Post> findAllByOrderByIdDesc(Pageable pageable); // 최초일 경우, cursorId가 null 일 경우
}

쿼리 메소드를 사용하여 작성하였습니다. 이 경우 호출 기준이 하나라면 문제 없겠지만 정렬 조건이나 상황마다 알맞은 메소드를 정의하고 호출해줘야하게때문에 코드가 굉장히 더러워질것으로 예상된다..

 

 

 

쿼리가 어떻게 나가는지 테스트 해봅니다.

@Test
@DisplayName("pageNation 쿼리 확인")
public void findBySlice(){
    Slice<Post> slice = postRepository.findAllByIdLessThanOrderByIdDesc(3L,PageRequest.of(0,10));
    System.out.println(slice.hasNext());
}

Slice로 반환값을 사용할 경우 limit으로 '페이지 사이즈  + 1'가 날라가기 때문에 다음 데이터의 유무를 확인할 수 있다.

 

 

 

프로젝트에 적용한 동적 쿼리

@Override
public Slice<OrderByStoreResponse> findBy(String storeId, OrderStatus orderStatus, 
	String cursorOrderId, Pageable pageable) {

		List<OrderByStoreResponse> result = query.select(order)
			.from(order)
			.leftJoin(order.orderItems, orderItem)
			.leftJoin(orderItem.item, item)
			.leftJoin(orderItem.customOption, customOption)
			.leftJoin(user).on(user.id.eq(order.userId))
			.where(
				generateCursorId(cursorOrderId, pageable.getSort()),
				order.storeId.eq(storeId),
				order.orderStatus.eq(orderStatus)
			)
			.limit(pageable.getPageSize() + 1)
			.orderBy(getOrder(pageable)) // 정렬 방식을 구하는 메소드
			.orderBy(order.id.desc());
	
		return SliceUtil.toSlice(result, pageable);
}

private BooleanExpression generateCursorId(String cursorOrderId, Sort sort) {
		if (cursorOrderId == null) {
			return null;
		}
		return order.id.lt(cursorOrderId);
}

fetch join을 하여 결과를 가져오는 쿼리이다. id가 null일 경우 해당 조건은 자동으로 적용이 제외되기때문에 여러 쿼리를 짤 필요가 없어졌다.

 

 

Cursor 기반 페이지네이션의 문제점

 

cursor 데이터가 유니크하지 않을 수 않다. (날짜 같은)

→ 데이터 누락이 발생할 수 있다.

→ cursor 데이터 + 유니크 id를 함께 사용하여 구현하면 해결!

이때 or 연산자의 경우 인덱스를 타지않을 수 있으니 주의한다.

 

 

 

 

 

reference.

https://wonyong-jang.github.io/database/2020/09/06/DB-Pagination.html

 

 

 

잘못된 정보가 있다면 댓글을 통해 알려주세요. 감사합니다.