Spring Boot REST接口开发怎么返回分页数据

浅雪大大_7993

浅雪大大_7993

2026-11-13

609人浏览

原创

在spring boot rest接口中返回分页数据,最标准的做法是结合使用spring data jpa的pageable参数与page或pageimpl对象。通过让控制器方法接收pageable实例,框架会自动解析前端传来的页码、大小等参数并执行查询,最终返回包含当前页数据列表及总页数、总记录数等元数据的page对象,直接序列化为json即可。

Spring Boot REST接口开发怎么返回分页数据

如何配置Controller以接收分页请求参数

要实现自动分页,只需在@RestController的方法签名中添加Pageable类型的参数,并配合Sort处理排序。Spring MVC会自动将URL中的page(默认0)、size(默认20)和sort参数绑定到该对象中。开发者无需手动编写SQL的分页逻辑,底层JPA实现会根据Pageable生成对应的limit和offset语句。

Spring Boot REST接口开发怎么返回分页数据

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ArticleController {
    private final ArticleService articleService;

    public ArticleController(ArticleService articleService) {
        this.articleService = articleService;
    }

    @GetMapping("/articles")
    public Page<article> getArticles(Pageable pageable) {
        // 调用Service层,传入Pageable
        return articleService.findAll(pageable);
    }
}</article>

上述代码中,getArticles方法直接返回Page

。当请求/articles?page=0&size=5时,Spring会创建Pageable对象,传递给Service,Service再传递给Repository。Repository执行查询后返回Page对象,Spring HTTP Message Converter将其转换为JSON响应。

如何自定义分页响应的数据结构

虽然Page对象提供了丰富的元数据,但有时业务需要更简洁或特定的JSON结构,例如将内容包裹在统一的data字段中,或者重命名字段。此时可以使用PageImpl手动构建分页对象,或者使用DTO映射。推荐使用PageImpl包装查询结果,以便灵活控制返回的JSON格式,同时保持分页元数据的完整性。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

Spring Boot REST接口开发怎么返回分页数据

import org.springframework.data.domain.PageImpl;
import org.springframework.data.domain.Pageable;
import java.util.List;

public class CustomPageResponse {
    private List<article> content;
    private int page;
    private int size;
    private long totalElements;
    private int totalPages;

    // Getters and Setters
}

// In Service or Controller:
List<article> content = articleRepo.findByStatus("PUBLISHED");
long total = articleRepo.countByStatus("PUBLISHED");
Page<article> page = new PageImpl(content, pageable, total);</article></article></article>

通过new PageImpl(content, pageable, total),开发者可以精确控制分页数据。即使查询不是通过JPA的findAll(Pageable)进行的,也可以手动计算总数并封装。这样返回的JSON结构依然符合RESTful分页的标准约定,前端可以轻松解析出content数组和分页导航信息。

基于Page对象中totalElements的具体问题

在使用Page对象时,一个常见的问题是totalElements的计算开销。对于大数据量,每次分页都执行count查询可能影响性能。可以通过配置JPA的SimplePageRequest或使用Slice来避免不必要的总数统计。如果不需要总页数,只关心是否有下一页,应改用Slice接口,它只返回当前切片数据和是否有下一片的信息,而不执行COUNT查询。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

12517

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

9602

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

8172

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1324

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1048

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1576

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3289

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20511

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1415

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习