数据库：分页

简介
基本用法
显示分页结果
- 调整分页链接窗口
- 将结果转换为 JSON
自定义分页视图
- 使用 Bootstrap
Paginator 和 LengthAwarePaginator 实例方法
游标分页器实例方法

简介

在其他框架中，分页可能非常痛苦。我们希望 Laravel 的分页方式能让人耳目一新。Laravel 的分页器与查询构建器和 Eloquent ORM 集成，无需任何配置即可方便、易用地对数据库记录进行分页。

默认情况下，分页器生成的 HTML 与 Tailwind CSS 框架兼容；不过，也支持 Bootstrap 分页。

Tailwind

如果您在使用 Tailwind 4.x 的同时使用 Laravel 的默认 Tailwind 分页视图，应用程序的 resources/css/app.css 文件将已经正确配置，以便 @source 引用 Laravel 的分页视图。

1@import 'tailwindcss';
2 
3@source '../../vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php';

@import 'tailwindcss';

@source '../../vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php';

基本用法

分页查询构建器结果

有几种方法可以对条目进行分页。最简单的方法是在查询构建器或 Eloquent 查询上使用 paginate 方法。paginate 方法会自动根据用户当前查看的页面来设置查询的 “limit” 和 “offset”。默认情况下，当前页面是通过 HTTP 请求中的 page 查询字符串参数的值来检测的。Laravel 会自动检测该值，并将其自动插入到分页器生成的链接中。

在本例中，传递给 paginate 方法的唯一参数是您希望“每页”显示的条目数。在此例中，我们指定希望每页显示 15 条记录。

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Support\Facades\DB;
 6use Illuminate\View\View;
 7 
 8class UserController extends Controller
 9{
10    /**
11     * Show all application users.
12     */
13    public function index(): View
14    {
15        return view('user.index', [
16            'users' => DB::table('users')->paginate(15)
17        ]);
18    }
19}

<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\DB;
use Illuminate\View\View;

class UserController extends Controller
{
    /**
     * Show all application users.
     */
    public function index(): View
    {
        return view('user.index', [
            'users' => DB::table('users')->paginate(15)
        ]);
    }
}

简单分页

paginate 方法在从数据库检索记录之前，会先计算查询匹配的记录总数。这样做是为了让分页器知道总共有多少页记录。但是，如果您不打算在应用程序的 UI 中显示总页数，那么记录计数查询就是不必要的。

因此，如果您只需要在应用程序 UI 中显示简单的“下一页”和“上一页”链接，可以使用 simplePaginate 方法来执行单次、高效的查询。

1$users = DB::table('users')->simplePaginate(15);

$users = DB::table('users')->simplePaginate(15);

分页 Eloquent 结果

您也可以对 Eloquent 查询进行分页。在此例中，我们将对 App\Models\User 模型进行分页，并指定每页显示 15 条记录。正如您所见，其语法与查询构建器的分页结果几乎完全相同。

1use App\Models\User;
2 
3$users = User::paginate(15);

use App\Models\User;

$users = User::paginate(15);

当然，您也可以在设置查询的其他约束（例如 where 子句）之后调用 paginate 方法。

1$users = User::where('votes', '>', 100)->paginate(15);

$users = User::where('votes', '>', 100)->paginate(15);

您也可以在对 Eloquent 模型进行分页时使用 simplePaginate 方法。

1$users = User::where('votes', '>', 100)->simplePaginate(15);

$users = User::where('votes', '>', 100)->simplePaginate(15);

同样，您可以使用 cursorPaginate 方法对 Eloquent 模型进行游标分页。

1$users = User::where('votes', '>', 100)->cursorPaginate(15);

$users = User::where('votes', '>', 100)->cursorPaginate(15);

每页多个分页器实例

有时，您可能需要在应用程序渲染的单个屏幕上渲染两个独立的分页器。但是，如果两个分页器实例都使用 page 查询字符串参数来存储当前页面，则会导致冲突。为了解决此冲突，您可以通过 paginate、simplePaginate 和 cursorPaginate 方法的第三个参数，传递您希望用于存储分页器当前页面的查询字符串参数名称。

1use App\Models\User;
2 
3$users = User::where('votes', '>', 100)->paginate(
4    $perPage = 15, $columns = ['*'], $pageName = 'users'
5);

use App\Models\User;

$users = User::where('votes', '>', 100)->paginate(
    $perPage = 15, $columns = ['*'], $pageName = 'users'
);

游标分页

