스프링부트 페이징처리하기(JPA + RESTAPI)

🥴Paging?

글 목록이나 유저 목록 등을 구현하다 보면 페이징이 필요한 경우가 있다. 페이지를 나눠 해당 페이지에 필요한 정보만 보내기도 하고, 정렬 기준이 필요한 경우도 있을 것이다.

스프링에서는 간편하게도 해당 기능을 구현한 Page, Pageable이 존재한다. 현재 프로젝트 구현 중에 페이지 처리를 해야 하는 부분이 생겨서 해당 기능을 간략하게 정리해 보려고 한다.

 

🛰️Controller

먼저 컨트롤러에서의 Paging처리이다.

보통 요청은 다음과 같이 Pageable의 page, size, sort 3가지의 파라미터로 요청받는다.

/api/admin/users?page=3&size=1&sort=id,DESC

→ 3번째 페이지 / 페이지당 사이즈 1 / id기준 내림차순 정렬

 

@GetMapping("api/admin/users")
    public ResponseEntity<Map<String, Object>> readAllUser(Pageable pageable) {
        Page<ReadUserInfoResponseDTO> responseDTO = userService.readAllUser(pageable);
        Map<String, Object> result = new HashMap<>();
        result.put("msg", "전체 유저 조회가 완료되었습니다.");
        result.put("data", responseDTO);
        return ResponseEntity.ok().body(result);
    }

위의 코드를 보면 @RequestBody 또는 @RequestParam 없이 단독으로 Pageable만 들어가 있는데,

이는 요청할 때, PageableHandlerMethodArgumentResolver 에서 Pageable 객체를 확인하고 직접 변환하여 Pageable의 구현 클래스인 PageRequest를 반환하여 파라미터에 넣어준다.(아래 코드 확인)

/*
	 * (non-Javadoc)
	 * @see org.springframework.web.method.support.HandlerMethodArgumentResolver#supportsParameter(org.springframework.core.MethodParameter)
	 */
	@Override
	public boolean supportsParameter(MethodParameter parameter) {
		return Pageable.class.equals(parameter.getParameterType());
	}

/*
	 * (non-Javadoc)
	 * @see org.springframework.web.method.support.HandlerMethodArgumentResolver#resolveArgument(org.springframework.core.MethodParameter, org.springframework.web.method.support.ModelAndViewContainer, org.springframework.web.context.request.NativeWebRequest, org.springframework.web.bind.support.WebDataBinderFactory)
	 */
	@Override
	public Pageable resolveArgument(MethodParameter methodParameter, @Nullable ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) {

		String page = webRequest.getParameter(getParameterNameToUse(getPageParameterName(), methodParameter));
		String pageSize = webRequest.getParameter(getParameterNameToUse(getSizeParameterName(), methodParameter));

		Sort sort = sortResolver.resolveArgument(methodParameter, mavContainer, webRequest, binderFactory);
		Pageable pageable = getPageable(methodParameter, page, pageSize);

		if (sort.isSorted()) {
			return PageRequest.of(pageable.getPageNumber(), pageable.getPageSize(), sort);
		}

		return pageable;
	}

 

🤖Service

public Page<ReadUserInfoResponseDTO> readAllUser(Pageable pageable) {
        Page<User> users = userRepository.findByDeleted(pageable, false);
        return users.map(ReadUserInfoResponseDTO::toDTO);
    }

현재 프로젝트에서는 서비스단에서 dto변환을 처리하기 때문에 repository에서 받아온 목록을 Page의 map메서드를 통해, dto로 변환하여 반환한다.

 

📦Repository

@Repository
public interface UserRepository extends JpaRepository<User, Integer> {
    Page<User> findByDeleted(Pageable pageable, boolean deleted);
}

Jpa에서 Page로 받아오는 메서드를 제공하고 있다. 실제로 쿼리로 날릴 때 2번의 요청이 나가는데, 한 번은 정렬된 객체들을 받아오는 요청, 다른 한 번은 전체 페이지를 계산하기 위한 count 메서드가 실행된다.

 

spring.jpa.show-sql=true 했을 때, 볼 수 있는 쿼리)

Hibernate:
select
user0_.user_id as user_id1_11_,
user0_.created_date as created_2_11_,
user0_.modified_date as modified3_11_,
user0_.deleted as deleted4_11_,
user0_.email as email5_11_,
user0_.github_id as github_i6_11_,
user0_.phone_number as phone_nu7_11_,
user0_.profile_img_url as profile_8_11_,
user0_.role as role9_11_,
user0_.username as usernam10_11_
from
user user0_
where user0_.deleted=?
order by user0_.user_id desc limit ?,
?
Hibernate:
select
count(user0_.user_id) as col_0_0_
from user user0_
where user0_.deleted=?

 

🦿기본 파라미터 설정하기

위와 같은 형식으로 스프링 부트로 페이징을 구현할 수 있으며, pageable파라미터를 넣지 않더라도 기본 값을 변경함으로써 나타내 주는 방법도 있다.

@GetMapping("api/admin/users")
    public ResponseEntity<Map<String, Object>> readAllUser(
					 @PageDefault(size=100, sort="id", direction = Sort.Direction.DESC) Pageable pageable) {
        Page<ReadUserInfoResponseDTO> responseDTO = userService.readAllUser(pageable);
        Map<String, Object> result = new HashMap<>();
        result.put("msg", "전체 유저 조회가 완료되었습니다.");
        result.put("data", responseDTO);
        return ResponseEntity.ok().body(result);
    }