跳转到主要内容

什么是分页

Laravel 的分页与查询构造器和 Eloquent ORM 无缝集成,开箱即用。当前页会自动从 HTTP 请求的 page 查询参数读取,并自动附加到生成的链接中。 默认的 HTML 支持 Tailwind CSS,也可以选择 Bootstrap CSS。

三种分页方式

基本用法

查询构造器分页

Eloquent 分页

simplePaginate

如果不需要 COUNT(*)(只显示上一页/下一页),使用 simplePaginate() 更高效。
如果不需要“共 N 条,当前 M 条”这类展示,就选 simplePaginate()paginate() 会额外执行一次 COUNT(*)simplePaginate() 更快。

cursorPaginate(游标分页)

游标分页使用 WHERE 子句代替 OFFSET,在大量数据下性能更好,尤其适合无限滚动的 UI。
生成的 URL 中不再是页码,而是一段游标字符串。
使用游标分页时必须指定 orderBy。另外用于排序的列必须属于被分页的表。

OFFSET 与游标的对比

游标分页可以充分利用索引,即便数据频繁增删也不容易出现记录重复或遗漏。缺点是无法生成页码链接,只有上一页/下一页。

控制器中的用法

在 Blade 中显示分页链接

links() 方法会自动生成分页链接 HTML。默认会显示当前页前后各 3 页的链接。

调整两侧显示的链接数

onEachSide() 用来指定当前页两侧显示的链接数量。

从请求获取每页条数

同页展示多个分页器

若同一页面上有两个分页器,两个都用 page 参数会互相冲突。可以通过第三个参数改名。

URL 自定义

修改基础 URL

追加查询参数

添加 hash 片段

API 响应(JSON 输出)

从路由或控制器直接返回分页器时,会自动转换为 JSON。
响应的 JSON 结构:

与 API 资源组合

要用 API 资源集合包装 paginate() 的结果,可以传给 UserResource::collection()
把分页器传给 UserResource::collection() 后,分页信息会作为元数据自动附加。
cursorPaginate() 的 JSON 中不会有页码,而是 next_cursorprev_cursor。API 客户端应使用它们作为下一次请求的 cursor 参数。

自定义分页视图

视图文件直接指定

修改默认视图为自定义文件

先发布官方视图再进行定制。
resources/views/vendor/pagination/ 下会生成以下文件:
  • tailwind.blade.php — 默认(Tailwind CSS)
  • bootstrap-5.blade.php — Bootstrap 5
  • simple-tailwind.blade.php — simplePaginate 用
你可以直接修改 tailwind.blade.php,也可以新建视图并在 AppServiceProvider 中指定。

使用 Bootstrap CSS

若使用 Bootstrap 而非 Tailwind,可以在 AppServiceProviderboot() 中指定。

手动创建分页器

对数组等现有数据做分页时,可以直接实例化分页器类。

常用实例方法

小结

  • paginate() — 需要总条数和页码链接(常见列表页)
  • simplePaginate() — 只需要上一页/下一页链接(更快)
  • cursorPaginate() — 大数据量、无限滚动、高频写入(性能最好)
paginate() 的结果传给视图,用 links() 输出分页链接即可。 当前页会自动从 page 查询参数读取。
从路由直接返回分页器会自动转 JSON。 与 API 资源结合时,返回 UserResource::collection($paginator)。 响应中包含 data(记录数组)以及各种元信息。
最后修改于 2026年7月18日