怎么用 Spring Data 在 RESTful API 中实现更好的分页

介绍

本文将重点介绍如何使用 Spring MVC 和 Spring Data 在 RESTful API 中实现分页。

REST 分页的可发现性

在分页范围内，满足 REST 的 HATEOAS 约束，意味着使 API 的客户端能够基于导航中的当前页面发现下一页和上一页。 为此，我们将使用Link HTTP 响应头，以及 “next”，“prev”，“first” 和 “last” 链接关系类型。
添加一个侦听器，监听器将检查导航是否允许下一页，上一页，第一页和最后一页。它将相关的 URI 作为 “链接” 添加到 HTTP 响应头中。

void addLinkHeaderOnPagedResourceRetrieval(
  UriComponentsBuilder uriBuilder, HttpServletResponse response,
  Class clazz, int page, int totalPages, int size ){
   
 
    String resourceName = clazz.getSimpleName().toString().toLowerCase();
    uriBuilder.path( "/admin/" + resourceName );
 
    // ...
    
}

接下来，我们将使用 StringJoiner 连接每个链接。我们将使用 uriBuilder 生成 uri。让我们看看我们如何继续链接到下一页：

StringJoiner linkHeader = new StringJoiner(", ");
if (hasNextPage(page, totalPages)){
   
    String uriForNextPage = constructNextPageUri(uriBuilder, page, size);
    linkHeader.add(createLinkHeader(uriForNextPage, "next"));
}

让我们来看看 constructNextPageUri 方法的逻辑：

String constructNextPageUri(UriComponentsBuilder uriBuilder, int page, int size) {
   
    return uriBuilder.replaceQueryParam(PAGE, page + 1)
      .replaceQueryParam("size", size)
      .build()
      .encode()
      .toUriString();