讲师中心 微信公众号
AI工具推荐 视频效率加速

Spring Boot 怎么实现基于 REST API 的分页查询规范 Pageable 与 Page

陌磊君_9951

陌磊君_9951

发布时间:2026-09-23 20:03:17

|

579人浏览过

|

来源于php中文网

原创

推荐使用Spring Data的Pageable和Page实现REST分页,自动绑定page、size、sort参数,返回含元数据的标准化JSON响应,并支持Specification动态查询与安全校验。

spring boot 怎么实现基于 rest api 的分页查询规范 pageable 与 page

Spring Boot 中基于 REST API 的分页查询,推荐直接使用 Spring Data 提供的 PageablePage,它天然支持标准 URL 参数(如 pagesizesort),无需手动解析,也便于前后端统一约定。

URL 参数自动绑定 Pageable

Spring MVC 能自动将请求参数映射为 Pageable 对象,只要控制器方法参数声明为 Pageable,并确保参数名符合默认规范:

  • page:页码(从 0 开始,默认 0)
  • size:每页条数(默认 20)
  • sort:排序字段,格式如 name,ascage,desc;支持多个,如 ?sort=name,asc&sort=age,desc

示例接口:

@GetMapping("/users")
public ResponseEntity<Page<User>> getUsers(Pageable pageable) {
    Page<User> page = userRepository.findAll(pageable);
    return ResponseEntity.ok(page);
}

调用示例:GET /users?page=1&size=10&sort=createdAt,desc → 第 2 页(0 起始)、每页 10 条、按创建时间降序。

自定义 Pageable 参数名(可选)

若需兼容已有前端习惯(如用 pageNumpageSize),可通过 @PageableDefault 或配置 PageableHandlerMethodArgumentResolver 实现。更简单的方式是显式接收参数再构建 Pageable

@GetMapping("/users")
public ResponseEntity<Page<User>> getUsers(
        @RequestParam(defaultValue = "1") int pageNum,
        @RequestParam(defaultValue = "10") int pageSize,
        @RequestParam(defaultValue = "id,desc") String sort) {
<pre class="brush:php;toolbar:false;">Sort.Direction direction = Sort.Direction.DESC;
String property = "id";
if (sort.contains(",")) {
    String[] parts = sort.split(",", 2);
    property = parts[0];
    direction = "asc".equalsIgnoreCase(parts[1]) ? Sort.Direction.ASC : Sort.Direction.DESC;
}
Pageable pageable = PageRequest.of(pageNum - 1, pageSize, Sort.by(direction, property));
return ResponseEntity.ok(userRepository.findAll(pageable));

}

注意:此时页码建议按 1 起始(更符合前端直觉),内部转为 0 起始传给 PageRequest.of()

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

响应结构标准化(返回 Page 的 JSON)

Page 对象序列化后自带分页元数据,例如:

{
  "content": [ /* 用户列表 */ ],
  "pageable": { "sort": { "sorted": true, ... }, "offset": 10, "pageNumber": 1, "pageSize": 10, ... },
  "last": false,
  "totalPages": 5,
  "totalElements": 47,
  "first": false,
  "numberOfElements": 10,
  "empty": false
}

该结构已包含全部分页上下文,前端可直接使用 totalElementstotalPagesfirst/last 等字段做 UI 控制。如需精简响应,可封装为自定义 DTO(如 PagedResponse<t></t>),只保留必要字段:datacurrentPagetotalItemstotalPageshasNexthasPrevious

配合 Specification 或自定义查询时的注意事项

若需动态条件分页(如带搜索),推荐使用 JpaSpecificationExecutor

public interface UserRepository extends JpaRepository<User, Long>, JpaSpecificationExecutor<User> { }

然后在 service 中组合条件:

Specification<User> spec = Specification.where(null);
if (StringUtils.hasText(name)) {
    spec = spec.and((root, query, cb) -> cb.like(root.get("name"), "%" + name + "%"));
}
Page<User> result = userRepository.findAll(spec, pageable);

注意:Spring Data 会自动为 Specification 查询添加分页 COUNT 和 LIMIT,无需额外处理。

不复杂但容易忽略的是参数校验和默认值控制——比如限制最大 size 防止恶意拉取全表,可在配置中全局设置:spring.data.web.pageable.max-page-size=100,或在代码中拦截校验。

热门AI工具

更多
LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

531

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

1395

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

4006

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

416

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

600

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

345

2026.02.11

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

331

2026.02.12

Spring Boot 项目开发与实战
Spring Boot 项目开发与实战

以 Spring Boot 为核心,讲解项目的快速初始化(Spring Initializr)、自动配置与 Starter 依赖原理、配置文件(application.yml)多环境管理、RESTful API 接口开发与参数校验、MyBatis / MyBatis-Plus / Spring Data JPA 数据持久层整合、Redis 缓存集成、统一异常处理与全局响应封装、Swagger / Knife4j 接口文档生成,以及 Ma

286

2026.04.17

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

0

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn