TP6接口分页列表接口的实现方法

陌墨酱_3202

陌墨酱_3202

2026-08-17

662人浏览

原创

TP6接口分页列表返回结构化JSON而非HTML,核心是提取paginate()实例的元信息(当前页、总页数、总数等)与数据组装为标准响应格式,并透传搜索参数以保障翻页条件不丢失。

tp6接口分页列表接口的实现方法

TP6 接口分页列表接口的核心是返回结构化 JSON 数据,而非 HTML 分页 HTML 字符串。它不调用 render(),而是提取分页元信息(当前页、总页数、总数、每页条数等),与数据一起组装为标准响应格式。

基础分页数据获取

在控制器中直接使用模型或 Db 的 paginate() 方法,传入每页数量即可:

  • $list = User::where('status', 1)->order('id', 'desc')->paginate(10);
  • 或使用 Db:$list = Db::name('user')->where('status', 1)->paginate(10);
  • 返回的是 Think\Paginator\driver\Bootstrap 实例(默认驱动),含数据 + 分页属性

提取分页元信息并构造 JSON 响应

需手动提取关键字段,避免直接输出 HTML。推荐统一返回结构如:

  • data:当前页数据列表($list->items())
  • current_page:当前页码($list->currentPage())
  • last_page:总页数($list->lastPage())
  • per_page:每页条数($list->listRows())
  • total:总记录数($list->total())
  • has_next_page:是否有下一页($list->hasMore())
  • has_prev_page:是否有上一页($list->currentPage() > 1)

示例返回代码:

Opera Neon
Opera Neon

Opera Neon是一款AI智能体工具,Opera推出的全新AI Agent浏览器。

下载
return json([
  'code' => 1,
  'msg' => 'success',
  'data' => $list->items(),
  'pagination' => [
    'current_page' => $list->currentPage(),
    'last_page' => $list->lastPage(),
    'per_page' => $list->listRows(),
    'total' => $list->total(),
    'has_next_page' => $list->hasMore(),
    'has_prev_page' => $list->currentPage() > 1
  ]
]);

保留搜索参数(带条件分页)

前端传来的查询参数(如 ?keyword=张&status=1)必须透传到下一页链接逻辑中,否则翻页后条件丢失。TP6 支持通过 'query' 配置项自动拼接:

  • ->paginate(['list_rows' => 10, 'query' => request()->param()])
  • 该配置不影响 JSON 接口本身,但确保 $list->render()(若后续需要 H5 分页)或前端生成下一页 URL 时能复用参数
  • 接口中建议将原始参数也返回给前端:'request_params' => request()->param(),方便前端维护 URL 状态

自定义分页驱动(可选,用于统一字段名或扩展)

如需全局替换分页字段名(例如把 current_page 改成 page),可继承默认分页类并重写 toArray() 或封装响应方法:

  • 新建 app/common/ApiPaginator.php,继承 think\paginator\driver\Bootstrap
  • 重写 toArray() 返回适配接口规范的数组结构
  • 控制器中改用:User::paginate(...)->toArray() 直接获得定制结构

相关文章

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

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

下载

相关标签:

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

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

2023.10.19

3208

3

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

2025.10.17

5169

12

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2025.12.29

3849

9

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

2026.01.19

486

15

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

60

16

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

2026.10.28

40

15

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

2026.10.28

140

10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

140

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

120

10

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习