介绍

在其他框架中，分页可能会非常痛苦。我们希望 Laravel 的分页方法能给您带来一股清新之风。Laravel 的分页器与查询构建器和Eloquent ORM集成，并提供了方便、易用的数据库记录分页功能，无需任何配置。

默认情况下，分页器生成的 HTML 与Tailwind CSS 框架 (opens in a new tab)兼容；然而，也支持 Bootstrap 分页。

Tailwind JIT

如果您正在使用 Laravel 默认的 Tailwind 分页视图和 Tailwind JIT 引擎，您应该确保您的应用程序的tailwind.config.js文件的content键引用了 Laravel 的分页视图，以便它们的 Tailwind 类不会被清除：

content: [
    './resources/**/*.blade.php',
    './resources/**/*.js',
    './resources/**/*.vue',
    './vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php',
],

基本用法

对查询构建器结果进行分页

有几种方法可以对项目进行分页。最简单的方法是在查询构建器或Eloquent 查询上使用paginate方法。paginate方法会根据用户正在查看的当前页面自动处理设置查询的“限制”和“偏移量”。默认情况下，当前页面是通过 HTTP 请求的page查询字符串参数的值来检测的。这个值会被 Laravel 自动检测到，并且也会自动插入到分页器生成的链接中。

在这个例子中，传递给paginate方法的唯一参数是您希望每页显示的项目数量。在这种情况下，我们指定我们希望每页显示15个项目：

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\DB;
use Illuminate\View\View;

class UserController extends Controller
{
    /**
     * 显示所有应用程序用户。
     */
    public function index(): View
    {
        return view('user.index', [
            'users' => DB::table('users')->paginate(15)
        ]);
    }
}

简单分页

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

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

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

对Eloquent结果进行分页

您也可以对Eloquent查询进行分页。在这个例子中，我们将对App\Models\User模型进行分页，并表示我们计划每页显示 15 条记录。如您所见，语法几乎与对查询构建器结果进行分页相同：

use App\Models\User;

$users = User::paginate(15);

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

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

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

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

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

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

每页多个分页器实例

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

use App\Models\User;

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

游标分页

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

与基于偏移量的分页不同，后者在分页器生成的 URL 的查询字符串中包含一个页码，基于游标的分页在查询字符串中放置一个“游标”字符串。游标是一个编码字符串，包含下一个分页查询应该开始分页的位置和它应该分页的方向：

http://localhost/users?cursor=eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0

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

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

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

[!警告]
您的查询必须包含一个“order by”子句，以便利用游标分页。此外，查询所排序的列必须属于您正在分页的表。

游标分页与偏移分页

为了说明偏移分页和游标分页之间的区别，让我们来查看一些示例 SQL 查询。以下两个查询都将为按 id 排序的 users 表显示“第二页”的结果：

# 偏移分页...
select * from users order by id asc limit 15 offset 15;
 
# 游标分页...
select * from users where id > 15 order by id asc limit 15;

与偏移分页相比，游标分页具有以下优点：

• 对于大型数据集，如果“order by”列已建立索引，游标分页将提供更好的性能。这是因为“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 方法。

[!WARNING]
当手动创建分页器实例时，您应该手动“切片”传递给分页器的结果数组。如果您不确定如何操作，请查看 array_slice (opens in a new tab) PHP 函数。

自定义分页 URL

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

use App\Models\User;

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

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

    //...
});

附加查询字符串值

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

use App\Models\User;

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

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

    //...
});

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

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

附加哈希片段

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

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

显示分页结果

调用 paginate 方法时，您将收到一个 Illuminate\Pagination\LengthAwarePaginator 实例，而调用 simplePaginate 方法会返回一个 Illuminate\Pagination\Paginator 实例。最后，调用 cursorPaginate 方法会返回一个 Illuminate\Pagination\CursorPaginator 实例。

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

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

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

调整分页链接窗口

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

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

将结果转换为 JSON

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

use App\Models\User;

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

分页器的 JSON 将包含诸如 total（总数）、current_page（当前页码）、last_page（最后页码）等元信息。结果记录可通过 JSON 数组中的 data 键获取。以下是从路由中返回分页器实例所创建的 JSON 的示例：

{
   "total": 50,
   "per_page": 15,
   "current_page": 1,
   "last_page": 4,
   "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":[
        {
            // 记录...
        },
        {
            // 记录...
        }
   ]
}

自定义分页视图

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

{{ $paginator->links('view.name') }}
 
<!-- 向视图传递额外数据... -->
{{ $paginator->links('view.name', ['foo' => 'bar']) }}

然而，自定义分页视图的最简单方法是使用 vendor:publish 命令将它们导出到您的 resources/views/vendor 目录：

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

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

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

<?php

namespace App\Providers;

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

class AppServiceProvider extends ServiceProvider
{
    /**
     * 启动任何应用程序服务。
     */
    public function boot(): void
    {
        Paginator::defaultView('view-name');

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

使用 Bootstrap

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

use Illuminate\Pagination\Paginator;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Paginator::useBootstrapFive();
    Paginator::useBootstrapFour();
}

分页器 / 长度感知分页器实例方法

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

游标分页器实例方法

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