Hyperf 分页查询技巧:paginate 标准响应结构详解【实用技巧】

星明吖_9662

星明吖_9662

2026-08-06

535人浏览

原创

hyperf 的 paginate() 返回 hyperf\paginator\lengthawarepaginator 实例,含 current_page、last_page、per_page 等 laravel 风格字段,需 toarray() 转换并重映射为 page、pagesize、total 等前端兼容字段,且 appends() 必须在 toarray() 前调用。

hyperf 分页查询技巧:paginate 标准响应结构详解【实用技巧】

Hyperf 的 paginate() 返回什么结构?

它返回 Hyperf\Paginator\LengthAwarePaginator 实例,不是数组,也不是 JSON 字符串。直接 return $query->paginate(10) 会触发对象的 jsonSerialize(),输出字段名如 current_page、last_page、per_page —— 这些是 Laravel 风格命名,但和主流前端分页组件(如 Element Plus、Ant Design)默认期望的 page、pageSize、totalPage 不一致。

常见错误现象:

  • 前端调用 res.data.data 拿不到列表,实际是 res.data 就是整个分页对象
  • 点击页码后搜索参数丢失,因为 first_page_url 等链接没保留 query string
  • total 是总数,last_page 是总页数,别把 last_page 当成“最后一页的数据条数”

如何统一 API 响应格式?别直接 return paginate() 结果

Hyperf 默认不提供全局分页响应封装,必须手动组装。推荐在 Controller 层做一次转换,而不是依赖中间件或全局响应器 —— 因为分页元信息(如 total、page)需要和业务数据强绑定,中间件无法可靠提取。

实操建议:

  • 用 $paginator->toArray() 提取原始结构,再重键名:'page' => $arr['current_page']、'pageSize' => $arr['per_page']、'total' => $arr['total']
  • 补上 hasNext 和 hasPrev 布尔值($arr['next_page_url'] !== null),比前端自己算更可靠
  • 如果用了 appends(),必须在 toArray() 前调用,否则 URL 参数不会进 first_page_url 等字段

paginate() 的 page 参数怎么传才生效?

Hyperf 的 paginate() 默认只读 $_GET['page'],不识别 ?p=2 或 ?offset=20。这不是 bug,是设计选择 —— 它要求你显式控制,避免隐式行为导致调试困难。

Hyperframes Creative
Hyperframes Creative

HyperFrames视频非动画创意指导,包括设计规范(frame.md/design.md)处理、配色、字体设计、旁白及节奏规划等。

下载

两种安全做法:

  • 显式传参:$query->paginate(15, false, ['page' => $this->request->input('p', 1)]),第二个参数 false 表示不自动解析 GET
  • 改配置:在 config/autoload/pagination.php 中设 'var_page' => 'p',这样它就会读 $_GET['p']
  • 注意:如果同时用了 appends(),且 append 的 key 和 var_page 冲突(比如都叫 p),会导致 URL 参数重复

关联查询 + 分页时 total 为 0 怎么办?

常见于 User::with('profile')->paginate(10),结果 total 是 0,data 却有数据 —— 这是因为 Hyperf 在关联预加载下生成 COUNT SQL 时,可能因字段别名、表连接方式或子查询嵌套失败,fallback 到简单分页(LengthAwarePaginator 退化为 SimplePaginator)。

排查优先级:

  • 先去掉 with(),确认主表分页是否正常;如果正常,问题出在关联逻辑
  • 检查模型中是否定义了 $casts 或 $casts 引发的类型转换干扰(如把 id cast 成 string,COUNT 时出错)
  • 避免在 paginate() 前调用 selectRaw() 或 groupBy(),它们会让 COUNT 查询无法复用主查询结构

最稳的解法:用两次查询 —— 先 count() 得总数,再 forPage($page, $size)->get() 取数据,手动 new LengthAwarePaginator。虽然多一次查询,但可控性强,尤其适合复杂关联场景。

相关文章

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

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

下载

相关标签:

hyperf快速入门 hyperf

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

9944

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5921

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2075

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3688

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4394

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3451

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4897

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3842

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11802

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Hyperf官方中文手册(3.1)
Hyperf官方中文手册(3.1)

共0课时 | 0人学习

Swoole系列-从0到1-新手进阶
Swoole系列-从0到1-新手进阶

共29课时 | 2.3万人学习