分页page_Spring中的REST分页

本文将介绍在REST API中实现分页的基础知识。我们将专注于使用Spring Boot和Spring Data 在Spring MVC中构建REST分页。

分页是一种处理大结果数据集的机制。在REST API中实现分页并没有什么不同&＃xff0c;但需要一些额外的思考过程。为REST API提供流畅有效的分页可以增加用户体验并有助于构建高效&＃xff0c;快速的REST API。我们使用Spring Boot作为示例。

在我们开始设计分页API之前&＃xff0c;我们需要清楚地了解页面作为资源或资源的表示。我们需要记住许多基本要素

一个页面Page不是REST中的一个资源&＃xff0c;而是其请求的属性。

以资源名称Product为构建分页的例子&＃xff0c;在高层次上我们确实有以下三个选项来构建分页。

• 将产品Product作为资源并使用查询字符串来处理分页以及其他参数&＃xff0c;例如排序等。
• 第二个选项是将页面Page用作资源和查询字符串进行排序。
• 使用页面Page作为资源和URL部分进行排序。

考虑到上述问题&＃xff0c;让我们尝试回答一些在设计REST API分页时有用的问题。

• 您是否将页面Page视为页面中产品的资源?

请记住&＃xff0c;REST API不是围绕任何预定义的规则或规范构建的&＃xff0c;所有上述三个选项都是有效的&＃xff0c;并且基于上述问题的答案。如果我们将页面视为资源&＃xff0c;则选项3是有效选择&＃xff1b;但如果我们说页面上的产品是资源&＃xff0c;那么选项3不再有效(在第1,2页上的产品可能会在将来更改)&＃xff0c;就个人而言&＃xff0c;我会选择选项1&＃xff0c;因为对我来说&＃xff0c;页面 Page 不是 资源Resouce&＃xff0c;它是请求的属性。

可发现性 有助于使 RESTful API 更加实用和优雅。使REST API 可被发现经常被忽视。以下是REST API可发现性的高级摘要 。

• 有了这个功能&＃xff0c;REST API在对客户端的响应中提供完整的URI意味着没有客户端需要“组合”URI。
• 客户端API独立于URI结构。
• 通过以上2点&＃xff0c;API更加灵活&＃xff0c;允许开发人员在不破坏API的情况下更改URI架构。(请记住&＃xff0c;API提供所有URI&＃xff0c;它们不是由客户端API动态创建的)。

可发现性与REST API中的HATEOAS密切相关。REST API分页可发现将通过"next"&＃xff0c;"previous"&＃xff0c;"first"和"last"链路作为响应数据的一部分。我们正在考虑如何在分页期间将此功能添加到您的API。

在构建REST API分页界面时&＃xff0c;让我们快速介绍一些要点。

3.1 限制limit

限制允许API和客户端控制结果集中请求的结果数。通过传递 limit 参数&＃xff0c;您可以指定每个页面要返回的项目数.API可以配置默认限制&＃xff0c;但应允许客户端指定限制。

在上面的请求中&＃xff0c;客户端将限制设置为50.小心&＃xff0c;同时允许客户将limit 参数设置 &＃xff0c; 设置为极高数量的限制会降低API性能。建议在API设计期间具有最大允许限制。

3.2排序

排序总是与搜索和分页并排。在设计REST API时&＃xff0c;提供灵活性&＃xff0c;让客户指定排序选项&＃xff0c;同时从API返回结果。建议在设计API时使用 sort_by &＃61; [attribute name] - [asc / desc]模式.API设计器应将允许的属性名称指定为sort参数。例如&＃xff0c;您可以使用?name-asc按产品名称排序或?name-desc反向排序。

我们在Spring中处理REST分页时介绍了所有基本内容。我们在这篇文章中使用了以下技术堆栈&＃xff0c;但它可以在任何其他技术上实现&＃xff0c;前提是您在设计时遵循所有基本原则。

• Spring Boot
• JPA.
• Spring Data REST

在本文中使用Spring Data REST的原因之一是Data REST API支持的开箱即用功能。

我们将在pom.xml中添加以下依赖项

1. Spring Boot JPA
2. Spring Boot Data REST
3. HATEOS和Web

org.springframework.boot

spring-boot-starter-data-jpa

org.springframework.boot

spring-boot-starter-data-rest

org.springframework.boot

spring-boot-starter-hateoas

org.springframework.boot

spring-boot-starter-web

org.hsqldb

hsqldb

runtime

4.1 REST控制器:

&＃64;RestController

public class ProductRESTController {

&＃64;Autowired

private ProductService productService;

&＃64;Autowired private EntityLinks links;

&＃64;GetMapping(value &＃61; "/products