Laravel分页链接美化技巧分享

本文旨在指导 Laravel 开发者优雅地在 API 响应中展示分页链接。核心在于正确使用 Laravel ResourceCollection，它能自动处理 `paginate()` 方法返回的分页器实例，并生成包含 `data`、`links` 和 `meta` 键的标准 JSON 结构。文章强调，应在控制器或路由层执行数据分页操作，并将分页结果直接传递给 ResourceCollection，以确保分页信息位于 API 响应的顶层，方便客户端统一处理。避免在父资源内部嵌套分页信息，推荐为需要独立分页的子集合创建单独的 API 端点，遵循最佳实践，构建清晰且易于维护的 RESTful API。

理解 Laravel Resource Collection 与分页

Laravel Resources 提供了一种将 Eloquent 模型或集合转换为 JSON 的强大且灵活的方式。当涉及到集合数据的分页时，Laravel 提供了一个专门的 ResourceCollection 类，它能够自动处理来自 paginate() 方法的分页器实例，并将其转换为包含 data、links 和 meta 键的标准 JSON 结构。

ResourceCollection 的设计目的是作为 API 响应的顶层资源，用于呈现一个已分页的资源集合。它期望在构造函数中接收一个分页器实例（例如 LengthAwarePaginator 或 Paginator），而不是一个普通的集合或分页器内部的 collection 属性。

标准实践：实现顶层分页

为了在 API 响应中正确地显示分页链接和元数据，最推荐的做法是在控制器或路由中执行分页操作，然后将分页结果直接传递给你的 ResourceCollection。

1. 定义单个资源（ItemResource）

首先，为集合中的每个单独项定义一个资源类。例如，如果你有一个 Item 模型，可以创建一个 ItemResource：

// app/Http/Resources/ItemResource.php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class ItemResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request)
    {
        return [
            "id"        =>  $this->id,
            "name"      =>  $this->name,
            "slug"      =>  $this->slug,
            "image"     =>  imageGenerate("items", $this->image), // 假设 imageGenerate 是一个辅助函数
            "code"      =>  $this->code,
            "category"  =>  $this->category->name ?? "", // 假设有 category 关系
        ];
    }
}

2. 定义资源集合（ItemCollection）

接下来，创建一个 ResourceCollection 类来封装 ItemResource 的集合。这个类通常只需要指定它所使用的单个资源类：

// app/Http/Resources/ItemCollection.php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\ResourceCollection;

class ItemCollection extends ResourceCollection
{
    /**
     * The resource that this collection of resources is wrapping.
     *
     * @var string
     */
    public $collects = ItemResource::class;

    /**
     * Transform the resource collection into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request)
    {
        // 默认情况下，ResourceCollection 会自动处理分页元数据。
        // 如果需要添加额外的元数据，可以在这里返回一个包含 'data' 和其他键的数组。
        return parent::toArray($request);
    }
}

3. 在控制器或路由中使用

最后，在你的控制器方法或路由闭包中，执行 Eloquent 查询并调用 paginate() 方法，然后将返回的分页器实例传递给 ItemCollection：

// app/Http/Controllers/ItemController.php

namespace App\Http\Controllers;

use App\Models\Item;
use App\Http\Resources\ItemCollection;
use Illuminate\Http\Request;

class ItemController extends Controller
{
    public function index()
    {
        // 获取所有 Item 并分页，每页20条
        $items = Item::paginate(20);

        // 将分页结果传递给 ItemCollection
        return new ItemCollection($items);
    }
}

或者直接在路由中：

// routes/api.php 或 routes/web.php

use App\Models\Item;
use App\Http\Resources\ItemCollection;

Route::get('/items', function () {
    return new ItemCollection(Item::paginate(20));
});

当上述代码执行时，API 响应将自动包含 data 数组（包含 ItemResource 转换后的数据）、links 对象（包含分页链接，如 first, last, prev, next 等）和 meta 对象（包含分页元数据，如 current_page, from, last_page, per_page, to, total 等）。

示例 JSON 响应结构：

{
    "data": [
        {
            "id": 1,
            "name": "Item A",
            "slug": "item-a",
            "image": "http://example.com/images/item-a.jpg",
            "code": "CODE001",
            "category": "Category One"
        },
        {
            "id": 2,
            "name": "Item B",
            "slug": "item-b",
            "image": "http://example.com/images/item-b.jpg",
            "code": "CODE002",
            "category": "Category One"
        }
        // ...更多 Item 数据
    ],
    "links": {
        "first": "http://example.com/api/items?page=1",
        "last": "http://example.com/api/items?page=5",
        "prev": null,
        "next": "http://example.com/api/items?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "path": "http://example.com/api/items",
        "per_page": 20,
        "to": 20,
        "total": 100
    }
}

关于嵌套集合的分页处理

用户最初的问题中提到了在父资源（如 SectionResource）内部嵌套一个分页的 ItemCollection：

// SectionResource 内部的 toArray 方法
public function toArray($request)
{
    return [
        // ... 其他字段
        "items" => new ItemCollection($this->items()->paginate(20)),
    ];
}

这种做法虽然技术上可行，但通常不推荐用于生成顶层 API 分页链接。原因如下：

1. 分页信息嵌套： 这种情况下，items 集合的分页 links 和 meta 信息会嵌套在 items 键下，而不是作为整个 API 响应的顶层元数据。这使得客户端难以统一处理分页逻辑。
2. 职责分离： 父资源（SectionResource）的主要职责是转换 Section 模型的数据。如果 items 是 Section 的一个关联集合，并且需要独立分页，通常意味着 items 应该有自己的 API 端点，例如 /api/sections/{section_id}/items，并在该端点返回一个顶层的 ItemCollection。

如果你的业务逻辑确实需要在一个父资源内部展示一个分页的子集合，并且接受分页信息嵌套，那么上述代码是有效的。但如果目标是让 items 集合的分页链接成为 API 响应的根级别，那么应该为 items 创建一个单独的 API 端点，并直接返回 ItemCollection(Item::paginate())。

注意事项与最佳实践

• 传递完整的Paginator实例： 务必将 ->paginate() 方法返回的完整分页器实例（例如 $items = Item::paginate(20); 后的 $items）传递给 ResourceCollection 的构造函数。不要尝试传递 $items->collection 或其他内部属性，这会导致分页元数据丢失。
• ResourceCollection 的作用： ResourceCollection 的主要作用就是处理分页器实例，并自动生成标准的 data、links 和 meta 结构。
• 顶层响应： 为了获得标准的 API 分页响应（即 links 和 meta 在根级别），确保你的 ResourceCollection 是控制器或路由返回的顶层对象。
• 关联数据的处理： 如果你需要在父资源中包含关联数据，但这些关联数据本身不需要分页，或者分页逻辑由父资源统一管理，那么可以使用普通的 JsonResource 或集合转换。如果关联数据需要独立分页并显示其分页链接，则考虑为其创建单独的 API 端点。

总结

在 Laravel Resource 中显示分页链接的关键在于正确使用 ResourceCollection。通过在控制器或路由中执行数据分页，并将返回的分页器实例直接传递给 ResourceCollection，你可以轻松地构建符合 RESTful 规范且包含完整分页元数据的 API 响应。理解 ResourceCollection 的设计意图，并遵循将分页逻辑放在控制器/路由层的最佳实践，将有助于构建清晰、可维护的 API。

今天关于《Laravel分页链接美化技巧分享》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！