Spring MVC 中的分页 RESTful API 响应

allway2

于 2022-12-02 13:05:21 发布

阅读量652

点赞数

文章标签： spring mvc restful

本文链接：https://blog.csdn.net/allway2/article/details/128146319

版权

分页允许您将来自Spring MVC的大型RESTful API响应拆分为称为页面的较小块。在这篇文章中，让我们看看如何使用Spring MVC和Spring JPA对来自Spring boot应用程序的JSON响应进行分页。

Spring MVC 中的分页和排序

如前所述，我们可以使用spring 数据 JPA 实现分页和排序。Spring MVC通过直接从Web层注入可分页对象将其提升到一个新的水平。

Spring MVC 允许您传递以下可选查询参数，以在请求范围内构建可分页对象。我们可以在 JPA 存储库方法中进一步使用这些可分页对象。因此，让我们看看如何实现它们。

为 Web 和 JPA 添加依赖关系

在本例中，我们使用 SpringData JPA 和 SpringWeb 组件作为依赖项。

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>

Code language: HTML, XML (xml)

编写可分页的 JPA 存储库方法

接下来，我们需要编写一个以页面形式返回数据库记录的存储库。我们已经在上一篇文章中详细介绍了如何编写和使用它们。在我们的例子中，我们使用的是Account类。

@Entity public class Account { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) Integer id; String accountNumber; String fullName; @JsonBackReference @ManyToOne Branch branch; BigDecimal balance; // getters and setters }

Code language: JavaScript (javascript)

public interface AccountRepository extends JpaRepository<Account, Integer> { @Query("select a from Account a") Page<Account> findAllAccounts(Pageable pageable); }

Code language: PHP (php)

We will use this JPA pagination implementation in our service to pass the pageable from the Spring MVC controller.

Write a Spring MVC controller with Pageable parameter

Next, we can write an AccountService and AccountController that uses the AccountRepository interface.

@Service public class AccountService { private final AccountRepository accountRepository; public AccountService(AccountRepository accountRepository) { this.accountRepository = accountRepository; } public Page<Account> getAccounts(Pageable pageable) { return accountRepository.findAllAccounts(pageable); } }

Code language: PHP (php)

Now the spring MVC controller class with pagination.

@RestController public class AccountController { private final AccountService accountService; public AccountController(AccountService accountService) { this.accountService = accountService; } @GetMapping("/accounts") Page<Account> getAccounts(Pageable pageable) { return accountService.getAccounts(pageable); } }

Code language: PHP (php)

如您所见，响应本身是一个Page对象。让我们运行应用程序，看看这个实现是如何工作的。