虽然 paginate 和 simplePaginate 使用 SQL “offset” 子句创建查询，但游标分页的工作原理是构建“where”子句来比较查询中包含的排序字段值，这在所有 Laravel 分页方法中提供了最高效的数据库性能。这种分页方法特别适用于大数据集和“无限滚动”用户界面。

与基于 offset 的分页不同（它在分页器生成的 URL 查询字符串中包含页码），基于游标的分页会在查询字符串中放置一个“游标”字符串。游标是一个编码字符串，包含下一次分页查询应开始的位置以及应分页的方向。

1https:///users?cursor=eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0

https:///users?cursor=eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0

您可以通过查询构建器提供的 cursorPaginate 方法创建一个基于游标的分页器实例。该方法返回 Illuminate\Pagination\CursorPaginator 的实例。

1$users = DB::table('users')->orderBy('id')->cursorPaginate(15);

$users = DB::table('users')->orderBy('id')->cursorPaginate(15);

一旦获得了游标分页器实例，您就可以像通常使用 paginate 和 simplePaginate 方法一样显示分页结果。有关游标分页器提供的实例方法的更多信息，请查阅游标分页器实例方法文档。

您的查询必须包含 “order by” 子句才能利用游标分页。此外，查询排序所依据的列必须属于您正在分页的表。

游标分页与 Offset 分页的对比

为了说明 offset 分页和游标分页之间的差异，让我们检查一些 SQL 查询示例。以下两个查询都将显示按 id 排序的 users 表的“第二页”结果。

1# Offset Pagination...
2select * from users order by id asc limit 15 offset 15;
3 
4# Cursor Pagination...
5select * from users where id > 15 order by id asc limit 15;

# Offset Pagination...
select * from users order by id asc limit 15 offset 15;

# Cursor Pagination...
select * from users where id > 15 order by id asc limit 15;

与 offset 分页相比，游标分页查询具有以下优势：

对于大数据集，如果 “order by” 列被索引，游标分页将提供更好的性能。这是因为 “offset” 子句需要扫描所有之前匹配的数据。
对于频繁写入的数据集，如果结果刚被添加或从用户当前查看的页面中删除，offset 分页可能会跳过记录或显示重复记录。

但是，游标分页有以下限制：

与 simplePaginate 一样，游标分页只能用于显示“下一页”和“上一页”链接，不支持生成带有页码的链接。
它要求排序基于至少一个唯一列或唯一列的组合。不支持包含 null 值的列。
只有在“order by”子句中的查询表达式被别名化并同时添加到“select”子句中时，才支持这些表达式。
不支持带有参数的查询表达式。

手动创建分页器

有时，您可能希望手动创建一个分页实例，并将内存中已有的数组项传递给它。您可以根据需要创建一个 Illuminate\Pagination\Paginator、Illuminate\Pagination\LengthAwarePaginator 或 Illuminate\Pagination\CursorPaginator 实例。

Paginator 和 CursorPaginator 类不需要知道结果集中的总项数；因此，这些类没有用于检索最后一页索引的方法。LengthAwarePaginator 接受的参数与 Paginator 几乎相同；但它需要结果集中总项数的计数。

换句话说，Paginator 对应于查询构建器上的 simplePaginate 方法，CursorPaginator 对应于 cursorPaginate 方法，而 LengthAwarePaginator 对应于 paginate 方法。

手动创建分页器实例时，您应该手动“切片”传递给分页器的结果数组。如果您不确定如何执行此操作，请查看 PHP 的 array_slice 函数。

自定义分页 URL

默认情况下，分页器生成的链接将匹配当前请求的 URI。但是，分页器的 withPath 方法允许您自定义生成链接时分页器使用的 URI。例如，如果您希望分页器生成类似于 http://example.com/admin/users?page=N 的链接，则应将 /admin/users 传递给 withPath 方法。

1use App\Models\User;
2 
3Route::get('/users', function () {
4    $users = User::paginate(15);
5 
6    $users->withPath('/admin/users');
7 
8    // ...
9});

use App\Models\User;

Route::get('/users', function () {
    $users = User::paginate(15);

    $users->withPath('/admin/users');

    // ...
});

追加查询字符串值

您可以使用 appends 方法追加到分页链接的查询字符串中。例如，要将 sort=votes 追加到每个分页链接，您应该进行以下 appends 调用：

1use App\Models\User;
2 
3Route::get('/users', function () {
4    $users = User::paginate(15);
5 
6    $users->appends(['sort' => 'votes']);
7 
8    // ...
9});

use App\Models\User;

Route::get('/users', function () {
    $users = User::paginate(15);

    $users->appends(['sort' => 'votes']);

    // ...
});

如果您希望将当前请求的所有查询字符串值追加到分页链接，可以使用 withQueryString 方法。

