Skip to content

数据库:分页

介绍

在其他框架中,分页可能非常麻烦。Laravel 的分页器与查询构建器Eloquent ORM集成,提供了方便、易于使用的数据库结果分页功能。分页器生成的 HTML 与Bootstrap CSS 框架兼容。

基本用法

分页查询构建器结果

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

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

php
<?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]);
    }
}
exclamation

目前,使用 groupBy 语句的分页操作无法由 Laravel 高效执行。如果需要对分组结果集进行分页,建议手动查询数据库并创建分页器。

"简单分页"

如果您只需要在分页视图中显示简单的“下一页”和“上一页”链接,可以使用 simplePaginate 方法执行更高效的查询。这对于不需要在视图中显示每个页码链接的大型数据集非常有用:

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

分页 Eloquent 结果

您也可以对Eloquent查询进行分页。在此示例中,我们将对 User 模型进行分页,每页 15 个项目。如您所见,语法与分页查询构建器结果几乎相同:

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

当然,您可以在查询上设置其他约束后调用 paginate,例如 where 子句:

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

您也可以在分页 Eloquent 模型时使用 simplePaginate 方法:

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

手动创建分页器

有时您可能希望手动创建分页实例,并传递一个项目数组。您可以根据需要创建 Illuminate\Pagination\PaginatorIlluminate\Pagination\LengthAwarePaginator 实例。

Paginator 类不需要知道结果集中的项目总数;然而,由于这个原因,该类没有用于检索最后一页索引的方法。LengthAwarePaginator 接受与 Paginator 几乎相同的参数;然而,它确实需要结果集中的项目总数。

换句话说,Paginator 对应于查询构建器和 Eloquent 上的 simplePaginate 方法,而 LengthAwarePaginator 对应于 paginate 方法。

exclamation

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

显示分页结果

调用 paginate 方法时,您将收到一个 Illuminate\Pagination\LengthAwarePaginator 实例。调用 simplePaginate 方法时,您将收到一个 Illuminate\Pagination\Paginator 实例。这些对象提供了几个描述结果集的方法。除了这些辅助方法外,分页器实例是迭代器,可以像数组一样循环。因此,一旦检索到结果,您可以显示结果并使用 Blade 渲染页面链接:

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

{{ $users->links() }}

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

自定义分页器 URI

withPath 方法允许您自定义分页器在生成链接时使用的 URI。例如,如果希望分页器生成类似 http://example.com/custom/url?page=N 的链接,应将 custom/url 传递给 withPath 方法:

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

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

    //
});

向分页链接追加

您可以使用 appends 方法向分页链接的查询字符串追加内容。例如,要向每个分页链接追加 sort=votes,应进行以下 appends 调用:

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

如果希望向分页器的 URL 追加“哈希片段”,可以使用 fragment 方法。例如,要向每个分页链接的末尾追加 #foo,请进行以下 fragment 方法调用:

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

将结果转换为 JSON

Laravel 分页器结果类实现了 Illuminate\Contracts\Support\Jsonable 接口契约,并公开了 toJson 方法,因此将分页结果转换为 JSON 非常简单。您还可以通过简单地从路由或控制器操作返回分页器实例来将其转换为 JSON:

php
Route::get('users', function () {
    return App\User::paginate();
});

分页器生成的 JSON 将包括诸如 totalcurrent_pagelast_page 等元信息。实际的结果对象将通过 JSON 数组中的 data 键提供。以下是从路由返回分页器实例创建的 JSON 示例:

json
{
   "total": 50,
   "per_page": 15,
   "current_page": 1,
   "last_page": 4,
   "next_page_url": "http://laravel.app?page=2",
   "prev_page_url": null,
   "from": 1,
   "to": 15,
   "data":[
        {
            // 结果对象
        },
        {
            // 结果对象
        }
   ]
}

自定义分页视图

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

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

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

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

bash
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)