使用Spring Data JPA進行分頁與排序

一、導讀

如果一次性加載成千上萬的列表數據，在網頁上顯示將十分的耗時，用戶體驗不好。所以處理較大數據查詢結果展現的時候，分頁查詢是必不可少的。分頁查詢必然伴隨着一定的排序規則，否則分頁數據的狀態很難控制，導致用戶可能在不同的頁看到同一條數據。那麼，本文的主要內容就是給大家介紹一下，如何使用Spring Data JPA進行分頁與排序。

二、實體定義

我們使用一個簡單的實體定義：Article(文章)

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
@Entity
@Table(name="article")
public class Article {

    @Id
    @GeneratedValue
    private Long id;

    @Column(nullable = false,length = 32)
    private String author;

    @Column(nullable = false, unique = true,length = 32)
    private String title;

    @Column(length = 512)
    private String content;

    private Date createTime;
}

• @Entity 表示這個類是一個實體類，接受JPA控制管理，對應數據庫中的一個表
• @Table 指定這個類對應數據庫中的表名。如果這個類名和數據庫表名符合駝峯及下劃線規則，可以省略這個註解。如FlowType類名對應表名flow_type。
• @Id 指定這個字段爲表的主鍵
• @GeneratedValue(strategy=GenerationType.IDENTITY) 指定主鍵的生成方式，一般主鍵爲自增的話，就採用GenerationType.IDENTITY的生成方式
• @Column 註解針對一個字段，對應表中的一列。nullable = false表示數據庫字段不能爲空, unique = true表示數據庫字段不能有重複值,length = 32表示數據庫字段最大程度爲32.
• @Data、@AllArgsConstructor、@NoArgsConstructor、@Builder都是插件lombok的註解，用來幫助我們生成set、get方法、構造函數等實體類的模板代碼。

三、Repository定義

定義一個接口ArticleRepository繼承 PagingAndSortingRepository。PagingAndSortingRepository接口不僅包含基礎的CURD函數，還支持排序、分頁的接口函數定義。

public interface ArticleRepository extends PagingAndSortingRepository<Article,Long> {
     //查詢article表的所有數據，傳入Pageable分頁參數，不需要自己寫SQL
    Page<Article> findAll(Pageable pageable);
    //根據author字段查詢article表數據，傳入Pageable分頁參數，不需要自己寫SQL
    Page<Article> findByAuthor(String author, Pageable pageable);
    //根據author字段和title字段，查詢article表數據，傳入Pageable分頁參數，不需要自己寫SQL
    Slice<Article> findByAuthorAndTitle(String author, String title, Pageable pageable);
}

四、實現分頁

 Pageable 是Spring定義的接口，用於分頁參數的傳遞，我們看看如何使用它。首先將ArticleRepository注入到你需要進行持久層操作的類裏面，通常是一個@Service註解的類，然後在服務方法內使用如下代碼進行分頁操作：查詢第一頁(從0開始)的數據，每頁10條數據。

Pageable pageable = PageRequest.of(0, 10);   //第一頁
//Pageable pageable = PageRequest.of(0, 10);  //第二頁
//Pageable pageable = PageRequest.of(0, 10);  // 第三頁
//數據庫操作獲取查詢結果
Page<Article> articlePage = articleRepository.findAll(pageable);
//將查詢結果轉換爲List
List<Article> articleList = articlePage.getContent();

findAll方法以Page類的對象作爲響應，如果我們想獲取查詢結果List，可以使用getContent()方法。但是筆者不建議這樣進行轉換，因爲前端展示一個分頁列表，不僅需要數據，而且還需要一些分頁信息。如：當前第幾頁，每頁多少條，總共多少頁，總共多少條。這些信息在Page(articlePage)對象裏面均可以獲取到(下文中有介紹)。

五、實現排序

Spring Data JPA提供了一個 Sort對象，用以提供一種排序機制。讓我們看一下排序的方式。

articleRepository.findAll(Sort.by("createTime"));

articleRepository.findAll(Sort.by("author").ascending()
                        .and(Sort.by("createTime").descending()));

• 第一個findAll方法是按照createTime的升序進行排序
• 第一個findAll方法是按照author的升序排序，再按照createTime的降序進行排序

分頁和排序在一起

Pageable pageable = PageRequest.of(0, 10,Sort.by("createTime"));

六、Slice與Page

在ArticleRepository我們看到了一個方法返回Slice和另一個方法返回了Page。它們都是Spring Data JPA的數據響應接口，其中 Page 是 Slice的子接口。它們都用於保存和返回數據。

6.1.Slice

讓我們看一下 Slice的一些重要方法。

List <T>  getContent（）; //獲取切片的內容

Pageable  getPageable（）; //當前切片的分頁信息

boolean  hasContent（）; //是否有查詢結果？

boolean  isFirst（）;  //是否是第一個切片

boolean  isLast（）;  //是否是最後一個切片

Pageable nextPageable(); // 下一個切片的分頁信息

Pageable previousPageable(); // 上一個切片的分頁信息

6.2.Page

 Page是Slice的子接口，以下是的一些重要方法。

//總頁數
int getTotalPages();

//總數據條數
long getTotalElements();

那麼，什麼時候使用Slice？什麼時候使用Page？
答：通過這兩個接口的函數定義可以看出，Slice只關心是不是存在下一個分片(分頁)，不會去數據庫count計算總條數、總頁數。所以比較適合大數據量列表的的鼠標或手指滑屏操作，不關心總共有多少頁，只關心有沒有下一頁。Page比較適合傳統應用中的table開發，需要知道總頁數和總條數。