---

Spring Data JPA 中的分頁實現：從 BasePage 到 Pageable

在現代 Web 開發中，分頁是一個常見的需求。無論是展示商品列表、文章列表還是用戶數據，當數據量較大時，分頁不僅能提升用戶體驗，還能減輕服務器的壓力。如果你使用的是 Spring Boot 和 Spring Data JPA，那么分頁功能已經內置其中，開發者只需簡單配置即可實現。今天，我們通過一個簡單的 BasePage 類，來看看如何優雅地實現分頁和排序功能。

背景：為什么需要分頁？

假設你正在開發一個電商平臺，數據庫中有成千上萬的商品記錄。如果一次性將所有數據返回給前端，不僅加載速度會變慢，用戶也很難從中找到所需信息。這時，分頁就派上用場了：每頁顯示固定數量的記錄（比如 10 條），用戶可以通過翻頁操作逐步瀏覽。

Spring Data JPA 提供了一個強大的接口 Pageable，它封裝了分頁和排序的邏輯。通過 Pageable，我們可以輕松實現“第幾頁”、“每頁幾條”以及“按什么字段排序”的功能。而今天的主角——BasePage 類，就是一個自定義的分頁模型，通過它我們可以將前端傳入的分頁參數轉換為 Pageable 對象。

認識 BasePage 類

BasePage 是一個簡單的分頁模型類，包含了分頁和排序的核心屬性。以下是它的代碼結構：

public class BasePage {@ApiModelProperty("頁碼")Integer page;@ApiModelProperty("頁大小")Integer size;@ApiModelProperty(value = "排序規則(ASC/DESC)", allowableValues = "ASC,DESC")String direction;@ApiModelProperty("排序字段")String[] properties;// 構造函數、getter 和 setter 略public Pageable toPageable() {page = page != null ? page : 0;size = size != null ? size : 9999;Sort.Direction dir = Sort.Direction.fromOptionalString(this.direction).orElse(Sort.Direction.DESC);Sort sort = (properties != null && properties.length > 0) ? Sort.by(dir, properties) : Sort.by(dir, "createdDate");return PageRequest.of(page, size, sort);}
}

這個類包含了四個關鍵屬性：

• page：頁碼，表示當前是第幾頁。
• size：每頁的大小，表示每頁顯示多少條記錄。
• direction：排序方向，可以是 "ASC"（升序）或 "DESC"（降序）。
• properties：排序字段，表示按哪些字段排序。

而 toPageable() 方法則是這個類的核心，它將這些屬性轉化為 Spring Data JPA 所需的 Pageable 對象。

深入 toPageable() 方法

讓我們一步步拆解 toPageable() 方法，看看它是如何工作的：

1. 處理頁碼和頁面大小

page = page != null ? page : 0;
size = size != null ? size : 9999;

• 如果 page 未設置（null），默認值為 0，表示第一頁（Spring Data 的頁碼從 0 開始）。
• 如果 size 未設置，默認值為 9999。這是一個很大的數字，通常是為了在未指定頁面大小時盡量返回所有數據。不過在實際應用中，建議根據業務需求設置一個合理的默認值，比如 10 或 20。

2. 處理排序方向

Sort.Direction dir = Sort.Direction.fromOptionalString(this.direction).orElse(Sort.Direction.DESC);

• Sort.Direction 是 Spring Data 的枚舉類，表示排序方向。
• fromOptionalString(this.direction) 嘗試將 direction（如 “ASC” 或 “DESC”）解析為 Sort.Direction 類型。
• 如果解析失敗或 direction 為 null，則使用默認值 Sort.Direction.DESC（降序）。

3. 處理排序字段

Sort sort = (properties != null && properties.length > 0) ? Sort.by(dir, properties) : Sort.by(dir, "createdDate");

• 如果 properties 不為空，則按指定的字段排序。
• 如果 properties 為空或未設置，則默認按 "createdDate"（創建時間）字段排序。
• Sort.by(dir, properties) 創建了一個 Sort 對象，封裝了排序方向和字段。

4. 生成 Pageable 對象

return PageRequest.of(page, size, sort);

• 使用 PageRequest.of() 方法，將頁碼、頁面大小和排序規則組合成一個 Pageable 對象。
• 這個對象可以直接傳遞給 Spring Data 的查詢方法。

實戰：如何使用 BasePage

假設我們有一個商品管理的接口，需要支持分頁和排序。以下是實現步驟：

1. 前端請求

前端發送一個 HTTP 請求，例如：

GET /products?page=1&size=10&direction=ASC&properties=price

• page=1：請求第 2 頁（從 0 開始計數）。
• size=10：每頁 10 條記錄。
• direction=ASC：按升序排序。
• properties=price：按價格排序。

2. 后端控制器

在 Spring Boot 的控制器中接收參數并構造 BasePage：

@RestController
@RequestMapping("/products")
public class ProductController {@Autowiredprivate ProductRepository productRepository;@GetMappingpublic Page<Product> getProducts(@RequestParam(required = false) Integer page,@RequestParam(required = false) Integer size,@RequestParam(required = false) String direction,@RequestParam(required = false) String[] properties) {BasePage basePage = new BasePage();basePage.setPage(page);basePage.setSize(size);basePage.setDirection(direction);basePage.setProperties(properties);Pageable pageable = basePage.toPageable();return productRepository.findAll(pageable);}
}

3. 查詢數據庫

ProductRepository 是一個 Spring Data JPA 提供的接口：

public interface ProductRepository extends JpaRepository<Product, Long> {
}

調用 findAll(Pageable pageable) 方法后，Spring Data 會自動生成 SQL 查詢，返回分頁后的結果。

4. 返回結果

最終返回的 JSON 可能長這樣：

{"content": [{"id": 1, "name": "商品A", "price": 10.0},{"id": 2, "name": "商品B", "price": 15.0},...],"totalElements": 50,"totalPages": 5,"number": 1,"size": 10
}

小結

通過 BasePage 和 toPageable() 方法，我們實現了一個簡單而靈活的分頁模型。它的優點在于：

• 簡單易用：只需設置幾個屬性，就能生成 Pageable 對象。
• 默認值友好：未設置的參數有合理的默認值，避免空指針問題。
• 支持排序：靈活指定排序字段和方向，滿足復雜需求。

當然，實際開發中還可以根據需求擴展 BasePage，比如添加參數驗證、支持多字段排序等。Spring Data JPA 的分頁功能非常強大，配合自定義模型類，可以讓代碼更優雅、更易維護。

如果你也正在為分頁功能苦惱，不妨試試這種方式吧！有什么問題或想法，歡迎在評論區交流。

---