Java 中怎么在 REST 接口中处理分页与排序参数

陌浩吖_8238

陌浩吖_8238

2026-10-23

597人浏览

原创

java rest分页排序核心是解析page/size/sort参数并转为pageable或sort,spring data jpa自动绑定pageable,mybatis常用pagehelper实现物理分页,响应须返回完整分页元数据。

java 中怎么在 rest 接口中处理分页与排序参数

Java 中处理 REST 接口的分页与排序参数,核心是解析请求中的查询参数(如 page、size、sort),转换为标准的数据访问逻辑,并与 Spring Data JPA 或 MyBatis 等持久层协同工作。关键不在于手动拼 SQL,而在于利用框架能力做标准化适配。

使用 Spring Data JPA 的 Pageable 自动绑定

Spring MVC 能自动将 URL 参数映射为 Pageable 对象,前提是参数名符合约定(或显式声明):

  • 默认支持 page(从 0 开始)、size、sort=property,asc/desc(如 ?sort=name,desc&sort=age,asc)
  • 控制器方法直接接收:
    public ResponseEntity<page>> getUsers(Pageable pageable)</page>
  • Service 层调用 JPA Repository 的 findAll(Pageable) 即可返回带分页元数据的 Page
  • 若需自定义参数名(如用 pageNum 和 pageSize),可用 @PageableDefault 或 @ParameterObject 配合 PageRequest.of() 手动构建

手动解析并构造 Sort 对象(兼容非标准参数)

当前端传参格式不统一(如 orderBy=name&orderDirection=desc),需手动组装 Sort:

  • 提取字符串参数:@RequestParam String orderBy 和 @RequestParam(defaultValue = "asc") String orderDirection
  • 校验字段合法性(防止注入):只允许白名单字段(如 "name", "email", "createdAt")
  • 构建排序:
    Sort sort = Sort.by(Sort.Direction.fromString(orderDirection), orderBy);
  • 再组合成 Pageable:
    Pageable pageable = PageRequest.of(pageNum, pageSize, sort);

响应中正确返回分页元数据

不要只返回数据列表,要包含总条数、当前页、页大小等信息,方便前端分页控件渲染:

  • 使用 Page<t></t> 作为返回值类型,Spring Boot 会自动序列化为 JSON,含 content、totalElements、totalPages、number、size 等字段
  • 避免手动 new ArrayList() + 计数 —— 这会丢失分页上下文,且无法支持 isFirst()/hasNext() 等语义
  • 如需自定义响应结构(如统一包一层 {"code":200,"data":{...}}),可封装 Page 到 DTO,但别丢掉关键分页字段

MyBatis 场景下的分页处理(如用 PageHelper)

MyBatis 本身不内置分页,常用 PageHelper 插件实现物理分页:

  • Maven 引入 pagehelper-spring-boot-starter
  • Controller 中解析参数后,调用 PageHelper.startPage(pageNum, pageSize, orderBy + " " + orderDirection)
  • 紧接着执行 Mapper 查询(必须紧邻!),插件会自动拦截 SQL 加上 LIMIT/OFFSET 或 ROWNUM
  • 用 PageHelper.getPage() 获取 PageInfo 对象,它包含 list、total、pageNum 等字段
  • 注意:务必校验 pageNum > 0、pageSize 合理(如 ≤ 100),防止恶意拉取全表

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

10997

6

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

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

2023.07.05

8102

9

java自学难吗
java自学难吗

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

2023.07.31

7032

8

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

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

2023.08.01

1184

3

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

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

2023.08.02

968

3

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

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

2023.08.02

1416

5

java有什么用
java有什么用

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

2023.08.02

2889

5

java在线网站
java在线网站

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

2023.08.03

20171

3

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

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

2023.08.03

1275

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习