Day 23 JPA 實現分頁與動態排序

2024 iThome 鐵人賽

DAY 23

Modern Web

Spring Boot API 開發：從 0 到 1系列第 23 篇

16th鐵人賽

cashwugeek

2024-09-23 08:40:02

374 瀏覽

分享至

在處理大量資料時，分頁和排序是兩個非常重要的功能，它們不僅可以提高應用程式的性能，還能為用戶提供更好的體驗

而 Spring Data JPA 為我們提供了簡單而強大的方法來實現這些功能

今天，我們將深入探討如何在我們的 Todo 應用中實現分頁和動態排序的功能

分頁

修改 Repository

讓我們在 TodoRepository 中增加一個分頁的方法

這個新方法 findAll 接受一個 Pageable 物件，返回一個 Page<Todo> 物件

這裡，我們使用了 Spring Data JPA 提供的 Pageable。它允許我們指定頁碼、每頁大小以及排序信息

// 為了方便，在這裡只展示了所增加的相關程式碼

public interface TodoRepository extends JpaRepository<Todo, Long> {
    Page<Todo> findAll(Pageable pageable);
}

修改 Controller

現在，讓我們在 TodoController 中增加一個使用分頁的方法 (endpoint) /api/todos/paged

@RestController
@RequestMapping("/api/todos")
public class TodoController {

    // 為了方便，在這裡只展示了所增加的相關程式碼

    @GetMapping("/paged")
    public ResponseEntity<MyApiResponse<Page<Todo>>> getPagedTodos(
            @RequestParam(defaultValue = "0") int page,
            @RequestParam(defaultValue = "2") int size) {

        Pageable pageable = PageRequest.of(page, size);
        Page<Todo> todoPage = todoRepository.findAll(pageable);

        return ResponseEntity.ok(new MyApiResponse<>(true, todoPage, null));
    }
}

這個方法它接受兩個可選參數

page （頁碼，預設為 0 ），從 0 開始計算，為第一頁
size （每頁大小，預設為 2 ），為了測試方便，預設為 2

我們使用這些參數建立一個 pageable 物件，它定義了分頁的相關信息，然後將其傳遞給 repository 的 findAll 方法

findAll 方法會返回一個 Page<T> 物件，這是一個包含分頁結果的容器，除了當前頁面的內容，還包含了總頁數、總元素數等數據，方便在前端實現分頁導航

當實際使用 findAll 方法時，Spring Data JPA 會自動處理分頁的邏輯，產生適當的 SQL 查詢語法，只返回請求的那一頁的資料

測試

可以看到全部的資料有 3筆

沒有傳 page 的資料，預設為第一頁

傳入 page 的資料 1 ，為第二頁

動態排序

動態排序允許客戶端指定按照那個欄位進行排序，以及排序的方向（升序或降序）

這在處理大量的資料時特別有用，因為它允許用戶根據自己的需求來組織資料

修改 Controller

讓我們修改 TodoController 來支持動態排序

因為排序也被封裝在 Pageable 物件裡面，所以只需要調整 Controller 就好

@RestController
@RequestMapping("/api/todos")
public class TodoController {

    // 為了方便，在這裡只展示了所增加的相關程式碼

    @GetMapping("/paged")
    public ResponseEntity<MyApiResponse<Page<Todo>>> getPagedAndSortedTodos(
            @RequestParam(defaultValue = "0") int page,
            @RequestParam(defaultValue = "2") int size,
            @RequestParam(defaultValue = "id") String sortBy,
            @RequestParam(defaultValue = "asc") String direction) {

        Sort.Direction sortDirection = direction.equalsIgnoreCase("desc") ? Sort.Direction.DESC : Sort.Direction.ASC;
        Sort sort = Sort.by(sortDirection, sortBy);
        Pageable pageable = PageRequest.of(page, size, sort);
        Page<Todo> todoPage = todoRepository.findAll(pageable);

        return ResponseEntity.ok(new MyApiResponse<>(true, todoPage, null));
    }
}

在原本的方法中，我們增加了兩個新的參數