Laravel 的分页功能

优质

小牛编辑

182浏览

2023-12-01

简介

在大多数的框架中，分页无不令人十分头疼。 Laravel 的分页器与查询构造器、Eloquent ORM 集成在一起，并提供方便易用的数据结果集分页。分页器生成的 HTML 与 Bootstrap CSS 框架兼容。

基本用法

查询构造器分页

对数据进行分页有几种方式。最简单的是在查询语句构造器或者 Eloquent 语句使用 paginate 方法。 paginate 会根据用户正在浏览的页面自动设置限制和偏移量。默认情况下，HTTP 请求所带 page 参数的值为当前页码。当然这个值是被 Laravel 自动检测的，同时会自动的插入分页器生成的链接中。

在以下的例子中，传递给 paginate 方法的唯一参数是「每页」显示的项目数量。下面是每页显示 15 项的例子：

<?php

namespace App\Http\Controllers;

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

class UserController extends Controller
{
    /**
     * 显示应用中所有的用户。
     *
     * @return Response
     */
    public function index()
    {
        $users = DB::table('users')->paginate(15);

        return view('user.index', ['users' => $users]);
    }
}

{note} 目前，Laravel 无法高效的执行带有 groupBy 语句的分页操作。如果你需要在查询结果中使用 groupBy 语句，建议你查询数据库并手动创建分页器。

「简单分页」

如果你只需要在分页视图中显示简单的「下一页」和「上一页」的链接，即不需要显示每个页码的链接，更推荐使用 simplePaginate 方法来执行更高效的查询，这对于大型数据集非常有用：

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

Eloquent 模型分页

你也可以对 Eloquent 查询进行分页。下面的例子中对 User 模型进行了分页并且每页显示 15 条数据。正如你看到的，所使用的语法几乎与基于查询语句构造器分页时的完全相同：

$users = App\User::paginate(15);

当然，你可以在设置了查询的其他约束条件之后调用 paginate 方法，例如 where 语句：

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

你也可以在 Eloquent 模型中使用 simplePaginate 方法进行分页：

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

手动创建分页

如果你想手动创建分页实例并且最终得到一个数组类型的结果，可以根据需求来创建 Illuminate\Pagination\Paginator 或者 Illuminate\Pagination\LengthAwarePaginator 实例来实现。

Paginator 类不需要知道结果集中的数据量，因此该类没有检索最后一页索引的方法。而 LengthAwarePaginator 接收的参数几乎和 Paginator 一样，但它却需要计算结果集中的数据量。

说白了就是，Paginator 相当于查询语句构造器和 Eloquent 中的 simplePaginate 方法，而 LengthAwarePaginator 相当于 paginate 方法。

{note} 手动创建分页器实例时，你应该手动「切割」传递给分页器的结果集数组。如果你不确定如何去做到这一点，请查阅 PHP 的 array_slice 函数。

显示分页结果

在调用 paginate 方法时，你将会接收到一个 Illuminate\Pagination\LengthAwarePaginator 实例。当调用 simplePaginate 方法时，你将会接收到一个 Illuminate\Pagination\Paginator 实例。这些对象提供了一些用于渲染结果集的函数。除了这些辅助函数，分页器实例是一个迭代器，也可以作为数组循环。因此，一旦检测到结果集，你可以使用 Blade 模板显示结果集并渲染页面链接：

    @foreach ($users as $user)
        {{ $user->name }}
    @endforeach


{{ $users->links() }}

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

自定义分页器的 URI

withPath 方法允许你在生成链接时自定义分页器所使用的 URI。例如，如果你想要分页器生成像 http://example.com/custom/url?page=N 这样的链接，那就传递 custom/url 到 withPath 方法：

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

    $users->withPath('custom/url');

    //
});

附加参数到分页链接中

你可以使用 appends 方法将查询参数附加到分页链接中。例如，要将 sort=votes 附加到每个分页链接，可以这样调用 appends 方法：

{{ $users->appends(['sort' => 'votes'])->links() }}

如果想将「锚点」附加到分页器的链接中，就使用 fragment 方法。例如，要将 #foo 附加到每个分页链接的末尾，应该这样调用 fragment 方法：

{{ $users->fragment('foo')->links() }}

将结果转换为 JSON

Laravel 分页器结果类实现了 Illuminate\Contracts\Support\Jsonable 接口契约并且提供 toJson 方法，因此将分页结果转换为 JSON 非常简单。你也可以在路由或控制器操作中简单地将分页实例转换为 JSON 返回：

Route::get('users', function () {
    return App\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":[
        {
            // 结果集
        },
        {
            // 结果集
        }
   ]
}

自定义分页视图

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

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

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

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

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

这个命令将这些视图放置在 resources/views/vendor/pagination 目录中。这个目录下的 default.blade.php 文件对应默认的分页视图，你可以简单地编辑这个文件来修改分页的 HTML 。

分页器实例方法

每个分页器实例可以通过以下方法获取额外的分页信息：

$results->count()
$results->currentPage()
$results->firstItem()
$results->hasMorePages()
$results->lastItem()
$results->lastPage() （使用 simplePaginate 时不可用）
$results->nextPageUrl()
$results->perPage()
$results->previousPageUrl()
$results->total() （使用 simplePaginate 时不可用）
$results->url($page)