1$users = User::paginate(15)->withQueryString();

$users = User::paginate(15)->withQueryString();

追加哈希片段

如果您需要将“哈希片段”追加到分页器生成的 URL 中，可以使用 fragment 方法。例如，要将 #users 追加到每个分页链接的末尾，您应该这样调用 fragment 方法：

1$users = User::paginate(15)->fragment('users');

$users = User::paginate(15)->fragment('users');

调用 paginate 方法时，您将获得 Illuminate\Pagination\LengthAwarePaginator 的实例，而调用 simplePaginate 方法会返回 Illuminate\Pagination\Paginator 的实例。最后，调用 cursorPaginate 方法会返回 Illuminate\Pagination\CursorPaginator 的实例。

这些对象提供了几种描述结果集的方法。除了这些辅助方法之外，分页器实例还是迭代器，可以像数组一样循环。因此，一旦检索到结果，您就可以使用 Blade 显示结果并渲染页面链接。

1<div class="container">
2    @foreach ($users as $user)
3        {{ $user->name }}
4    @endforeach
5</div>
6 
7{{ $users->links() }}

<div class="container">
    @foreach ($users as $user)
        {{ $user->name }}
    @endforeach
</div>

{{ $users->links() }}

links 方法将渲染结果集中其余页面的链接。这些链接中的每一个都将已经包含正确的 page 查询字符串变量。请记住，links 方法生成的 HTML 与 Tailwind CSS 框架兼容。

调整分页链接窗口

当分页器显示分页链接时，会显示当前页码以及当前页面前后三页的链接。使用 onEachSide 方法，您可以控制分页器生成的中间滑动链接窗口中，当前页面每一侧显示多少个附加链接。

1{{ $users->onEachSide(5)->links() }}

{{ $users->onEachSide(5)->links() }}

将结果转换为 JSON

Laravel 分页器类实现了 Illuminate\Contracts\Support\Jsonable 契约接口并公开了 toJson 方法，因此将分页结果转换为 JSON 非常容易。您也可以通过从路由或控制器动作中返回分页器实例，将其转换为 JSON。

1use App\Models\User;
2 
3Route::get('/users', function () {
4    return User::paginate();
5});

use App\Models\User;

Route::get('/users', function () {
    return User::paginate();
});

来自分页器的 JSON 将包含诸如 total、current_page、last_page 等元信息。结果记录可通过 JSON 数组中的 data 键获得。以下是从路由返回分页器实例所创建的 JSON 示例：

 1{
 2   "total": 50,
 3   "per_page": 15,
 4   "current_page": 1,
 5   "last_page": 4,
 6   "current_page_url": "http://laravel.app?page=1",
 7   "first_page_url": "http://laravel.app?page=1",
 8   "last_page_url": "http://laravel.app?page=4",
 9   "next_page_url": "http://laravel.app?page=2",
10   "prev_page_url": null,
11   "path": "http://laravel.app",
12   "from": 1,
13   "to": 15,
14   "data":[
15        {
16            // Record...
17        },
18        {
19            // Record...
20        }
21   ]
22}

{
   "total": 50,
   "per_page": 15,
   "current_page": 1,
   "last_page": 4,
   "current_page_url": "http://laravel.app?page=1",
   "first_page_url": "http://laravel.app?page=1",
   "last_page_url": "http://laravel.app?page=4",
   "next_page_url": "http://laravel.app?page=2",
   "prev_page_url": null,
   "path": "http://laravel.app",
   "from": 1,
   "to": 15,
   "data":[
        {
            // Record...
        },
        {
            // Record...
        }
   ]
}

自定义分页视图

默认情况下，用于显示分页链接的视图与 Tailwind CSS 框架兼容。但是，如果您不使用 Tailwind，可以自由定义自己的视图来渲染这些链接。在分页器实例上调用 links 方法时，您可以将视图名称作为第一个参数传递给该方法。

1{{ $paginator->links('view.name') }}
2 
3<!-- Passing additional data to the view... -->
4{{ $paginator->links('view.name', ['foo' => 'bar']) }}

{{ $paginator->links('view.name') }}

<!-- Passing additional data to the view... -->
{{ $paginator->links('view.name', ['foo' => 'bar']) }}

不过，自定义分页视图最简单的方法是使用 vendor:publish 命令将其导出到您的 resources/views/vendor 目录。

1php artisan vendor:publish --tag=laravel-pagination

php artisan vendor:publish --tag=laravel-pagination

此命令将把视图放入应用程序的 resources/views/vendor/pagination 目录中。该目录中的 tailwind.blade.php 文件对应于默认的分页视图。您可以编辑此文件以修改分页 HTML。

