此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Data REST 4.4.0spring-doc.cadn.net.cn

分页和排序

本节记录了 Spring Data REST 对 Spring Data Repository 分页和排序抽象的用法。要熟悉这些功能,请参阅您使用的存储库实现(例如 Spring Data JPA)的 Spring Data 文档。spring-doc.cadn.net.cn

寻呼

Spring Data REST 不是从大型结果集中返回所有内容,而是识别一些影响页面大小和起始页码的 URL 参数。spring-doc.cadn.net.cn

如果您扩展PagingAndSortingRepository<T, ID>并访问所有实体的列表,您将获得指向前 20 个实体的链接。要将页面大小设置为任何其他数字,请添加size参数,如下所示:spring-doc.cadn.net.cn

http://localhost:8080/people/?size=5

前面的示例将页面大小设置为 5。spring-doc.cadn.net.cn

要在您自己的查询方法中使用分页,您需要更改方法签名以接受额外的Pageable参数并返回一个PageSlice而不是List.例如,以下查询方法将导出到/people/search/nameStartsWith并支持分页:spring-doc.cadn.net.cn

@RestResource(path = "nameStartsWith", rel = "nameStartsWith")
public Page findByNameStartsWith(@Param("name") String name, Pageable p);

Spring Data REST 导出器识别返回的Page/Slice并在响应正文中提供结果,就像使用非分页响应一样,但会向资源添加其他链接以表示上一页和下一页数据。spring-doc.cadn.net.cn

每个分页响应都使用 IANA 定义的链接关系,根据当前页面返回指向结果上一页和下一页的链接prevnext.但是,如果您当前位于结果的第一页,则不需要prev链接。对于结果的最后一页,否next链接。spring-doc.cadn.net.cn

请考虑以下示例,其中我们将页面大小设置为 5:spring-doc.cadn.net.cn

curl localhost:8080/people?size=5
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/persons{&sort,page,size}", (1)
      "templated" : true
    },
    "next" : {
      "href" : "http://localhost:8080/persons?page=1&size=5{&sort}", (2)
      "templated" : true
    }
  },
  "_embedded" : {
  	… data …
  },
  "page" : { (3)
    "size" : 5,
    "totalElements" : 50,
    "totalPages" : 10,
    "number" : 0
  }
}

在顶部,我们可以看到_links:spring-doc.cadn.net.cn

1 selfLink 为整个集合提供一些选项。
2 nextlink 指向下一页,假定页面大小相同。
3 底部是有关页面设置的额外数据,包括页面大小、元素总数、页面总数以及您当前正在查看的页码。
使用curl在命令行中,如果您的语句中有 & () ,则需要将整个 URI 括在引号中。&

请注意,selfnextURI 实际上是 URI 模板。他们不仅接受size,而且还pagesort作为可选标志。spring-doc.cadn.net.cn

如前所述,HAL 文档的底部包含有关页面的详细信息集合。这些额外信息使您可以轻松配置滑块或指示器等 UI 工具,以反映用户查看数据时的总体位置。例如,前面示例中的文档显示我们正在查看第一页(页码从 0 开始)。spring-doc.cadn.net.cn

以下示例显示了当我们遵循next链接:spring-doc.cadn.net.cn

$ curl "http://localhost:8080/persons?page=1&size=5"
{
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/persons{&sort,projection,page,size}",
      "templated" : true
    },
    "next" : {
      "href" : "http://localhost:8080/persons?page=2&size=5{&sort,projection}", (1)
      "templated" : true
    },
    "prev" : {
      "href" : "http://localhost:8080/persons?page=0&size=5{&sort,projection}", (2)
      "templated" : true
    }
  },
  "_embedded" : {
	... data ...
  },
  "page" : {
    "size" : 5,
    "totalElements" : 50,
    "totalPages" : 10,
    "number" : 1 (3)
  }
}

这看起来非常相似,但有以下差异:spring-doc.cadn.net.cn

1 next链接现在指向另一个页面,指示其相对于self链接。
2 一个prev链接,为我们提供了指向上一页的路径。
3 当前数字现在是 1(表示第二页)。

此功能允许您将屏幕上的可选按钮映射到这些超媒体控件,从而允许您实现 UI 体验的导航功能,而不必对 URI 进行硬编码。事实上,用户可以从页面大小列表中进行选择,动态更改提供的内容,而无需重写next和 'prev 控件。spring-doc.cadn.net.cn

排序

Spring Data REST 识别使用存储库排序支持的排序参数。spring-doc.cadn.net.cn

要按特定属性对结果进行排序,请添加sortURL 参数,其中包含要对结果进行排序的属性的名称。您可以通过在邮件中附加逗号 (,) 添加到属性名称中,再加上ascdesc.下面将使用findByNameStartsWithquery 方法定义在PersonRepository为了所有人Person名称以字母“K”开头的实体,并添加排序数据,以对nameproperty 的 Sequence 按降序排列:spring-doc.cadn.net.cn

curl -v "http://localhost:8080/people/search/nameStartsWith?name=K&sort=name,desc"

要按多个属性对结果进行排序,请继续添加尽可能多的sort=PROPERTY参数。它们被添加到Pageable按它们在查询字符串中的显示顺序排列。结果可以按顶级属性和嵌套属性排序。使用属性路径表示法来表示嵌套的排序属性。不支持按可链接关联(即指向顶级资源的链接)排序。spring-doc.cadn.net.cn


APP信息