Spring Boot 4 Microservices & REST APIs · 강의

페이지 매김 및 정렬

효율적인 데이터 검색을 위해 API 엔드포인트에 페이지 매김과 정렬 기능을 추가합니다.

페이지 매김 및 정렬은(는) CoddyKit의 무료 Spring Boot 4 Microservices & REST APIs 강의입니다. 이것은 3개 중 2번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Spring Boot 4 Microservices & REST APIs 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Spring Boot 4 Microservices & REST APIs 강의에는 총 3개의 강의가 포함되어 있습니다.

이 강의의 일부는 아직 번역되지 않았으며 영어로 표시됩니다.

Handling Large API Responses

Imagine an API returning thousands of database records. Fetching all that data at once is inefficient and can overwhelm both the server and the client.

Slow Performance: Large payloads take longer to transfer and process.
High Resource Usage: Both client and server use more memory and CPU.
Poor User Experience: Users might wait a long time or see a frozen app.

This is where pagination comes in handy!

What is Pagination?

Pagination is a technique to divide a large set of results into smaller, manageable chunks called 'pages'. Instead of getting everything, you request one page at a time.

Page Number: Which page you want (e.g., page 1, page 2).
Page Size: How many items should be on each page (e.g., 10 items per page).

This significantly improves API performance and user experience by reducing data transfer.

Spring Data's Pageable

Spring Data JPA provides a convenient Pageable interface to handle pagination and sorting requests. When you include Pageable as a method parameter in your controller, Spring automatically extracts the pagination (and sorting) information from the request parameters.

Common query parameters used by Spring are page (0-indexed) and size.

Implementing Pagination

Let's create a simple Spring Boot REST endpoint that returns a paginated list of items. We'll use @PageableDefault to set default page and size values.

Run this application and access http://localhost:8080/api/items?page=0&size=3 in your browser.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageImpl;
import org.springframework.data.domain.Pageable;
import org.springframework.data.web.PageableDefault;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
import java.util.ArrayList;

@SpringBootApplication
@RestController
public class PagingController {

    private List<String> items = List.of("Apple", "Banana", "Orange", "Grape", "Kiwi", "Mango", "Peach", "Plum", "Cherry", "Lemon", "Fig", "Date");

    @GetMapping("/api/items")
    public Page<String> getItems(
        @PageableDefault(size = 3, page = 0) Pageable pageable) {

        int start = (int) pageable.getOffset();
        int end = Math.min((start + pageable.getPageSize()), items.size());

        List<String> pagedItems = items.subList(start, end);
        return new PageImpl<>(pagedItems, pageable, items.size());
    }

    public static void main(String[] args) {
        SpringApplication.run(PagingController.class, args);
    }
}

Exploring Paged Responses

When you call the API from the previous scene, try these URLs:

http://localhost:8080/api/items (uses defaults: page 0, size 3)
http://localhost:8080/api/items?page=0&size=5 (first page, 5 items)
http://localhost:8080/api/items?page=1&size=3 (second page, 3 items)

Notice how the response includes not just the content, but also metadata like totalPages, totalElements, and number (current page number).

Why Sorting Matters

Just as important as limiting the data is presenting it in a meaningful order. Users often want data sorted by name, date, price, or other attributes.

For example, a list of products might be sorted alphabetically, by price (low to high), or by creation date (newest first). APIs should provide this flexibility.

Sorting with Pageable

The good news is that Spring Data's Pageable also handles sorting! You can specify sorting criteria directly in your API request.

Field Name: The property to sort by (e.g., name, price).
Direction: Whether to sort ascending (asc) or descending (desc).

The standard query parameter for sorting is sort=fieldName,direction.

Implementing Sorting

Let's extend our item API to support sorting. We'll add a default sort order to @PageableDefault.

Run this application and access http://localhost:8080/api/items/sorted?page=0&size=3&sort=item,asc in your browser.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageImpl;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
import java.util.ArrayList;
import java.util.Comparator;

@SpringBootApplication
@RestController
public class SortingController {

    private List<String> items = new ArrayList<>(List.of("Apple", "Banana", "Orange", "Grape", "Kiwi", "Mango", "Peach", "Plum", "Cherry", "Lemon", "Fig", "Date"));

    @GetMapping("/api/items/sorted")
    public Page<String> getSortedItems(
        @PageableDefault(size = 3, page = 0, sort = "item", direction = Sort.Direction.ASC) Pageable pageable) {

        Comparator<String> comparator = Comparator.naturalOrder();
        if (pageable.getSort().isSorted() && pageable.getSort().getOrderFor("item") != null) {
            Sort.Direction direction = pageable.getSort().getOrderFor("item").getDirection();
            if (direction == Sort.Direction.DESC) {
                comparator = Comparator.reverseOrder();
            }
        }
        items.sort(comparator);

        int start = (int) pageable.getOffset();
        int end = Math.min((start + pageable.getPageSize()), items.size());

        List<String> pagedAndSortedItems = items.subList(start, end);
        return new PageImpl<>(pagedAndSortedItems, pageable, items.size());
    }

    public static void main(String[] args) {
        SpringApplication.run(SortingController.class, args);
    }
}

Combining Sort & Page

You can combine pagination and sorting in a single request! The Pageable object handles both seamlessly.

Try these URLs with the running application:

http://localhost:8080/api/items/sorted?page=0&size=4&sort=item,desc (first page, 4 items, descending)
http://localhost:8080/api/items/sorted?page=1&size=2&sort=item,asc (second page, 2 items, ascending)

This flexibility allows clients to retrieve exactly the data they need, how they need it.

Quick Check: API Parameters

You're building an API to list products. You want to retrieve the third page, with 10 products per page, sorted by price in descending order. Which of the following query parameters would achieve this?

Recap: Pagination & Sorting

We've learned how to implement pagination and sorting in Spring Boot REST APIs, making them more efficient and user-friendly.

Pagination: Use page (0-indexed) and size to retrieve data in chunks.
Sorting: Use sort=fieldName,direction (e.g., asc or desc) to order results.
Spring Data's Pageable: A powerful interface that automatically handles these parameters when included in your controller methods.

These techniques are crucial for building robust APIs that can handle large datasets gracefully.

자주 묻는 질문

“페이지 매김 및 정렬” 강의는 무료인가요?

네 — “페이지 매김 및 정렬” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Spring Boot 4 Microservices & REST APIs 강의 전체를 잠금 해제할 수 있습니다. Spring Boot 4 Microservices & REST APIs 강의에는 총 3개의 강의가 포함되어 있습니다.

“페이지 매김 및 정렬”에서 뭘 배우나요?

효율적인 데이터 검색을 위해 API 엔드포인트에 페이지 매김과 정렬 기능을 추가합니다. 브라우저에서 직접 실행하는 실습 코드로 Spring Boot 4 Microservices & REST APIs을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

Spring Boot 4 Microservices & REST APIs을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 Spring Boot 4 Microservices & REST APIs은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 3개 중 2번째 강의입니다.

“페이지 매김 및 정렬” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 Spring Boot 4 Microservices & REST APIs 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 Spring Boot 4 Microservices & REST APIs 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

← Spring Boot 4 Microservices & REST APIs(으)로 돌아가기