如果您想指定另一个文件作为默认分页视图，可以在 App\Providers\AppServiceProvider 类的 boot 方法中调用分页器的 defaultView 和 defaultSimpleView 方法。

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use Illuminate\Pagination\Paginator;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class AppServiceProvider extends ServiceProvider
 9{
10    /**
11     * Bootstrap any application services.
12     */
13    public function boot(): void
14    {
15        Paginator::defaultView('view-name');
16 
17        Paginator::defaultSimpleView('view-name');
18    }
19}

<?php

namespace App\Providers;

use Illuminate\Pagination\Paginator;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Paginator::defaultView('view-name');

        Paginator::defaultSimpleView('view-name');
    }
}

使用 Bootstrap

Laravel 包含了使用 Bootstrap CSS 构建的分页视图。要使用这些视图而不是默认的 Tailwind 视图，您可以在 App\Providers\AppServiceProvider 类的 boot 方法中调用分页器的 useBootstrapFour 或 useBootstrapFive 方法。

 1use Illuminate\Pagination\Paginator;
 2 
 3/**
 4 * Bootstrap any application services.
 5 */
 6public function boot(): void
 7{
 8    Paginator::useBootstrapFive();
 9    Paginator::useBootstrapFour();
10}

use Illuminate\Pagination\Paginator;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Paginator::useBootstrapFive();
    Paginator::useBootstrapFour();
}

Paginator / LengthAwarePaginator 实例方法

每个分页器实例通过以下方法提供额外的信息：

方法	描述
`$paginator->count()`	获取当前页面的条目数。
`$paginator->currentPage()`	获取当前页码。
`$paginator->firstItem()`	获取结果中第一项的结果编号。
`$paginator->getOptions()`	获取分页器选项。
`$paginator->getUrlRange($start, $end)`	创建一系列分页 URL。
`$paginator->hasPages()`	确定是否有足够的条目可以拆分为多个页面。
`$paginator->hasMorePages()`	确定数据存储中是否有更多条目。
`$paginator->items()`	获取当前页面的条目。
`$paginator->lastItem()`	获取结果中最后一项的结果编号。
`$paginator->lastPage()`	获取最后一页的页码。（使用 `simplePaginate` 时不可用）。
`$paginator->nextPageUrl()`	获取下一页的 URL。
`$paginator->onFirstPage()`	确定分页器是否在第一页。
`$paginator->onLastPage()`	确定分页器是否在最后一页。
`$paginator->perPage()`	每页显示的条目数。
`$paginator->previousPageUrl()`	获取上一页的 URL。
`$paginator->total()`	确定数据存储中匹配条目的总数。（使用 `simplePaginate` 时不可用）。
`$paginator->url($page)`	获取指定页码的 URL。
`$paginator->getPageName()`	获取用于存储页码的查询字符串变量。
`$paginator->setPageName($name)`	设置用于存储页码的查询字符串变量。
`$paginator->through($callback)`	使用回调函数转换每一项。

游标分页器实例方法

每个游标分页器实例通过以下方法提供额外信息：

方法	描述
`$paginator->count()`	获取当前页面的条目数。
`$paginator->cursor()`	获取当前游标实例。
`$paginator->getOptions()`	获取分页器选项。
`$paginator->hasPages()`	确定是否有足够的条目可以拆分为多个页面。
`$paginator->hasMorePages()`	确定数据存储中是否有更多条目。
`$paginator->getCursorName()`	获取用于存储游标的查询字符串变量。
`$paginator->items()`	获取当前页面的条目。
`$paginator->nextCursor()`	获取下一组条目的游标实例。
`$paginator->nextPageUrl()`	获取下一页的 URL。
`$paginator->onFirstPage()`	确定分页器是否在第一页。
`$paginator->onLastPage()`	确定分页器是否在最后一页。
`$paginator->perPage()`	每页显示的条目数。
`$paginator->previousCursor()`	获取上一组条目的游标实例。
`$paginator->previousPageUrl()`	获取上一页的 URL。
`$paginator->setCursorName()`	设置用于存储游标的查询字符串变量。
`$paginator->url($cursor)`	获取给定游标实例的 URL。

数据库：分页

简介

Tailwind

基本用法

分页查询构建器结果

分页 Eloquent 结果

每页多个分页器实例

手动创建分页器

追加查询字符串值

追加哈希片段

将结果转换为 JSON

使用 Bootstrap

Paginator / LengthAwarePaginator 实例方法

游标分页器实例方法

在此页面上

产品

Packages

资源

合作伙伴