数据库：分页

• 介绍
• 基本用法
  • 分页查询构建器结果
  • 分页 Eloquent 结果
  • 光标分页
  • 手动创建分页器
  • 自定义分页 URL
• 显示分页结果
  • 调整分页链接窗口
  • 将结果转换为 JSON
• 自定义分页视图
  • 使用 Bootstrap
• 分页器和 LengthAwarePaginator 实例方法
• 光标分页器实例方法

介绍

在其他框架中，分页可能非常麻烦。我们希望 Laravel 的分页方法能带来一丝清新。Laravel 的分页器与 查询构建器 和 Eloquent ORM 集成，提供方便、易于使用的数据库记录分页，且无需配置。

默认情况下，分页器生成的 HTML 与 Tailwind CSS 框架 兼容；但是，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 方法在从数据库检索记录之前会计算与查询匹配的总记录数。这是为了让分页器知道总共有多少页记录。然而，如果您不打算在应用程序的 UI 中显示总页数，则记录计数查询是多余的。

因此，如果您只需要在应用程序的 UI 中显示简单的“下一页”和“上一页”链接，则可以使用 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 查询。以下两个查询都将显示 users 表中按 id 排序的“第二页”结果：

# 偏移分页...
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 方法。

在手动创建分页器实例时，您应该手动“切片”传递给分页器的结果数组。如果您不确定如何执行此操作，请查看 array_slice 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 框架 兼容。

调整分页链接窗口

当分页器显示分页链接时，当前页码会显示，以及当前页之前和之后的三个页面的链接。使用 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 框架兼容。然而，如果您不使用 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 构建的分页视图。要使用这些视图而不是默认的 Tailwind 视图，您可以在 App\Providers\AppServiceProvider 类的 boot 方法中调用分页器的 useBootstrapFour 或 useBootstrapFive 方法：

use Illuminate\Pagination\Paginator;

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

分页器 / 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->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。